Docpier IDP API
  1. api
Docpier IDP API
  • IDP API
  • Webhook
  • Endpoints
    • Agent Login (client credential flow)
      POST
    • Upload a document
      POST
    • Retrieve structured data
      GET
    • Provide feedback
      PATCH
  • Schemas
    • Schemas
      • api
        • UploadResponse
        • ApiError
        • DocumentInProgressResponse
        • FeedbackRequest
        • ProcessIssue
        • DocumentResponse
        • ProcessingInstruction
      • document
        • element
          • Amount
          • Identification
          • PaymentMethod
          • AllowanceInfo
          • PaymentDetailsInfo
          • LegalEntityInfo
          • Address Schema
          • TaxId
          • VAT Details Schema
          • DiscountInfo
          • InvoiceItemInfo
          • AccountTransactionDetails
          • AccountTransaction
          • PolicyItemInfo
          • PolicyInfo
          • CreditCardTransaction
          • CreditCardInfo
        • Unknown
        • Core Document
        • Invoice
        • Reminder
        • Receipt
        • Credit Note
        • Account Statement
        • CreditCard Statement
        • Insurance Policy
        • Policy Adjustment
      • workspace
        • Workspace
        • Membership
        • Document
        • FlowLog
        • Error
  1. api

ProcessingInstruction

{
    "extract": {
        "logo": {
            "enabled": true
        },
        "extensions": {
            "lineItems": {
                "enabled": true
            },
            "creditCardDetails": {
                "enabled": true
            }
        }
    },
    "reconcile": {
        "enabled": true,
        "config": {
            "businessRegistryEnrichment": true,
            "addressNormalization": true
        }
    },
    "deliver": {
        "webhook": {
            "url": "https://client.app/hooks/doc"
        },
        "response": {
            "content": {
                "enabled": true,
                "config": {
                    "format": "PDFA"
                }
            },
            "layout": {
                "enabled": true
            },
            "thumbnails": {
                "enabled": true,
                "config": {
                    "pageLimit": 1,
                    "maxWidth": 512
                }
            }
        }
    },
    "security": {
        "redact": {
            "enabled": true,
            "config": {
                "mode": "BLACKOUT",
                "categories": [
                    "NAMES",
                    "ADDRESSES"
                ]
            }
        }
    },
    "lifecycle": {
        "retention": {
            "enabled": true,
            "config": {
                "days": 30
            }
        }
    }
}
Built with