TRANSAK WHITELABEL APIOn RampKYC

Get KYC - IdProof Status

View as Markdown
The **Get KYC - IdProof Status** is an **authenticated API** call allows you to **dynamically retrieve the current status** of the `idProof` KYC workflow, specifically related to submissions processed via **Onfido**. - Initially, the status will be returned as **`NOT_SUBMITTED`**, indicating that the user has not yet completed or submitted their KYC information. - Once the KYC information has been **successfully submitted to Onfido**, the status automatically updates to **`SUBMITTED`**. This API is particularly useful for identifying the **precise point** at which a user has completed the document verification step through Onfido. It enables real-time tracking of the user's KYC progression, ensuring smoother orchestration of downstream steps in the onboarding flow.

Headers

x-user-ipstringRequired

End user’s originating IP. More details here

x-api-keystringRequired
Partner API Key present in Transak Dashboard.
authorizationstringOptional

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

Note: This is not applicable for Auth Reliance Flows

x-user-identifierstringOptional

Your authenticated user Email Id address.

Note: This is applicable only for Auth Reliance Flows

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

Query parameters

workFlowRunIdstringRequired

workFlowRunId received in Get Additional Requirements API

Response

200 - Submitted

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
500
Internal Server Error