Sign in

v1

latestOpenAPI 3.1.02026-07-2418201.6 MB

CKYC Prefill

post/synchronous/hyperstream-executor

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 request

hyperstreamstring required

The name of the HyperStream

consentboolean required

true/false based on the consent given by the customer. Mandatory as per regulation.

Response

200

OR

Example response

{
  "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",
        "age": "XXXXXXXX"
      },
      "identity_details": {
        "PAN": [
          {
            "id_type": "PAN",
            "identity_number": "XXXXXXXXX"
          }
        ],
        "PASSPORT": [
          {
            "id_type": "PASSPORT",
            "identity_number": "XXXXXXXX"
          }
        ]
      },
      "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"
          }
        ]
      },
      "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": "CARLSMITH@MAIL.COM",
              "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>"
                }
              ]
            }
          }
        },
        "message": "KYC Details for CKYC retrieved successfully."
      },
      "responseKey": "success_ckyc_download"
    }
  },
  "reference_id": "XXXXXXXX"
}