kyc

Get KYC - IdProof Status

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.

get/api/v2/kyc/id-proof-status

Request

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

Query parameters

workFlowRunIdstring required

workFlowRunId received in Get Additional Requirements API

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 - Submitted

Changes

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