Get KYC Requirement

View as Markdown
The **Get KYC Requirement** is an **authenticated API call** that dynamically returns the **KYC status of the User** based on the **quote ID**. Since Transak supports **multi-level KYC** across different countries, this API helps determine the exact KYC requirements for a user before proceeding with transactions. The **quote ID** must be passed when calling this API, as it determines the required **KYC level (Simple KYC, Standard KYC, etc.)**. The response includes the kyc status which can be - - **NOT_SUBMITTED** → personal and address details are not submitted. - **APPROVED** → KYC is approved - **SUBMITTED** → KYC is submitted - **ADDITIONAL_FORMS_REQUIRED** → Additional KYC information required which can be fetched using GET Additional Requirements API.

Headers

authorizationstringRequiredDefaults to YOUR_USER_AUTH_TOKEN

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

x-user-identifierstringOptionalDefaults to USER_EMAIL_ID

Your authenticated user Email Id address.

Note: This is applicable only for Auth Reliance Flows

x-access-tokenstringOptionalDefaults to YOUR_ACCESS_TOKEN

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

Note: This is applicable only for Auth Reliance Flows

Query parameters

metadata[quoteId]stringRequiredDefaults to YOUR_QUOTE_ID

Quote Id generated from api/v2/lookup/quotes

apiKeystringRequiredDefaults to YOUR_API_KEY
Your API Key from Transak Dashboard

Response

200 - Enhanced KYC Additional Forms Required

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error