API Reference
Get StartedExport API CollectionSupport

CKYC Download API

post
https://in.staging.decentro.tech/v2/kyc/ckyc/download

🙌

Important Note

Please use only Staging Credentials on each API Reference page to test the APIs directly from our Documentation.

API Endpoints

EnvironmentEndpoint
Staging / Sandboxhttps://in.staging.decentro.tech
Productionhttps://in.decentro.tech

Download the CKYC details of a person using his/her CKYC ID by retrieving it from the Search API and his/her 'Date of Birth' / 'Mobile number' / 'Pincode + year of birth' from the Central Know Your Customer (CKYC) database.

Refer here for CKYC Download Guide

Master List of Response Keys

📘

Perform OCR

OCR can be performed directly on CKYC Documents by selecting the perform_ocr parameter and passing it as true.

📘

Note

Please refer to guide to know about the Auth Factor type (01, 02, 03).

📘

CKYC Download Response Keys

Here are the Response Keys and the scenarios under which Decentro will propagate the same to the platform - Response Keys

Body Params
string
required

Any unique ID assigned by you for this API request.

string
required

The national CKYC number of the person which can be fetched using the Search API.

int32

Type of authentication of the person whose CKYC details are to be downloaded. Can be 1 / 2 / 3.

date
required

Depends on the auth_factor_type, refer the table below for details.

boolean
required
Defaults to false

true/false based on if your customer has given you the consent for validating his CKYC based on this. Mandatory as per regulation.

string
required

The purpose of taking this consent from your customer. Mandatory as per regulation. (>20 characters)

boolean

If you want to perform OCR on CKYC Documents. Accepted values are true/false.

Headers
string
required

ID/identifier that is provided by Decentro to a specific client and environment. Please note, this may change based on the environment you are on.

string
required

The confidential credential provided by Decentro that is associated with the client_id

Responses

Updated 7 days ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 days ago