Create onboarding application

POST

/v1/onboardings/

Creates a new onboarding application for a customer account. Only account_id is required to start the application, but full onboarding requires company, payout, and shareholder details. Use hosted onboarding when you want the customer to complete the flow in the embedded widget; use self-hosted onboarding if you collect the data yourself and still finalize it through the hosted widget. Documents for the company and shareholders are uploaded separately through the onboarding documents endpoints.

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

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

API Key

Add parameter in header

Authorization

Example:

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

Body Params application/json

Examples

Responses

🟢201

application/json

Created

Bodyapplication/json

🟠400

🟠401

🟠403

Request Example

Shell

JavaScript

Java

Swift

curl --location '/v1/onboardings/' \
--header 'X-API-KEY: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "account_id": 41
}'

Response Example

201 - response

{
    "data": {
        "id": "98c96cc9-c5b4-4faa-a6e7-7206c0529b35",
        "account_id": 5,
        "status": "STARTED",
        "status_changed_at": "2023-03-27 11:20:10",
        "ownership_category": null,
        "created_at": "2023-03-27 11:20:10",
        "updated_at": "2023-03-27 11:20:10"
    }
}

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

Delete user

Retrieve onboarding application