Skip to main content
POST
Create Customer Onboarding Request
The response includes data.requirements.schema. Complete that schema and send the resulting object as data to the submit operation. See Dynamic Forms for the schema-processing flow.

Authorizations

x-api-key
string
header
required

Path Parameters

customerId
string<uuid>
required

Customer identifier.

Body

application/json
provider
string

Provider slug or provider UUID. Omit to use provider routing.

Example:

"infinia"

type
enum<string>

Intended customer activity.

Available options:
onramp,
offramp
routeIntent
object
callbackUrl
string<uri>

URL notified as the onboarding request progresses.

Example:

"https://example.com/webhooks/customer-onboarding"

Response

201 - application/json

Customer onboarding request created.

statusCode
integer
required
message
string
required
data
object
required