Skip to navigation

Identity Details

View as Markdown

Submits the user’s personal details, address, purpose of usage, and optional tax identifier (TIN) data to initialize the KYC Reliance flow. This request must always be called first in the KYC Reliance sequence — it initializes the KYC request on Transak’s side.

Headers

x-user-ipstringRequired

End user's originating IP. More details here

x-api-keystringRequired
Partner API Key present in Transak Dashboard.
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

our authenticated user Email Id 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.
personalDetailsobjectRequired
addressDetailsobjectRequired
purposeListlist of stringsRequired

Supported purpose strings (same contract as existing Whitelabel purpose-of-usage values). Examples include "Buying/selling crypto for investments", "Buying NFTs", and "Buying crypto to use a web3 protocol".

tinDetailsobjectOptional

Tax identification details. Optional depending on country/regulatory requirements — required when TIN collection applies for the user's jurisdiction.

Response

Success — KYC request initialized

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error