Docpier IDP API
  1. document
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
        • ApiError
        • DocumentInProgressResponse
        • FeedbackRequest
        • DocumentResponse
      • document
        • element
          • Amount
          • Identification
          • PaymentMethod
          • TaxId
          • CreditCardInfo
        • Unknown
        • Core Document
        • Invoice
        • Reminder
        • CreditCard Statement
        • Insurance Policy
        • Policy Adjustment
      • workspace
        • Workspace
        • Membership
        • Document
        • FlowLog
        • Error
  1. document

PolicyAdjustment(Policy Adjustment)

Defines the structure for a payment receipt document extracted by Docpier. Each field that is extracted will include a 'confidence' property (0.0-1.0) indicating extraction accuracy).

{
    "periodFrom": "2026-05-22",
    "periodTo": "2025-05-22",
    "policy": {
        "policyHolder": {
            "name": "Invoice Beneficiary SA",
            "address": {
                "addressSupplement": "Attn: Accounting Dept.",
                "street": "Musterstrasse",
                "streetNumber": "12A",
                "poBox": "PO Box 123",
                "zipCode": "8001",
                "city": "Zürich",
                "country": "CHE"
            },
            "phoneNumbers": [
                "string"
            ],
            "emails": [
                "string"
            ],
            "taxIds": [
                {
                    "type": "UID",
                    "value": "CHE-999.999.999"
                }
            ],
            "legalForm": "SOLE_PROPRIETORSHIP"
        },
        "broker": {
            "name": "Invoice Beneficiary SA",
            "address": {
                "addressSupplement": "Attn: Accounting Dept.",
                "street": "Musterstrasse",
                "streetNumber": "12A",
                "poBox": "PO Box 123",
                "zipCode": "8001",
                "city": "Zürich",
                "country": "CHE"
            },
            "phoneNumbers": [
                "string"
            ],
            "emails": [
                "string"
            ],
            "taxIds": [
                {
                    "type": "UID",
                    "value": "CHE-999.999.999"
                }
            ],
            "legalForm": "SOLE_PROPRIETORSHIP"
        },
        "policyItems": {
            "coverageLimit": {
                "currency": "CHF",
                "value": 42.5
            },
            "insuranceType": "VEHICLE_INSURANCE",
            "objectReference": "string",
            "netPremium": {
                "currency": "CHF",
                "value": 42.5
            },
            "periodTo": "2019-08-24",
            "periodFrom": "2019-08-24"
        },
        "totalGrossPremium": {
            "currency": "CHF",
            "value": 42.5
        },
        "totalNetPremium": {
            "currency": "CHF",
            "value": 42.5
        },
        "insuranceType": "VEHICLE_INSURANCE"
    },
    "mutationReason": "NEW_CONTRACT",
    "title": "Docpier AG",
    "documentId": "string",
    "documentType": "INVOICE",
    "identifications": [
        {
            "type": "INVOICE_NUMBER",
            "value": "string"
        }
    ],
    "documentDate": "2025-06-15",
    "language": "DE",
    "notes": "This document contains a special promotion.",
    "sender": {
        "name": "Invoice Beneficiary SA",
        "address": {
            "addressSupplement": "Attn: Accounting Dept.",
            "street": "Musterstrasse",
            "streetNumber": "12A",
            "poBox": "PO Box 123",
            "zipCode": "8001",
            "city": "Zürich",
            "country": "CHE"
        },
        "phoneNumbers": [
            "string"
        ],
        "emails": [
            "string"
        ],
        "taxIds": [
            {
                "type": "UID",
                "value": "CHE-999.999.999"
            }
        ],
        "legalForm": "SOLE_PROPRIETORSHIP"
    },
    "recipient": {
        "name": "Invoice Beneficiary SA",
        "address": {
            "addressSupplement": "Attn: Accounting Dept.",
            "street": "Musterstrasse",
            "streetNumber": "12A",
            "poBox": "PO Box 123",
            "zipCode": "8001",
            "city": "Zürich",
            "country": "CHE"
        },
        "phoneNumbers": [
            "string"
        ],
        "emails": [
            "string"
        ],
        "taxIds": [
            {
                "type": "UID",
                "value": "CHE-999.999.999"
            }
        ],
        "legalForm": "SOLE_PROPRIETORSHIP"
    },
    "officialEntity": {
        "name": "Invoice Beneficiary SA",
        "address": {
            "addressSupplement": "Attn: Accounting Dept.",
            "street": "Musterstrasse",
            "streetNumber": "12A",
            "poBox": "PO Box 123",
            "zipCode": "8001",
            "city": "Zürich",
            "country": "CHE"
        },
        "phoneNumbers": [
            "string"
        ],
        "emails": [
            "string"
        ],
        "taxIds": [
            {
                "type": "UID",
                "value": "CHE-999.999.999"
            }
        ],
        "legalForm": "SOLE_PROPRIETORSHIP"
    }
}
Built with