Create onboarding document

POST

/v1/onboardings/{application_id}/documents

Uploads a document for an onboarding application. model_id is the UUID of the entity that owns the document, such as a company or shareholder. The document type must match one of the supported onboarding document types, and the content must be base64-encoded file data.

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

Body Params application/json

Examples

Responses

🟢201

application/json

Created

Bodyapplication/json

🟠400

🟠401

🟠404

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/onboardings/98c93841-2ca5-42dc-8909-75967b25f27f/documents' \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "model_id": "98c937ef-41f5-446f-a094-dc377b7d0979",
    "properties": {
        "type": "PASSPORT"
    },
    "name": "passport.pdf",
    "content": "JVBERi0xLjQK..."
}'

Response Example

201 - 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

Delete onboarding shareholder

Retrieve onboarding document