Skip to main content
POST
Submit for onboarding

Authorizations

X-API-Key
string
header
required

Includes an API key in the HTTP headers to authenticate the client.

X-API-Secret
string
header
required

Includes an API secret in the HTTP headers to authenticate the client.

Path Parameters

id
string
required

A valid Customer ID

Pattern: ^cus_[a-zA-Z0-9]{27}$
Example:

"cus_2ofTA13AD0xBtbEvBl20aEb1hEu"

Body

application/json
forceApproval
boolean
default:false

Response

Onboarding submission result

Response returned when submission succeeds but requires liveness verification

success
boolean
required
status
string
required