CKYC Prefill HyperStream
The CKYC Prefill Hyperstream takes the minimum possible input from the user, i.e., the name and phone number. Following this, the Hyperstream fetches all the documents of the user present in the CKYC Registry.
This API works best in production environment.
Due to the nature of the underlying APIs such as Credit Bureau, this API works best in the production environment where there are considerably higher data points to work with.
The
full_nameparameter is optionalIf the name is not provider, the
CKYC_PrefillHyperStream automatically deduces the name of the given mobile number. This however an optional field. In any case where the HyperStream is not able to deduce the name of the mobile number, you can retry the HyperStream with the name.The
full_nameparameter is made optional to ensure the maximum conversion rate.
The steps of the Hyperstream are mentioned below:
- If the optional
full_nameis not provided in the HyperStream request body, the HyperStream deduces the name and pushes it to the next step, i.e. the customer data pull module. - Using the
mobile_numberandfull_nameof the user, Decentro uses the customer data pull API to extract an ID number and the DOB required for the authentication factor in future steps. - Using the ID number, Decentro uses the CKYC search API to fetch the 14-digit CKYC Number
- Using the CKYC Number retrieved from step 2, and the DOB and other authentication factors retrieved from step 2, Decentro fetches the customer's records in the CKYC Registry.
Sample Request & Response
{
"reference_id": "DEC001",
"hyperstream": "CKYC_PREFILL",
"consent": true,
"consent_purpose": "To onboard user into platform",
"initial_input": {
"full_name": "JOHN DOE", // THIS IS AN OPTIONAL FIELD
"mobile_number": "9999999999"
}
}
{
"hyperstream_txn_id": "XXXXXXXXX",
"status": "SUCCESS",
"http_status_code": 200,
"response_key": "success_hyperstream",
"message": "Successfully executed CKYC_PREFILL Hyperstream",
"data": {
"OPTIONAL_MOBILE_TO_VPA": {
"consent": true,
"consent_purpose": "A VALID PURPOSE MESSAGE",
"reference_id": "XXXXXXXXXX",
"mobile_number": "XXXXXXX",
"full_name": "XXXXXXXXXX"
},
"DATA_PULL": {
"mobile_number": "XXXXXXXXX",
"full_name": "XXXXXXXXX",
"auth_factor_type": 1,
"auth_factor": "XXXXXXXX",
"document_type": "XXXXXX",
"id_number": "XXXXXXXX",
"personal_details": {
"full_name": "XXXXXXXX",
"dob": "XXXXXXXXX",
"total_income": "XXXXXXXX",
"occupation": "",
"age": "XXXXXXXX"
},
"identity_details": {
"PAN": [
{
"id_type": "PAN",
"identity_number": "XXXXXXXXX"
}
],
"PASSPORT": [
{
"id_type": "PASSPORT",
"identity_number": "XXXXXXXX"
}
],
"DRIVING_LICENSE": [],
"VOTER_ID": [],
"AADHAAR": [],
"RATION_CARD": [],
"OTHER": []
},
"phone_details": [
{
"number": "XXXXXXXXXXX",
"phone_type": "M",
"reported_date": "2024-02-25"
}
],
"address_details": [
{
"address": "XXXXXXX",
"state": "XXXXXX",
"address_type": "Owns",
"pincode": "XXXXXXX",
"reported_date": "YYYY-MM-DD"
}
],
"email_details": [
{
"email_address": "XXXXXXXXXX",
"reported_date": "2024-02-25"
}
]
},
"CKYC_SEARCH": {
"id_type": "CKYC",
"id_number": "XXXXXXXX",
"full_name": "XXXXXXXXX",
"age": "XX",
"kyc_date": "XXXXXXX",
"updated_date": "XXXXXX",
"fathers_name": "XXXXXXXX",
"photo": "XXXXX",
"identity_details": {
"identity": [
{
"status": "03",
"type": "Passport"
},
{
"status": "03",
"type": "Aadhaar"
},
{
"status": "03",
"type": "H"
},
{
"status": "03",
"type": "PAN"
}
]
},
"auth_factor_type": 1,
"auth_factor": "YYYY-MM-DD"
},
"CKYC_DOWNLOAD": {
"decentroTxnId": "DECXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"status": "SUCCESS",
"responseCode": "S00000",
"data": {
"kycStatus": "SUCCESS",
"kycResult": {
"personalIdentifiableData": {
"personalDetails": {
"constituitonType": "Individual",
"accountType": "Normal",
"ckycNo": "XXXXXXXXXXXXXX",
"prefix": "MR",
"firstName": "CARL",
"lastName": "SMITH",
"fullName": "MR CARL SMITH",
"fatherOrSpouse": "FATHER",
"fatherPrefix": "MR",
"fatherFname": "JON",
"fatherLname": "SMITH",
"fatherFullname": "MR JON SMITH",
"motherPrefix": "MRS",
"motherFname": "MARY",
"motherLname": "SMITH",
"motherFullname": "MRS MARY SMITH",
"gender": "MALE",
"dob": "DD-MM-YYYY",
"pan": "XXXXXXXXXX",
"permLine1": "S/O JON SMITH",
"permLine2": "MAPLE APARTMENT FLAT 407 INDIRANAGAR 1ST STAGE",
"permCity": "BENGALURU URBAN",
"permDist": "BENGALURU URBAN",
"permState": "KA",
"permCountry": "IN",
"permPin": "560038",
"permPoa": "Proof of Possession of Aadhaar",
"permCorresSameflag": "Y",
"corresLine1": "S/O JON SMITH",
"corresLine2": "MAPLE APARTMENT FLAT 407 INDIRANAGAR 1ST STAGE",
"corresCity": "BENGALURU URBAN",
"corresDist": "BENGALURU URBAN",
"corresState": "KA",
"corresCountry": "IN",
"corresPin": "560038",
"mobNum": "XXXXXXXXXX",
"email": "[email protected]",
"decDate": "DD-MM-YYYY",
"decPlace": "BANGALORE",
"kycDate": "********",
"docSub": "Certified Copies",
"kycName": "********",
"kycDesignation": "********",
"kycBranch": "********",
"kycEmpcode": "********",
"numIdentity": "1",
"numRelated": "0",
"numImages": "4"
},
"identityDetails": {
"identity": {
"sequenceNo": "1",
"identityType": "PAN",
"identityNumber": "XXXXXXXXXX",
"idVerificationStatus": "NO"
}
},
"imageDetails": {
"image": [
{
"sequenceNo": "1",
"imageType": "JPG",
"imageCode": "Photograph",
"globalFlag": "GLOBAL",
"branchCode": "BLR",
"imageData": "<base_64_string>"
},
{
"sequenceNo": "2",
"imageType": "PDF",
"imageCode": "PAN",
"globalFlag": "GLOBAL",
"branchCode": "BLR",
"imageData": "<base_64_string>"
},
{
"sequenceNo": "3",
"imageType": "JPG",
"imageCode": "Proof of Possession of Aadhaar",
"globalFlag": "GLOBAL",
"branchCode": "BLR",
"imageData": "<base_64_string>"
},
{
"sequenceNo": "4",
"imageType": "JPG",
"imageCode": "Passport",
"globalFlag": "GLOBAL",
"branchCode": "BLR",
"imageData": "<base_64_string>"
},
{
"sequenceNo": "5",
"imageType": "PDF",
"imageCode": "Driving License",
"globalFlag": "GLOBAL",
"branchCode": "BLR",
"imageData": "<base_64_string>"
},
{
"sequenceNo": "6",
"imageType": "JPG",
"imageCode": "Voters Identity Card",
"globalFlag": "GLOBAL",
"branchCode": "BLR",
"imageData": "<base_64_string>"
},
{
"sequenceNo": "7",
"imageType": "JPG",
"imageCode": "Signature",
"globalFlag": "GLOBAL",
"branchCode": "BLR",
"imageData": "<base_64_string>"
}
]
}
}
},
"message": "KYC Details for CKYC retrieved successfully."
},
"responseKey": "success_ckyc_download"
}
},
"reference_id": "XXXXXXXX"
}
Updated about 1 month ago