Object

Overview of the ckyc_verification object.

Shown below is a sample ckyc_verification object.

{
  "id": "ckyc_WPm36XgdvuDVEX0JruB13ZA3X",
  "object": "ckyc_verification",
  "purpose": "savings_account",
  "document_type": "pan",
  "document_number": "BBBBB1234B",
  "name": "Anil Reddy",
  "ckyc_number": "70257809604369",
  "ckyc_date": "2020-12-25",
  "status": "success",
  "message": "success",
  "merchant_reference_id": "1673337192",
  "entity_details": [
    {
      "entity_type": "proprietorship",
      "ckyc_number": "46705257097369",
      "name": "Anil Reddy Enterprises",
      "place_of_incorporation": "Bangalore",
      "ckyc_date": "2022-08-04",
      "ckyc_updated_date": "2022-08-03"
    }
  ],
  "metadata": {
    "key_1": "DD",
    "key_2": "XoF"
  },
  "created_at": 1673337192,
  "updated_at": 1673337192,
  "is_sandbox": true
}

The table below lists the various parameters in the ckyc_verification object.

ParameterTypeDescription
idstringUnique identifier of the request in ZWITCH.

Example: ckyc_y60V1ZWa4oVpShsisqTf03Gvt
objectstringAPI object that is returned.

Possible value: ckyc_verification
purposestringReason you are checking if an individual is registered in the CKYC database.

Possible value: savings_account
document_typestringDocument used to search the CKYC database.

Possible values: pan
document_numberstringDocument number of the individual.

Example: AAAPA0000A
namestringName linked to the document as per the CKYC database.

Example: Anil Reddy
ckyc_numberstringUnique identifier of the individual in the CKYC database.

Example: O12345678900987
ckyc_datestringDate the individuals' details were added to the CKYC database.

Format: YYYY-MM-DD

Has to be 10 characters.

Example: 2022-12-31 Supported characters: <ul><li>0-9</li><li>-`
statusstringPossible values:
  • success: The API call was successful, the document was found in the CKYC database, and information linked to the document were returned in the API response.
  • failed: The API call was successful, but the document was not found in the CKYC database.
messagestringMessage explaining the status of the API.

Some possible values:
  • success: The API call was successful, the document was found in the CKYC database, and information linked to the document were returned in the API response.
  • CKYC not found: The API call was successful, but the document was not found in the CKYC database.
entity_detailsobjectObject contains the CKYC details of sole proprietorship.
merchant_reference_idstringUnique identifier entered when creating the request.

  • Only alphabets and numbers are allowed.
  • Minimum: 7 characters.
  • Maximum: 40 characters.

Example: 14096850
metadataobjectObject of key-value pair that can be used to store additional information about the entity.
  • Each pair cannot exceed 256 characters.
  • Maximum 5 key-value pairs.
Example: "key_1": "Zwitch to the moon.”
is_sandboxbooleanMode in which the API was triggered.

Possible values:
  • true: API was triggered in sandbox mode
  • false: API was triggered in live mode
created_atintegerUnix timestamp when the request was received by ZWITCH.

Example: 1656417101
updated_atintegerUnix timestamp when the request was processed by ZWITCH.

Example: 1656417101

[Child Object] Entity Details

The table below lists the various parameters in the entity_type child object. This object is part of the ckyc_verification object.

entity_typestringType of entity.

Example: proprietorship
ckyc_numberstringUnique identifier of the sole proprietorship in the CKYC database.

Example: O00000000000000
namestringName linked to the document as per the CKYC database.

Example: Anil Reddy
place_of_incorporationstringEntity registered place.

Example: RGA Tech Park
ckyc_datestringDate the sole proprietorship details were added to the CKYC database.

Format: YYYY-MM-DD

Has to be 10 characters.

Example: 2022-12-31 Supported characters: <ul><li>0-9</li><li>-`
ckyc_updated_datestringDate the sole proprietorship details were updated to the CKYC database.

Format: YYYY-MM-DD

Has to be 10 characters.

Example: 2022-12-31 Supported characters: <ul><li>0-9</li><li>-`