usingSumsub

Get KYC Reliance Status

The Get KYC Reliance Status is an authenticated API call that validates the KYC Shared token from SumSub by providing the appropriate status. This API is mandatory in the KYC Reliance process to sync the KYC details from the Partner system to Transak. Below is the status that explains the various KYC Reliance statuses in detail.

KYC Reliance Status Types

State	Description
IMPORTED	Triggered when KYC Reliance data is successfully fetched, but not successfully processed from Transak. Use Get KYC Requirement API to process or find the missing details.
DONE	Final state indicating the KYC Reliance process is completed successfully (WHEN Get KYC Requirement API returns APPROVED)
FAILED	Indicates the KYC Reliance process has failed due to validation or processing errors. The partner has to redo the KYC token generation process by providing the required details. <br> <br>Note: Use Get KYC Requirement to find the missing details.
INITIALIZED	Indicates that the Transak system received the KYC share token. This is the initial status field that can be triggered only when the KYC share token is passed in the Get KYC Reliance Quote API. <br> <br>Note: This status will barely be noticed as it is an interim state before IMPORTED.
VALIDATED	This intermediate status between IMPORTED and DONE means that the Transak system validates the fields.

Note:
In an ideal scenario, only IMPORTED, DONE and FAILED are primarily used.

get/api/v2/kyc/share-token-status

Request

Base URL: https://api-gateway-stg.transak.com
URL: https://api-gateway-stg.transak.com/api/v2/kyc/share-token-status
Auth: none declared. Required headers: x-user-ip, x-api-key

Query parameters

quoteIdstring required

Quote ID received from the Get KYC Reliance Quote API.

kycShareTokenProviderstring required

KYC provider used to generate the share token (for example, SUMSUB).

kycShareTokenstring required

KYC share token generated by the selected provider.

Headers

x-user-ipstring required

End user's originating IP. More details here

x-api-keystring required

Partner API Key present in Transak Dashboard.

authorizationstring

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

Note: This is not applicable for Auth Reliance Flows

x-user-identifierstring

Your authenticated user Email Id address.

Note: This is applicable only for Auth Reliance Flows

x-access-tokenstring

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

Note: This is applicable only for Auth Reliance Flows

Response

200 - Successfully Imported

Changes

No recorded changes to this operation across all 1 revision of this API.