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.

Get content of a document

GET

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

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Path Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://proxy-stage.peax.ch/document-partner-service/agent-api/v1/sources//accounts//documents/' \
--header 'actor_account_peaxid: {{actor_account_peaxid}}' \
--header 'actor_account_uuid: {{actor_account_uuid}}' \
--header 'context_account_peaxid: {{context_account_peaxid}}' \
--header 'context_account_uuid: {{context_account_uuid}}' \
--header 'Authorization: Bearer <token>'

Responses

🟢200Operation successful

application/json

Body

Example

{}

🟠400Bad request

🟠403Permission denied

🟠404Not found

🔴500Internal server error

Modified at 2024-03-27 16:13:14

Retrieve document metadata information

Query for documents and their last updated timestamp