Get KYC - IdProof Status | Transak

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.

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

Query parameters

workFlowRunIdstringRequiredDefaults to f7a73b14-6c25-433e-802d-1ca4ac0ececa

workFlowRunId received in Get Additional Requirements API

Response

200 - Submitted

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error

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.

1	import requests
2
3	url = "https://api-gateway-stg.transak.com/api/v2/kyc/id-proof-status"
4
5	querystring = {"workFlowRunId":"f7a73b14-6c25-433e-802d-1ca4ac0ececa"}
6
7	headers = {
8	"authorization": "YOUR_USER_AUTH_TOKEN",
9	"x-user-identifier": "USER_EMAIL_ID",
10	"x-access-token": "YOUR_ACCESS_TOKEN"
11	}
12
13	response = requests.get(url, headers=headers, params=querystring)
14
15	print(response.json())

1	{
2	"data": {
3	"status": "NOT_SUBMITTED",
4	"kycType": "STANDARD"
5	}
6	}