v1

latestOpenAPI 3.0.32026-07-26184851.6 MB

Customer Onboarding

Create Customer Onboarding Request

Creates an API-based onboarding request for a customer and returns the Dynamic Form Schema that describes the required customer information. Complete data.requirements.schema, then submit the resulting object to the request's submit endpoint.

post/v1/customers/{customerId}/onboarding-requests

Path parameters

customerIdstring uuid required

Customer identifier.

Request body

providerstring

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

type'onramp' | 'offramp'

Intended customer activity.

callbackUrlstring uri

URL notified as the onboarding request progresses.

Example request

{
  "provider": "infinia",
  "routeIntent": {
    "sourceCurrencyCode": "NGN",
    "targetCurrencyCode": "USDC",
    "chain": "ethereum",
    "network": "mainnet"
  },
  "callbackUrl": "https://example.com/webhooks/customer-onboarding"
}

Response

Customer onboarding request created.

statusCodeinteger required

messagestring required