API Reference
Get StartedExport API CollectionSupport

CKYC Search API

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

🙌

Important Note

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

API Endpoints

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

Search the CKYC ID and details of a person from the Central Know Your Customer (CKYC) database using his/her national ID/document like -

  • Pan
  • Aadhaar
  • Passport
  • Voter ID
  • Driving License
  • CKYC Number

Refer here for CKYC Search Guide

📘

Important Note

Please refer to docs to know about the Auth Factor type (1, 2, 3).

📘

CKYC Search 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 ID that you want to use to fetch the CKYC ID. Can be PAN / AADHAAR / PASSPORT / VOTERID / DRIVING-LICENSE / CKYC NUMBER

string
required

Depends on the document_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)

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 4 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 months ago