Skip to main content
POST
Create User Onboarding Session

Authorizations

x-api-key
string
header
required

API key for authentication. Must be included in the x-api-key header.

Body

application/json
email
string<email>
required

User's email address for the onboarding session

Example:

"sachimnm4083@gmail.com"

currency
string
required

Currency code (ISO 4217) for the user's preferred currency

Example:

"EUR"

redirect_url
string<uri>
required

URL to redirect the user to after completing the KYC verification process

Example:

"https://www.carbn.xyz/"

Response

User session created successfully

onboarding_url
string<uri>

Hosted KYC verification URL where the user can complete their onboarding. This URL contains a session token and should be opened in a browser.

Example:

"https://checkout.noah.com/kyc?session=eyJhbGciOiJFUzM4NCIsImtpZCI6ImttcyIsInR5cCI6IkpXVCJ9..."

user_id
string<uuid>

Unique identifier for the user session. This ID can be used to track the user's onboarding status.

Example:

"9e58ad24-a7a6-43b2-b1a9-984a410a87f3"