We're delighted to present you with the comprehensive API documentation for PEAX. This all-in-one workspace for API design offers you a clear, concise, and interactive exploration of our API functionalities.

Confirm a document has been retrieved (v2)

PATCH

https://proxy-stage.peax.ch/document-partner-service/agent-api/v2/sources/{sourceId}/accounts/{accountPeaxId}/documents/close

documentDocuments

Document Processing Error Codes

Error Code	Description
DOC_WRONG_FORMAT	The document is not in the expected format (e.g., corrupted file or incompatible file type).
MISSING_INFORMATION	Required fields or data in the document are incomplete or missing.
UNSUPPORTED_DOCUMENT_TYPE	The document type (e.g., reminder or other specific type) is not supported by the partner system.
DUPLICATE_DOCUMENT	The document is identified as a duplicate and was not reprocessed.
INCOMPLETE_METADATA	Metadata such as invoice number, date, or client ID is missing or incomplete.
DOCUMENT_CORRUPTED	The document is unreadable or contains corrupted data.
UNSUPPORTED_LANGUAGE	The document is in a language that the system or partner cannot process.
DOCUMENT_TOO_LARGE	The document size exceeds the acceptable limits for processing.
RESTRICTED_CONTENT	The document contains restricted or prohibited content.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

sourceId

string

required

accountPeaxId

string

required

Header Params

Authorization

string

optional

Default:

Bearer {{JWT}}

Body Params application/json

documents

array [object {4}]

required

>= 1 items

string <uuid>

required

status

enum<string>

required

Allowed values:

SUCCESSFULFAILED

reason

enum<string> | enum<null>

optional

<= 50 characters

Allowed values:

DOC_WRONG_FORMATMISSING_INFORMATIONUNSUPPORTED_DOCUMENT_TYPEDUPLICATE_DOCUMENTINCOMPLETE_METADATADOCUMENT_CORRUPTEDUNSUPPORTED_LANGUAGEDOCUMENT_TOO_LARGERESTRICTED_CONTENT

details

string | null

optional

Give any relevant details as free text

<= 255 characters

Example

{
  "documents": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "status": "SUCCESSFUL",
      "reason": "DOC_WRONG_FORMAT",
      "details": "string"
    }
  ]
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request PATCH 'https://proxy-stage.peax.ch/document-partner-service/agent-api/v2/sources//accounts//documents/close' \
--header 'Authorization: Bearer {{JWT}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "documents": [
        {
            "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
            "status": "SUCCESSFUL",
            "reason": "DOC_WRONG_FORMAT",
            "details": "string"
        }
    ]
}'

Responses

🟢204No content

application/json

Body

object {0}

Example

{}

🟠400Bad request

🟠403Permission denied

🟠404Not found

🔴500Internal server error

Modified at 2025-02-12 12:30:24

Query for documents and their last updated timestamp

Confirm a document has been retrieved (v1)

Confirm a document has been retrieved (v2)

Document Processing Error Codes#

Request

Request samples

Responses

Document Processing Error Codes