CKYC Download
CKYC Download API can be used by the platform to check if they are present on the CKYC repository. The platform can access the download ONLY if the customer is present with the repository.
CKYC Download shares a detailed list of documents uploaded by a regulated entity as well as customer information as detailed in the response.
This API accepts the below parameters.
- Enter your CKYC number from CKYC Search
- Type of authentication of the person whose CKYC details are to be downloaded. Can be 1 / 2 / 3.
- Auth factor - Depends on the auth_factor_type, refer to the table below for details.
Decentro returns a response from this API only if CERSAI returns a response basis the auth factor parameters passed by the platform.
CKYC Download with OCR
OCR can be performed directly on CKYC Documents by selecting the perform_ocr parameter and passing it as true.
Heads Up!
identityDetails is received directly from CKYC. If we don't get this block for a few customers, it means we have not received that block from CKYC.
Auth Factor
| auth_factor_type | auth_factor |
|---|---|
| 1 | Date of birth in the format: "yyyy-mm-dd". Example: "1993-03-29". |
| 2 | A combination of the 6-digit pin code and the year of birth. Example: "5600171992" where 560017 is the pin code and 1992 is the year of birth. |
| 3 | A valid 10-digit mobile number of the person whose AADHAAR is linked with. Example: "9001122339". |
Sample API
{
"reference_id": "ABCDEF12345",
"id_number": "XXXXXXXXXXXXXX",
"auth_factor_type": 1,
"auth_factor": "1993-03-29",
"consent": true,
"consent_purpose": "For bank account purpose",
"perform_ocr": false
}'
{
"decentroTxnId": "7CF40604AF8B46159925553024E780F4",
"responseCode": "S00000",
"responseKey": "success_ckyc_download",
"data": {
"kycStatus": "SUCCESS",
"kycResult": {
"personalIdentifiableData": {
"personalDetails": {
"constituitonType": "Individual",
"accountType": "Normal",
"ckycNo": "00000000000000",
"ckycReferenceId": "IN000000000000",
"prefix": "Mr",
"firstName": "ABC",
"middleName": "DEF",
"lastName": "QWE",
"fullName": "Mr ABC DEF QWE",
"fatherPrefix": "Mr",
"fatherFname": "DEF",
"fatherLname": "QWE",
"fatherFullname": "Mr DEF QWE",
"motherPrefix": "Mrs",
"motherFname": "RTY",
"motherFullname": "Mrs RTY QWE",
"gender": "MALE",
"dob": "01-01-2000",
"pan": "ABCPE1234F",
"permLine1": "SO address line 1",
"permLine2": "address line 2",
"permCity": "Bangalore",
"permDist": "Bangalore",
"permState": "KR",
"permCountry": "IN",
"permPin": "676102",
"permPoa": "E-KYC Authentication",
"permCorresSameflag": "Y",
"corresLine1": "SO address line 1",
"corresLine2": "address line 2",
"corresCity": "Bangalore",
"corresDist": "Bangalore",
"corresState": "KR",
"corresCountry": "IN",
"corresPin": "676102",
"corresPoa": "09",
"mobCode": "91",
"mobNum": "9999999999",
"decDate": "01-01-2015",
"decPlace": "Bangalore",
"kycDate": "********",
"docSub": "Equivalent E-Document",
"kycName": "********",
"kycDesignation": "********",
"kycBranch": "********",
"kycEmpcode": "********",
"numIdentity": "2",
"numRelated": "0",
"numImages": "3"
},
"identityDetails": {
"identity": [
{
"sequenceNo": "1",
"identityType": "Proof of Possession of Aadhaar",
"identityNumber": "XXXXXXXX1840",
"idVerificationStatus": "NO"
},
{
"sequenceNo": "2",
"identityType": "E-KYC Authentication",
"identityNumber": "XXXXXXXX1840",
"idVerificationStatus": "NO"
}
]
},
"imageDetails": {
"image": [
{
"sequenceNo": "1",
"imageType": "JPG",
"imageCode": "Photograph",
"branchCode": "BR001",
"imageData": "XXXXX"
},
{
"sequenceNo": "2",
"imageType": "JPG",
"imageCode": "E-KYC Authentication",
"branchCode": "BR001",
"imageData": "XXXXX"
},
{
"sequenceNo": "3",
"imageType": "PDF",
"imageCode": "Proof of Possession of Aadhaar",
"branchCode": "MUM02BR",
"imageData": "XXXXX"
}
]
}
}
},
"message": "KYC Details from CKYC downloaded successfully."
},
"status": "SUCCESS"
}
New CKYC Download Suite
CKYC Download Generate OTP API
This API accepts a CKYC Number or Reference ID and the registered mobile number to initiate an OTP-based download flow.
{
"reference_id": "cb71cd2b-5cbc-4c90-9913-48dd03e6da77",
"id_number": "10000000000011",
"mobile": "9898989898"
}'
{
"decentroTxnId": "63745729D13A4640A8818EF2810FC5DB",
"status": "SUCCESS",
"message": "OTP generated and sent successfully on the registered mobile number. Kindly trigger the Validate OTP API within the next 10 minutes.",
"responseKey": "success_otp_generated"
}
CKYC Download Validate OTP API
This API accepts the Decentro transaction ID of the Generate OTP hit along with the customer's OTP input and returns the CKYC Download JSON payload as part of the response, completing the download process.
{
"transaction_id": "5FF021E754214B3F9EE629C267BABA11",
"otp": "700202"
}
{
"decentroTxnId": "7CF40604AF8B46159925553024E780F4",
"responseCode": "S00000",
"responseKey": "success_ckyc_download",
"data": {
"kycStatus": "SUCCESS",
"kycResult": {
"personalIdentifiableData": {
"personalDetails": {
"constituitonType": "Individual",
"accountType": "Normal",
"ckycNo": "00000000000000",
"ckycReferenceId": "IN000000000000",
"prefix": "Mr",
"firstName": "ABC",
"middleName": "DEF",
"lastName": "QWE",
"fullName": "Mr ABC DEF QWE",
"fatherPrefix": "Mr",
"fatherFname": "DEF",
"fatherLname": "QWE",
"fatherFullname": "Mr DEF QWE",
"motherPrefix": "Mrs",
"motherFname": "RTY",
"motherFullname": "Mrs RTY QWE",
"gender": "MALE",
"dob": "01-01-2000",
"pan": "ABCPE1234F",
"permLine1": "SO address line 1",
"permLine2": "address line 2",
"permCity": "Bangalore",
"permDist": "Bangalore",
"permState": "KR",
"permCountry": "IN",
"permPin": "676102",
"permPoa": "E-KYC Authentication",
"permCorresSameflag": "Y",
"corresLine1": "SO address line 1",
"corresLine2": "address line 2",
"corresCity": "Bangalore",
"corresDist": "Bangalore",
"corresState": "KR",
"corresCountry": "IN",
"corresPin": "676102",
"corresPoa": "09",
"mobCode": "91",
"mobNum": "9999999999",
"decDate": "01-01-2015",
"decPlace": "Bangalore",
"kycDate": "********",
"docSub": "Equivalent E-Document",
"kycName": "********",
"kycDesignation": "********",
"kycBranch": "********",
"kycEmpcode": "********",
"numIdentity": "2",
"numRelated": "0",
"numImages": "3"
},
"identityDetails": {
"identity": [
{
"sequenceNo": "1",
"identityType": "Proof of Possession of Aadhaar",
"identityNumber": "XXXXXXXX1840",
"idVerificationStatus": "NO"
},
{
"sequenceNo": "2",
"identityType": "E-KYC Authentication",
"identityNumber": "XXXXXXXX1840",
"idVerificationStatus": "NO"
}
]
},
"imageDetails": {
"image": [
{
"sequenceNo": "1",
"imageType": "JPG",
"imageCode": "Photograph",
"branchCode": "BR001",
"imageData": "XXXXX"
},
{
"sequenceNo": "2",
"imageType": "JPG",
"imageCode": "E-KYC Authentication",
"branchCode": "BR001",
"imageData": "XXXXX"
},
{
"sequenceNo": "3",
"imageType": "PDF",
"imageCode": "Proof of Possession of Aadhaar",
"branchCode": "MUM02BR",
"imageData": "XXXXX"
}
]
}
}
},
"message": "KYC Details from CKYC downloaded successfully."
},
"status": "SUCCESS"
}
Updated 10 days ago