Documents and status

Endpoint

GET https://prod.gets.complyance.io/api/v3/documents/{documentId}?type=sales

Use the documentId from the submit response. The same request with type=purchases returns a received invoice; see Get a purchase invoice.

GET /api/v3/documents/{documentId}/status returns the same status object. When the document is compliant, it also returns the invoice PDF, Base64-encoded, in pdfBase64, which is null if the PDF could not be produced. Use either one; the examples in these docs use ?type=sales.

Authentication

Send Authorization: Bearer YOUR_API_KEY with a key from the workspace that submitted the document. See Authentication.

Parameters

curl "https://prod.gets.complyance.io/api/v3/documents/${DOCUMENT_ID}?type=sales" \
  --header "Authorization: Bearer ${COMPLYANCE_API_KEY}" \
  --header 'Accept: application/json'

Response

HTTP 200 returns success: true and the document’s status in data.

{
  "success": true,
  "data": {
    "documentId": "01K5EXAMPLE00000000000142",
    "documentNumber": "INV-2026-000184",
    "country": "AE",
    "environment": "sandbox",
    "state": "final_valid",
    "isTerminal": true,
    "lastUpdatedAt": "2026-09-22T10:00:04.000Z",
    "errors": [],
    "compliance": {
      "uuid": "6f1c2a9e-3b4d-4e8f-9a7b-1c2d3e4f5a6b",
      "ftaApprovedStatus": "APPROVED",
      "businessProcessIdentifier": "urn:peppol:bis:billing",
      "specificationIdentifier": "urn:peppol:pint:billing-1@ae-1"
    },
    "validationResults": {
      "status": "Valid",
      "validationSteps": [
        { "name": "Validation Passed", "status": "Valid", "error": null },
        { "name": "Queue Admitted", "status": "Valid", "error": null },
        { "name": "Delivery Processing Started", "status": "Valid", "error": null },
        { "name": "Final Valid", "status": "Valid", "error": null }
      ]
    }
  }
}

This example leaves out government and artifacts.

Each validation step has a name, a status (Valid, Invalid, Pending or null for a step not reached) and an error with a code and message, or null. The steps are Validation Passed (or Validation Failed), Queue Admitted, Delivery Processing Started, then Delivery Success, Delivery Failed, Final Valid or Final Invalid.

States

In Saudi Arabia, a delivery_success the authority reports as cleared or reported becomes final_valid, and a delivery_failed it rejected becomes final_invalid.

A document that reached final_valid stays final_valid. In Malaysia, a later cancellation in the MyInvois portal or a rejection by the buyer does not change state; the Invoice Portal shows it under Business status.

In Belgium and Germany, a sales document never becomes terminal. Its last step is delivery to the buyer’s Peppol access point, shown as Submitted in the Invoice Portal. Stop checking when state is delivery_success or delivery_failed. With delivery_failed, read errors and email support@complyance.io with the documentId.

How often to check

While isTerminal is false, wait before checking again, and make each wait longer than the last, for example by doubling it. Stop when isTerminal is true, or, in Belgium and Germany, when state is delivery_success or delivery_failed.

No webhook reports the authority’s or the network’s answer. The invoice.passed and invoice.failed webhooks say only whether the document passed validation when you sent it; see Webhook events. This request is how you learn the outcome.

A successful sandbox result shows that the document passed in sandbox. It does not confirm a production registration or acceptance of a live invoice.

The government object

government is the tax authority’s or the Peppol network’s own record of the document. Its fields differ by country and change as delivery moves on, so use it to show or log the authority’s answer, not to decide what to do next. Act on state and isTerminal.

The values in government, including any status, are the authority’s or the network’s own, so they differ by country. Saudi Arabia’s, such as CLEARED, REPORTED and REJECTED, are explained on the Saudi Arabia examples page.

Compliance

For the UAE, Belgium and Germany, compliance gives the outcome in a fixed form:

Errors

{
  "success": false,
  "code": "NOT_FOUND",
  "message": "Document not found"
}

/status returns Document status not found as the message for the same 404.