Skip to navigation
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.

Authentication: use either Transak Auth, which sends the user’s authorization token, or Partner Auth (Auth Reliance), which sends x-access-token and x-user-identifier. Do not send both. See the headers below.

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.

authorizationstringOptional

Transak Auth. The user’s accessToken from Transak’s OTP login, returned by the Verify User OTP API (/api/v2/auth/verify). Do not send x-access-token or x-user-identifier with it.

x-access-tokenstringOptional

Partner Auth (Auth Reliance). Your Partner Access Token. Send it with x-user-identifier, and do not send authorization. See Auth Reliance Flows and how to create a Partner Access Token.

x-user-identifierstringOptional

Partner Auth (Auth Reliance). The email address of the user you authenticated. Send it with x-access-token.

Request

This endpoint expects an object.
quoteIdstringRequired

Quote ID from the Quotes API.

moduleenumRequired

Set to kyc to initialize a Headless KYC session.

Allowed values:
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