TRANSAK WHITELABEL APIOn RampHeadless KYC

Transaction Session API

View as Markdown

Creates a transaction session for the Headless KYC module. Returns a sessionId for your integration.

Headers

x-user-ipstringRequired

End user’s originating IP. More details here

x-api-keystringRequired
Your Partner API key. You can find this in the [Partner Dashboard](https://docs.transak.com/guides/how-to-create-partner-dashboard-account#open-the-developers-section).
x-access-tokenstringOptional

Your Partner Access Token. Please refer here for a tutorial on generating your access token.

Note: This is applicable only for Auth Reliance Flows

x-user-identifierstringOptional

The authenticated user’s email address.

Note: This is applicable only for Auth Reliance Flows.

authorizationstringOptional

Authorization token is the accessToken received from the API - api/v2/auth/verify

Note: This is not applicable for Auth Reliance Flows

Request

This endpoint expects an object.
quoteIdstringRequired

Quote ID from the Quotes API.

moduleenumRequired

Set to kyc to initialize a Headless KYC session.

configobjectOptional
Additional optional UI configuration passed through to the session.

Response

Success
dataobject

Errors

401
Unauthorized Error
422
Unprocessable Entity Error
500
Internal Server Error