TRANSAK WHITELABEL APIKYC Reliance

Get KYC Reliance Status

View as Markdown
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 Steps** API to process or find the missing details. | | **DONE** | Final state indicating the **KYC Reliance process is completed** successfully (WHEN forms\[\] is empty, meaning there are no pending or missing KYC details) | | **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 Steps** 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.

Headers

authorizationstringRequiredDefaults to YOUR_USER_AUTH_TOKEN

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

Query parameters

quoteIdstringRequiredDefaults to YOUR_QUOTED_ID
Quote ID received from the Get KYC Reliance Quote API.
kycShareTokenProviderstringRequiredDefaults to SUMSUB

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

kycShareTokenstringRequiredDefaults to sumsub-share-token-12345
KYC share token generated by the selected provider.

Response headers

Datestring
The date and time when the response was generated.
Transfer-Encodingstring
The form of encoding used to transfer the response payload.
Connectionstring
Connection management options for this response.
varystring
Response header vary.
access-control-allow-credentialsstring

Response header access-control-allow-credentials.

x-xss-protectionstring

Response header x-xss-protection.

x-frame-optionsstring

Response header x-frame-options.

strict-transport-securitystring

Response header strict-transport-security.

x-download-optionsstring

Response header x-download-options.

x-content-type-optionsstring

Response header x-content-type-options.

surrogate-controlstring

Response header surrogate-control.

Cache-Controlstring
Caching directives for this response.
pragmastring
Response header pragma.
expiresstring
Response header expires.
cf-cache-statusstring

Response header cf-cache-status.

Serverstring
Information about the origin server.
CF-RAYstring

Response header CF-RAY.

Content-Encodingstring
The encoding applied to the response body.
alt-svcstring

Response header alt-svc.

Response

200 - Successfully Imported

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
500
Internal Server Error