Sign in

v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

CKYC Search API

post/v2/kyc/ckyc/search

Headers

client_idstring 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.

client_secretstring required

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

Request body

reference_idstring required

Any unique ID assigned by you for this API request.

document_typestring required

The ID that you want to use to fetch the CKYC ID. Can be PAN / AADHAAR / PASSPORT / VOTERID / DRIVING-LICENSE / CKYC NUMBER

id_numberstring required

Depends on the document_type, refer the table below for details

consentboolean required

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

consent_purposestring required

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

Response

200

OR
OR
OR
OR
OR
OR

Example response

{
  "decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "status": "SUCCESS",
  "responseCode": "S00000",
  "data": {
    "kycStatus": "SUCCESS",
    "kycResult": {
      "ckycId": "XXXXXXXXXXXXXX",
      "ckycReferenceId": "XXXXXXXXXXXXXX",
      "fullName": "XXXXXXXXXXXXXX",
      "age": "25",
      "kycDate": "DD-MM-YYYY",
      "updatedDate": "DD-MM-YYYY",
      "fathersFullName": "XXXXXXXXXXXXXXXXXX",
      "imageType": "jpg",
      "photo": "<Base64 Image>",
      "identityDetails": {
        "identity": [
          {
            "status": "03",
            "type": "Driving License"
          }
        ]
      }
    },
    "message": "KYC Details for CKYC retrieved successfully."
  },
  "responseKey": "success_ckyc_search"
}