This API reference details the interface for uploading individuals to the CKYC registry. For a high level understanding of the API, refer to CKYC Bulk Upload Guide
verifier
Object
verifier
ObjectThe verifier
object represents details of an employee from the regulated entity that has verified the records to be uploaded on CKYC registry.
The object is a mandatory field for all CKYC bulk uploads, and contains the parameters denoted in the table mentioned below.
Parameter | Type | Mandatory | Definition |
---|---|---|---|
name | String | Yes | The name of the employee who has done the KYC verification and is performing the CKYC upload. |
designation | String | Yes | The designation of the employee who is performing the CKYC upload. |
kyc_declaration_place | String | Yes | The place of declaration or verification of the KYC documents. |
employee_code | String | Yes | The employee code of the person performing the CKYC upload. |
individuals | Array | No | An array of individuals whose details are to be uploaded to CKYC. Refer the Individuals array |
legal_entities | Array | No | An array of legal entities whose details are to be uploaded to CKYC. |
individuals
Array
individuals
ArrayThe individuals array denotes a list of users who have to be either created or updated in the CKYC registry.
The details and validations of the objects inside the array are provided in the table mentioned below.
Parameter | Type | Mandatory | Definition |
---|---|---|---|
identifier | String | Yes | A unique reference ID of this user set by the RE. This is a mandatory field. |
salutation | String | Yes | The salutation of the user should be less than 5 characters. Examples are "MR", "MRS", "MS" and "MX" |
name | String | Yes | The full name of the user. |
gender | String | Yes | The gender of the user can be one of the following: MALE , FEMALE and TRANSGENDER |
date_of_birth | String | Yes | The date of the birth of the user. Validation is done on the format. The date format needs to be “YYYY-MM-DD”. |
relative | Object | Yes | The object contains the type (string) and name (string) of the relative. The type of the relative can be one FATHER or SPOUSE |
location | Object | Yes | The object that denotes the full address of the individual. |
document_submission_type | String | Yes | String denoting the types of documents submitted. Please refer to the Document Submission Type section. |
documents | Array | Yes | Array representing the list of documents. Following documents are mandatory: • 1 document of type PHOTOGRAPH • 1 document of type AADHAAR or PAN Refer to the Document Type section to learn more about the valid values for the type field in the members of documents array. |
ids | Array | Yes` | Array representing the list of IDs collected for the user. • 1 document ID of type PAN or AADHAAR is mandatory.Refer to the ID type section to learn more about the valid values for the type field in the members of documents array. |
location
Object
location
ObjectParameter | Type | Mandatory | Definition |
---|---|---|---|
address | String | Yes | The address string denoting the address of the user. |
pincode | String | Yes | A pincode of the address of the user. |
state | String | No | The state of the address of the user. |
city | String | No | The city of the address of the user. |
relative
Object
relative
ObjectParameter | Type | Mandatory | Definition |
---|---|---|---|
type | String | Yes | The type of the relative mentioned for the user. The type can be one of the following:• FATHER • SPOUSE |
name | String | Yes | The full name of the relative of the user. |
documents
Array
documents
ArrayThe documents
array is a list of objects. The following table represents the member objects of the documents
array.
Parameter | Type | Mandatory | Definition |
---|---|---|---|
base64 | String | Yes | The base64 string containing the actual image of the document. The maximum allowed size for these documents is 1 MB. |
type | String | Yes | The type of the document for the user. The type can be one of the following:• PASSPORT • VOTER_ID • PAN • DRIVING_LICENSE • AADHAAR • NREGA • EKYC • OFFLINE_AADHAAR • OTHERS |
ids
Array
ids
ArrayThe ids
array is a list of objects. The following table represents the member objects of the ids
array.
Parameter | Type | Mandatory | Definition |
---|---|---|---|
id_number | String | Yes | The ID number corresponding to the ID type . |
type | String | Yes | The type of the ID of the user. The type can be one of the following:• PHOTOGRAPH • PASSPORT • VOTER_ID • PAN • DRIVING_LICENSE • AADHAAR • NREGA • SIGNATURE • EKYC • OTHERS |