Object

The table below lists the different response objects received for the CKYC Registration APIs.

CKYC Registration APIs	Objects
Check CKYC Registration	`ckyc_verification`
Download CKYC Details	When downloading individual CKYC details: `ckyc_download.individual` When downloading entity CKYC details: `ckyc_download.entity`

Check CKYC API Object

Shown below is a sample ckyc_verification object.

{
  "id": "ckyc_QAA7bOJ5mOLlarj7hKvtc4x0r",
  "object": "ckyc_verification",
  "purpose": "savings_account",
  "document_type": "pan",
  "document_number": "BBBBB1234B",
  "name": "Anil Reddy",
  "fathers_name": "Sunil Reddy",
  "ckyc_number": "78216949627381",
  "registration_type": "normal",
  "ckyc_date": "22-10-2018",
  "status": "success",
  "message": "success",
  "merchant_reference_id": "1004348",
  "entity_details": [
    {
      "entity_type": "proprietorship",
      "ckyc_number": "51444032827486",
      "name": "Anil Reddy Enterprises",
      "place_of_incorporation": "Bangalore",
      "ckyc_date": "2022-08-04",
      "ckyc_updated_date": "2022-08-03"
    }
  ],
  "conssent": true,
  "metadata": {
    "key_1": "DD",
    "key_2": "XoF"
  },
  "created_at": 1678365314,
  "updated_at": 1678365314,
  "is_sandbox": true
}

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

Parameter	Type	Description
id	`string`	Unique identifier of the search CKYC request in the ZWITCH database. Example: `ckyc_y60V1ZWa4oVpShsisqTf03Gvt`
object	`string`	API object that is returned. Possible value: `ckyc_verification`
purpose	`string`	Reason you are checking if an individual or entity is registered in the CKYC database. Possible values: `savings_account` `current_account`
document_type	`string`	Type of KYC document used to check if an individual or entity is registered in the CKYC database. Possible value: `pan`
document_number	`string`	KYC document number used to check if an individual or entity is registered in the CKYC database. Example: `AAAPA0000A`
name	`string`	Name linked to the KYC document in the CKYC database. Example: `Anil Reddy`
fathers_name	`string`	KYC document holder's father's name in the CKYC database. Example: `Sunil Reddy`
ckyc_number	`string`	Unique identifier of the individual or entity in the CKYC database. Example: `O12345678900987`
registration_type	`string`	Type of CKYC registration. Possible values: `normal` `simplified` `small` `otp_based_e_kyc` Refer to theTypes of CKYC Registration section for more details.
ckyc_date	`string`	Date the individual's or entity's details were added to the CKYC database. Format: `YYYY-MM-DD` Has to be 10 characters. Example: `2022-12-31` Supported characters: `0-9` `-`
status	`string`	Possible values: `success`: The API call was successful and the individual's or entity's details were found in the CKYC database and returned in the API response. `failed`: The API call was successful, but the individual's or entity's details were not found in the CKYC database.
message	`string`	Message explaining the status of the API. Some possible values: `success`: The API call was successful and the individual's or entity's details were found in the CKYC database and returned in the API response. `CKYC not found`: The API call was successful, but the individual's or entity's details were not found in the CKYC database.
merchant_reference_id	`string`	Unique identifier entered when creating the request. Only alphabets and numbers are allowed. Minimum: 7 characters. Maximum: 40 characters. Example: `14096850`
entity_details	`object`	Object that contains entity CKYC details. Learn more about the entity_details child object.
consent	`boolean`	Individual's or entity's consent to check if they are registered in the CKYC database. Possible value: `true`
metadata	`object`	Object 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.”`
created_at	`integer`	Unix timestamp when the check CKYC registration request was received by ZWITCH. Example: `1656417101`
updated_at	`integer`	Unix timestamp when the check CKYC registration request was processed by ZWITCH. Example: `1656417101`
is_sandbox	`boolean`	Mode in which the API was triggered. Possible values: `true`: API was triggered in sandbox mode `false`: API was triggered in live mode

[Child Object] Entity Details

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


entity_type	`string`	Type of entity for which CKYC details were returned. Example: `proprietorship`
ckyc_number	`string`	Unique identifier of the entity in the CKYC database. Example: `O00000000000000`
name	`string`	Name linked to the KYC document in the CKYC database. Example: `Anil Reddy Enterprises`
place_of_incorporation	`string`	Place where the entity is registered. Example: `Bangalore`
ckyc_date	`string`	Date the entity details were added to the CKYC database. Format: `YYYY-MM-DD` Has to be 10 characters. Example: `2022-12-31` Supported characters: `0-9` `-`
ckyc_updated_date	`string`	Date the entity details were updated to the CKYC database. Format: `YYYY-MM-DD` Has to be 10 characters. Example: `2022-12-31` Supported characters: `0-9` `-`

Download Individual CKYC Details API Object

Shown below is a sample ckyc_download.individual object.

{
  "id": "ckyc_QAA7bOJ5mOLlarj7hKvtc4x0r",
  "type": "individual",
  "object": "ckyc_download.individual",
  "name": "Anil Reddy",
  "date_of_birth": "2020-12-31",
  "fathers_name": "Sunil Reddy",
  "ckyc_number": "78216949627381",
  "mobile_number": "9876543210",
  "email": "[email protected]",
  "addresses": [
    {
      "type": "permanent",
      "address": "211B BAKER STREET, BANGALORE - 560005",
      "city": "BANGALORE_URBAN",
      "postal_code": "560005",
      "state_code": "KA"
    },
    {
      "type": "communication",
      "address": "211B BAKER STREET, BANGALORE - 560005",
      "city": "BANGALORE_URBAN",
      "postal_code": "560005",
      "state_code": "KA"
    }
  ],
  "registration_type": "normal",
  "status": "success",
  "message": "success",
  "consent": true,
  "is_sandbox": true,
  "created_at": 1678365314,
  "updated_at": 1678366100
}

The table below lists the various parameters in the ckyc_download.individual object.

Parameter	Type	Description
id	`string`	Unique identifier of the check CKYC request in the ZWITCH database. Example: `ckyc_y60V1ZWa4oVpShsisqTf03Gvt`
type	`string`	Type of CKYC information downloaded. Possible value: `individual`
object	`string`	API object that is returned. Possible value: `ckyc_download.individual`
name	`string`	Name linked to the KYC document in the CKYC database. Example: `Anil Reddy`
date_of_birth	`string`	Individual's date of birth. Format: `YYYY-MM-DD` Must be 10 characters. Example: `2022-12-31` Supported characters: `0-9` `-`
fathers_name	`string`	KYC document holder's father's name in the CKYC database. Example: `Sunil Reddy`
ckyc_number	`string`	Unique identifier of the individual in the CKYC database. Example: `64470902945373`
mobile_number	`string`	Individual's mobile number. Must be 10 characters. Example: `9876543210` Supported characters: `0-9`
email	`string`	Individual's email address. Example: `[email protected]`
addresses	`array of objects`	Array of objects that contain a list of addresses linked to the individual or entity in the CKYC database. Refer to theAddress child object for more details.
registration_type	`string`	Type of CKYC registration. Possible values: `normal` `simplified_measures_account` `small_account` `otp_based_ekyc_account` Refer to theTypes of CKYC Registration section for more details.
status	`string`	Possible values: `success`: The API call was successful and the required details were downloaded from the CKYC database and returned in the API response. `failed`: The API call failed. This can happen because of a number of reasons such as network issues and service outages.
message	`string`	Message explaining the status of the API. Possible values: `success`: The API call was successful and the required details were downloaded from the CKYC database and returned in the API response. `Unable to download CKYC details`: The API call failed. This can happen because of a number of reasons such as network issues and service outages.
consent	`boolean`	Individual's or entity's consent to check if they are registered in the CKYC database. Possible value: `true`
is_sandbox	`boolean`	Mode in which the API was triggered. Possible values: `true`: API was triggered in sandbox mode `false`: API was triggered in live mode
created_at	`integer`	Unix timestamp when the request was received by ZWITCH. Example: `1656417101`
updated_at	`integer`	Unix timestamp when the request was processed by ZWITCH. Example: `1656417101`

[Child Object] Address

The table below lists the various parameters in the address child object. This object is part of the ckyc_download.individual object.

Parameter	Type	Description
type	`string`	Type of address linked to the KYC document holder in the CKYC database. Example: `permanent`, `communication`
address	`string`	KYC document holder's address in the CKYC database. Example: `211B BAKER STREET, BANGALORE - 560005`
city	`string`	KYC document holder's city in the CKYC database. Example: `Bangalore`
postal_code	`string`	KYC document holder's address in the CKYC database. Example: `560005`
state_code	`string`	KYC document holder's address in the CKYC database. Example: `KA`

Download Entity CKYC Details API Object

Shown below is a sample ckyc_download.entity object.

{
  "id": "ckyc_QAA7bOJ5mOLlarj7hKvtc4x0r",
  "type": "entity",
  "object": "ckyc_download.entity",
  "date_of_incorporation": "2020-12-31",
  "mobile_number": "7019452349",
  "email": "[email protected]",
  "addresses": [
    {
      "type": "permanent",
      "address": "211B BAKER STREET, BANGALORE - 560005",
      "city": "BANGALORE_URBAN",
      "postal_code": "560005",
      "state_code": "KA"
    },
    {
      "type": "communication",
      "address": "211B BAKER STREET, BANGALORE - 560005",
      "city": "BANGALORE_URBAN",
      "postal_code": "560005",
      "state_code": "KA"
    }
  ],
  "entity_details": {
    "entity_type": "proprietorship",
    "name": "Anil Reddy Enterprises",
    "ckyc_number": "51444032827486",
    "place_of_incorporation": "Bangalore",
    "ckyc_date": "2022-08-04",
    "ckyc_updated_date": "2022-08-03"
  },
  "status": "success",
  "message": "success",
  "consent": true,
  "is_sandbox": true,
  "created_at": 1678365314,
  "updated_at": 1678366793
}

The table below lists the various parameters in the ckyc_download.entity object.

Parameter	Type	Description
id	`string`	Unique identifier of the check CKYC request in the ZWITCH database. Example: `ckyc_y60V1ZWa4oVpShsisqTf03Gvt`
type	`string`	Type of CKYC information downloaded. Possible value: `entity`
object	`string`	API object that is returned. Possible value: `ckyc_download.entity`
date_of_incorporation	`string`	Date the entity was registered. Format: `YYYY-MM-DD` Has to be 10 characters. Example: `2022-12-31` Supported characters: `0-9` `-`
mobile_number	`string`	Registered mobile number of the entity. Has to be 10 characters. Example: `9876543210` Supported characters: `0-9`
email	`string`	Registered email address of the entity. Example: `[email protected]`
addresses	`array of objects`	Array of objects that contain a list of addresses linked to the individual or entity in the CKYC database. Refer to the Address child object for more details.
entity_details	`object`	Object that contains entity CKYC details. Learn more about the entity_details child object.
status	`string`	Possible values: `success`: The API call was successful and the required details were downloaded from the CKYC database and returned in the API response. `failed`: The API call failed. This can happen because of a number of reasons such as network issues and service outages.
message	`string`	Message explaining the status of the API. Possible values: `success`: The API call was successful and the required details were downloaded from the CKYC database and returned in the API response. `Unable to download CKYC details`: The API call failed. This can happen because of a number of reasons such as network issues and service outages.
is_sandbox	`boolean`	Mode in which the API was triggered. Possible values: `true`: API was triggered in sandbox mode `false`: API was triggered in live mode
created_at	`integer`	Unix timestamp when the request was received by ZWITCH. Example: `1656417101`
updated_at	`integer`	Unix timestamp when the request was processed by ZWITCH. Example: `1656417101`

[Child Object] Address

The table below lists the various parameters in the address child object. This object is part of the ckyc_download.entity object.

Parameter	Type	Description
type	`string`	Type of address linked to the KYC document holder in the CKYC database. Example: `permanent`, `communication`
address	`string`	KYC document holder's address in the CKYC database. Example: `211B BAKER STREET, BANGALORE - 560005`
city	`string`	KYC document holder's city in the CKYC database. Example: `Bangalore`
postal_code	`string`	KYC document holder's address in the CKYC database. Example: `560005`
state_code	`string`	KYC document holder's address in the CKYC database. Example: `KA`

[Child Object] Entity Details

The table below lists the various parameters in the entity_details child object. This object is part of the ckyc_download.entity object.


entity_type	`string`	Entity type. Example: `proprietorship`
ckyc_number	`string`	Unique identifier of the entity in the CKYC database. Example: `O00000000000000`
name	`string`	Entity name. Example: `Anil Reddy Enterprises`
place_of_incorporation	`string`	Place the entity is registered. Example: `Bangalore`
ckyc_date	`string`	Date the entity details were added to the CKYC database. Format: `YYYY-MM-DD` Has to be 10 characters. Example: `2022-12-31` Supported characters: `0-9` `-`
ckyc_updated_date	`string`	Date the entity details were updated to the CKYC database. Format: `YYYY-MM-DD` Has to be 10 characters. Example: `2022-12-31` Supported characters: `0-9` `-`