Retrieve onboarding document

GET

/v1/onboardings/{application_id}/documents/{document_id}

Returns a single onboarding document for the specified application and document IDs.

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

API Key

Add parameter in header

Authorization

Example:

Authorization: ********************

Path Params

Responses

🟢200

application/json

Bodyapplication/json

🟠401

🟠404

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/onboardings/98c93841-2ca5-42dc-8909-75967b25f27f/documents/98c93841-2ca5-42dc-8909-75967b25f27f' \
--header 'X-API-KEY: <api-key>'

Response Example

200 - response

{
    "data": {
        "id": "98c93841-2ca5-42dc-8909-75967b25f27f",
        "model_id": "98c937ef-41f5-446f-a094-dc377b7d0979",
        "type": "PASSPORT",
        "name": "passport.pdf",
        "created_at": "2021-08-06 15:25:17",
        "updated_at": "2021-08-06 15:25:17"
    }
}

Modified at 2026-09-25 07:15:05

Create onboarding document

Delete onboarding document