v33

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-1770249709.0 KB
Accounts

Onboard an account

Initiates the onboarding process for a new account. This endpoint can only be used for accounts where at least one representative and one bank account have already been created.

post/v1/accounts/{account_id}/onboard

Path parameters

account_idstring uuid required

Headers

request-idstring

Optional client generated identifier to trace and debug a request.

correlation-idstring

Optional client generated identifier to trace and debug a series of requests.

idempotency-keystring

Optional client generated value to use for idempotent requests.

Request body

Response

Created

response_type'object' | 'array' | 'error' | 'none' required

Indicates the structure of the returned content.

  • "object" means the data field contains a single JSON object.
  • "array" means the data field contains an array of objects.
  • "error" means the data field contains an error object with details of the issue.
  • "none" means no data is returned.