Upload/Update Details APINEW

Digi KYC
CKYC
API Integration
Upload/Update Details API

The CKYC Upload function is used to register the CKYC record in CKYCRR where the client’s record is not available in the Registry. Post the generation of the CKYC identifier, the reporting entity shall communicate the same to the client in writing.

Note: The response is coming from CKYC.

API Base URL - http://localhost:1423, check details here. Kindly append the Base URL to the API endpoints below to integrate

Note: Please make the REQUEST BODY as multipart/form-data ( Ignore the application/json written below )

CKYC Upload API

post {BASE_URL}/v3/client/kyc/ckyc/register

Upload CKYC details

Note: Please make the REQUEST BODY as multipart/form-data ( Ignore the application/json written below )

REQUEST

REQUEST BODY application/json

Field

Type

Description

- register_ckyc_request

object

CKYC register request containing the json

is_update_operation *

boolean

➔ Indicates whether the operation is an update. Set to false for a new entry.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

Allowed: true┃false

ckyc_no

string

CKYC number of the applicant.

Mandatory for Individual : Yes, For modification

Mandatory for Non-Individual : Yes, For modification

- update_flags*

object

Flags for each field indicating which details need to be updated.

applicant_name

boolean

➔ Indicates whether the applicant's name has been updated.

Mandatory for Individual : Yes, For modification

Mandatory for Non-Individual : Yes, For modification

**Not applicable , For new registration

Allowed: true┃false

personal_details

boolean

➔ Indicates whether personal details have been updated.

Mandatory for Individual : Yes, For modification

Mandatory for Non-Individual : Yes, For modification

Not applicable , For new registration

Allowed: true┃false

address_details

boolean

➔ Indicates whether address details have been updated.

Mandatory for Individual : Yes, For modification

Mandatory for Non-Individual : Yes, For modification

Not applicable , For new registration

Allowed: true┃false

contact_details

boolean

➔ Indicates whether contact details have been updated.

Mandatory for Individual : Yes, For modification

Mandatory for Non-Individual : Yes, For modification

Not applicable , For new registration

Allowed: true┃false

remarks_update

boolean

➔ Indicates whether remarks have been updated.

Mandatory for Individual : Yes, For modification

Mandatory for Non-Individual : Yes, For modification

Not applicable , For new registration

Allowed: true┃false

kyc_verification

boolean

➔ Indicates whether KYC verification details have been updated.

Mandatory for Individual : Yes, For modification

Mandatory for Non-Individual : Yes, For modification

Not applicable , For new registration

Allowed: true┃false

identity_details

boolean

➔ Indicates whether identity details have been updated.

Mandatory for Individual : Yes, For modification

Mandatory for Non-Individual : Yes, For modification

Not applicable , For new registration

Allowed: true┃false

related_person_details

boolean

➔ Indicates whether details of related persons have been updated.

Mandatory for Individual : Yes, For modification

Mandatory for Non-Individual : Yes, For modification

Not applicable , For new registration

Allowed: true┃false

image_details

boolean

➔ Indicates whether image details have been updated.

Mandatory for Individual : Yes, For modification

Mandatory for Non-Individual : Yes, For modification

Not applicable , For new registration

Allowed: true┃false

- personal_details*

object

Details about the applicant's personal information.

constitution_type *

enum

➔ Type of constitution (e.g., Individual, Company).

Allowed values:

01 - Individual (Type: Individual)

A - Sole Proprietorship (Type: Legal Entity / Other than Individual)

B - Partnership Firm (Type: Legal Entity / Other than Individual)

C - HUF (Type: Legal Entity / Other than Individual)

D - Private Limited Company (Type: Legal Entity / Other than Individual)

E - Public Limited Company (Type: Legal Entity / Other than Individual)

F - Society (Type: Legal Entity / Other than Individual)

G - Association of Persons (AOP)/ Body of Individuals (BOI) (Type: Legal Entity / Other than Individual)

H - Trust (Type: Legal Entity / Other than Individual)

I - Liquidator (Type: Legal Entity / Other than Individual)

J - Limited Liability Partnership (Type: Legal Entity / Other than Individual)

K - Artificial Liability Partnership (Type: Legal Entity / Other than Individual)

L - Public Sector Banks (Type: Legal Entity / Other than Individual)

M - Central/State Government Departments/Agency (Type: Legal Entity / Other than Individual)

N - Section 8 (Companies Act, 2013) (Type: Legal Entity / Other than Individual)

O - Artificial Juridical Person (Type: Legal Entity / Other than Individual)

P - International Organisation or Agency/Foreign embassy or consular office etc. (Type: Legal Entity / Other than Individual)

Q - Not Categorized (Type: Legal Entity / Other than Individual)

R - Others (Type: Legal Entity / Other than Individual)

S - Foreign Portfolio Investors (Type: Legal Entity / Other than Individual)

Mandatory for Individual : Yes'

Mandatory for Non-Individual : Yes

Allowed: 01┃A┃B┃C┃D┃E┃F┃G┃H┃I┃J┃K┃L┃M┃N┃O┃P┃Q┃R┃S

constitution_type_others

string

Details if 'Other' R is selected for constitution type.

Mandatory for Individual : No

Mandatory for Non-Individual : Yes, if constitution type is 'R'

account_type *

enum

➔ Type of account associated with the applicant.

Allowed Values:

"01-Normal

04 - OTP Based E-KYC

05 - Minor

Mandatory for Individual : Yes

Mandatory for Non-Individual : Not applicable

Allowed: 01┃04┃05

prefix *

string

Prefix of the applicant's name (e.g., Mr., Ms.).

Mandatory for Individual : Yes

Mandatory for Non-Individual : Not applicable

first_name *

string

First name of the applicant.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Not applicable

middle_name

string

Middle name of the applicant.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

last_name

string

Last name of the applicant.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

full_name

string

Full name of the applicant.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

maiden_prefix

string

Prefix for the applicant's maiden name (if applicable).

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

maiden_first_name

string

First name of the applicant's maiden name.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

maiden_middle_name

string

Middle name of the applicant's maiden name.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

maiden_last_name

string

Last name of the applicant's maiden name.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

maiden_full_name

string

Full maiden name of the applicant.Not applicable, For new registration

Mandatory for Individual : No'

Mandatory for Non-Individual : Not applicable

father_spouse_flag

string

Flag indicating whether the reference is to the father or spouse.

01- Father Name

02- Spouse Name

Mandatory for Individual : yes, if either father's name or spouse's name provided

Mandatory for Non-Individual : Not applicable

father_prefix

string

Prefix of the father's name.

Mandatory for Individual : yes, if provided in flag indicate father or spouse name

Mandatory for Non-Individual : Not applicable

father_first_name

string

First name of the father.

Mandatory for Individual : yes, if provided in flag indicate father or spouse name'

Mandatory for Non-Individual : Not applicable

father_middle_name

string

Middle name of the father.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

father_last_name

string

Last name of the father.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

father_full_name

string

Full name of the father.

Mandatory for Individual : No, Not applicable, For new registration

Mandatory for Non-Individual : Not applicable

mother_prefix

string

Prefix of the mother's name.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

mother_first_name

string

First name of the mother.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

mother_middle_name

string

Middle name of the mother.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

mother_last_name

string

Last name of the mother.

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

mother_full_name

string

Full name of the mother.

Mandatory for Individual : No, Not applicable, For new registration

Mandatory for Non-Individual : Not applicable

gender *

enum

➔ Gender of the applicant.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Not applicable

Allowed: M┃F┃T

dob *

dd-MM-yyyy

Date of birth of the applicant.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

place_incorp *

string

Place where the corporation is registered (if applicable).

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : Yes

commence_date

dd-MM-yyyy

Date when the corporation commenced business.

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : No

country_incorp *

string

Country where the corporation is registered. One must follow country code for 2 digit country code

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : Yes

pan *

string

Permanent Account Number (PAN) of the applicant. Value should be either 'FORM60' or PAN(5alphabets+4numbers+1alphabet)

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

tin_gst_reg_no

string

Taxpayer Identification Number (TIN) or GST Registration Number.

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : No

tin_issuing_country

string

Country issuing the TIN.

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : No

residential_status

string

Residential status of the individual. Default Value “01” passed by Digio.

disability_flag

string

Flag for whether the individual has disability or not. Default Value “0” passed by Digio.

disability_type

string

Type of disability of the individual, One must follow Disability Type for disability type. Only if Differently Abled Flag is set to '1'

disability_percent

string

Percentage of impairment. Only if Differently Abled Flag is set to '1'

disability_udid_number

string

UDID number of the disabled person. first 2 digit to be Alphabets, remaining 16 digits to be numeric. Only if Differently Abled Flag is set to '1'

perm_address_line1 *

string

Line 1 of the permanent address.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

perm_address_line2

string

Line 2 of the permanent address.

Mandatory for Individual : No

Mandatory for Non-Individual : No

perm_address_line3

string

Line 3 of the permanent address.

Mandatory for Individual : No

Mandatory for Non-Individual : No

perm_address_city *

string

City of the permanent address.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

perm_address_dist

string

District of the permanent address.

Mandatory for Individual : Yes, if country is india

Mandatory for Non-Individual : Yes, if country is india

perm_address_state *

string

State of the permanent address.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

perm_address_country *

string

Country of the permanent address. One must follow Country code for 2 digit country code

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

perm_address_pincode

string

Pincode of the permanent address. Should be 6 digits if Country selected is 'India' Not mandatory if country is not India

Mandatory for Individual : Yes, if country is india

Mandatory for Non-Individual : Yes, if country is india

perm_poa_type *

string

Proof of address (POA) type for the permanent address. One must follow POA Type for code of Proof of address type.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

poa_legal_entity

string

Legal entity type for POA (if applicable).

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : Yes, if address proof is '99' and constitution type is other than '01'

perm_current_same *

enum

➔ Indicates if the permanent and current addresses are the same.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

Allowed: Y┃N

curr_address_line1

string

Line 1 of the current address.

Mandatory for Individual : Yes, if flag indicating current/permanent/overseas address is same as corresponding/local address is 'N'

Mandatory for Non-Individual : Yes, if flag indicating current/permanent/overseas address is same as corresponding/local address is 'N'

curr_address_line2

string

Line 2 of the current address.

Mandatory for Individual : No

Mandatory for Non-Individual : No

curr_address_line3

string

Line 3 of the current address.

Mandatory for Individual : No

Mandatory for Non-Individual : No

curr_address_city

string

City of the current address.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

curr_address_dist

string

District of the current address.

Mandatory for Individual : No

Mandatory for Non-Individual : No

curr_address_state

string

State of the current address.

Mandatory for Individual : No

Mandatory for Non-Individual : No

curr_address_country

string

Country of the current address. One must follow Country code for 2 digit country code

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

curr_address_pincode

string

Pincode of the current address. Should be 6 digits if Country selected is 'India' Not mandatory if country is not India

Mandatory for Individual : Yes, if country is india

Mandatory for Non-Individual : Yes, if country is india

curr_poa_type

string

Proof of address (POA) type for the current address. One must follow POA Type for code of Proof of address type.

Mandatory for Individual : yes, if 'flag indicating if proof of identity and address is same as current address' is 'N'

Mandatory for Non-Individual : Not applicable

res_tel_std_code

string

Residential telephone STD code.

Mandatory for Individual : yes, If residence telephone No. (STD) code is provided, residence telephone number is mandatory and vice versa

Mandatory for Non-Individual : Not applicable

res_tel_no

string

Residential telephone number.

Mandatory for Individual : Yes, If residence telephone No. (STD) code is provided, residence telephone number is mandatory and vice versa

Mandatory for Non-Individual : Not applicable

office_tel_std_code

string

Office telephone STD code. If office telephone No. (STD) code is provided, office telephone number is mandatory and vice versa

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

office_tel_no

string

Office telephone number. If office telephone No. (STD) code is provided, office telephone number is mandatory and vice versa

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

mobile_isd_code

string

Mobile ISD code. If mobile telephone No. (ISD) code is provided, mobile telephone number is mandatory and vice versa

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

mobile_no

string

Mobile number. '- If mobile telephone No. (ISD) code is provided, mobile telephone number is mandatory and vice versa

If prefix is '+91' or blank, then mobile number needs to be 10 digits. Else, any numerical value upto 20 digits is permissable

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

fax_std_code

string

Fax STD code.

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : Yes, If Fax No. (STD) code is provided, Fax number is mandatory and vice versa

fax_no

string

Fax number

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : Yes, If Fax No. (STD) code is provided, Fax number is mandatory and vice versa

string

Email address.

Mandatory for Individual : No

Mandatory for Non-Individual : No

remarks

string

Additional remarks.

Mandatory for Individual : No

Mandatory for Non-Individual : No

dec_date *

dd-MM-yyyy

Declaration date.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

dec_place *

string

Declaration place.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_ver_date *

dd-MM-yyyy

Date of KYC verification.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_document_type *

enum

➔ Type of KYC document provided.

Allowed Values:

01- Certified Copies

02 - E-KYC data received from UIDAI

03 - Data received from offline verification

04 - Digital KYC process

05 - Equivalent e-document

06- Video-based KYC

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

Allowed: 01┃02┃03┃04┃05┃06

kyc_name *

string

Name of the person performing KYC. (KYC Verification Name)

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_desig *

string

Designation of the person performing KYC. (KYC Verification Designation)

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_branch *

string

Branch where KYC was conducted. (KYC Verification Branch)

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_emp_code *

string

Employee code of the person performing KYC. (KYC Verification EMP code)

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_org_name *

string

Organization name of the KYC verifier. (Organisation Name)

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_org_code *

string

Organization code of the KYC verifier. (Organisation Code)

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_id_ver_flag *

string

Flag indicating whether ID verification is complete. (Identity Verification Flag)

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : Yes

mobile_isd_code2

string

Alternate mobile ISD code.

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : Yes, If mobile No 2. (ISD) code is provided, mobile telephone number is mandatory and vice versa

mobile_no2

string

Alternate mobile number. '- If mobile telephone No. 2 (ISD) code is provided, mobile telephone number is mandatory and vice versa

If prefix is '+91' or blank, then mobile number needs to be 10 digits. Else, any numerical value upto 20 digits is permissable

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : Yes

email_id2

string

Alternate email address.

Mandatory for Individual : No

Mandatory for Non-Individual : No

marital_status

string

Marital status of the applicant.

Mandatory for Individual : No

Mandatory for Non-Individual : No

nationality

string

Nationality of the applicant.

Mandatory for Individual : No

Mandatory for Non-Individual : No

occupation_type

string

Type of occupation.

Mandatory for Individual : No

Mandatory for Non-Individual : No

country_of_residence

string

Country of residence as per tax laws.

Mandatory for Individual : No

Mandatory for Non-Individual : No

identification_type

string

Type of identification provided.

Mandatory for Individual : No

Mandatory for Non-Individual : No

- id_details*

array of object

List of identity details provided by the applicant.
⮕ [ List of identity details provided by the applicant. ]

type *

string

Identification type . One must refer Identification Type for codes.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

id_no

string

Identity Number

Mandatory for Individual : No

Mandatory for Non-Individual : No

other_desc

string

Other Identity description. If identity code provided is 'Z', identity name to be provided here. Will be provided for all constitution types

Mandatory for Individual : No

Mandatory for Non-Individual : No

ver_status

enum

➔ Identity Verification status.

'01- Yes

02- No

If response is '01' it indicated that the ID is verified with the ID issuer.

If response is '02' it indicates that the ID is not verified with the ID issuing authority

Mandatory for Individual : No

Mandatory for Non-Individual : Not applicable

Allowed: 01┃02

- image_details*

array of object

List of images or visual documents related to the applicant.
⮕ [ List of images or visual documents related to the applicant. ]

reference_id *

string

Reference Id of the Image

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

type *

string

Image Type. One must follow Image Type for codes

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

image_file_name *

string

Image File Name with extension(image1.JPG) in Folder

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

- related_person_details

array of object

Details about persons related to the applicant.
⮕ [ Details about persons related to the applicant. ]

relationship_type *

string

Relationship Type. One must follow Type for codes

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

add_delete_flag *

enum

➔ add Delete Flag. 01 for addition, 02 for deletion

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

Allowed: 01┃02

ckyc_no

string

CKYC Number

Mandatory for Individual : No

Mandatory for Non-Individual : No

prefix *

string

Related Person's Name prefix

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

first_name *

string

Related Person's First Name

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

middle_name

string

Related person's middle name

Mandatory for Individual : No

Mandatory for Non-Individual : No

last_name

string

Related person's last name

Mandatory for Individual : No

Mandatory for Non-Individual : No

maiden_prefix

string

Related person's maiden prefix

Mandatory for Individual : No

Mandatory for Non-Individual : No

maiden_first_name

string

Related person's maiden First Name

Mandatory for Individual : No

Mandatory for Non-Individual : No

maiden_middle_name

string

Related person's maiden Middle Name

Mandatory for Individual : No

Mandatory for Non-Individual : No

maiden_last_name

string

Related person's maiden Last Name

Mandatory for Individual : No

Mandatory for Non-Individual : No

father_spouse_flag

string

Related person's father/spouse Flag. Either mother name or father name/ spouse name is mandatory

Mandatory for Individual : No

Mandatory for Non-Individual : No

father_prefix

string

Related person's father/spouse Prefix

Mandatory for Individual : No

Mandatory for Non-Individual : No

father_first_name

string

Related person's father/spouse First Name

Mandatory for Individual : No

Mandatory for Non-Individual : No

father_middle_name

string

Related person's father/spouse Middle Name

Mandatory for Individual : No

Mandatory for Non-Individual : No

father_last_name

string

Related person's father/spouse Last Name

Mandatory for Individual : No

Mandatory for Non-Individual : No

mother_prefix

string

Related person's mother Prefix, Either mother name or father name/ spouse name is mandatory

Mandatory for Individual : No

Mandatory for Non-Individual : No

mother_first_name

string

Related person's mother First Name

Mandatory for Individual : No

Mandatory for Non-Individual : No

mother_middle_name

string

Related person's mother Middle Name

Mandatory for Individual : No

Mandatory for Non-Individual : No

mother_last_name

string

Related person's mother Last Name

Mandatory for Individual : No

Mandatory for Non-Individual : No

dob *

dd-MM-yyyy

Related person's Date of birth

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

gender *

enum

➔ Related person's gender

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

Allowed: M┃F┃T

nationality *

string

Nationality. One must follow Country Code for 2 digit country code

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

residential_status

string

Residential status of the individual. Default Value “01” passed by Digio.

disability_flag

string

Flag for whether the individual has disability or not. Default Value “0” passed by Digio.

disability_type

string

Type of disability of the individual

disability_percent

string

Percentage of impairment.

disability_udid_number

string

UDID number of the disabled person. first 2 digit to be Alphabets, remaining 16 digits to be numeric.

pan *

string

Pan Number, Either 10 character PAN to be provided or 'FORM60' to be mentioned in text

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

aadhaar_id

string

Aadhaar ID, Any one proof of ID for Related Person mandatory

Mandatory for Individual : No

Mandatory for Non-Individual : No

voter_id

string

Voter Id, Any one proof of ID for Related Person mandatory

Mandatory for Individual : No

Mandatory for Non-Individual : No

nrega_job_card

string

narega Job Card, Any one proof of ID for Related Person mandatory

Mandatory for Individual : No

Mandatory for Non-Individual : No

passport_no

string

passport No, Any one proof of ID for Related Person mandatory

Mandatory for Individual : No

Mandatory for Non-Individual : No

driving_license_no

string

driving License number, Any one proof of ID for Related Person mandatory

Mandatory for Individual : No

Mandatory for Non-Individual : No

national_population_reg_letter

string

national Population Reg Letter, Any one proof of ID for Related Person mandatory

Mandatory for Individual : No

Mandatory for Non-Individual : No

ekyc_auth

string

ekyc Auth, Only last 4 digits of Aadhaar number will be stored, Any one proof of ID for Related Person mandatory

Mandatory for Individual : No

Mandatory for Non-Individual : No

offline_aadhaar_ver

string

offline Aadhaar Ver, Only last 4 digits of Aadhaar number will be stored, Any one proof of ID for Related Person mandatory

Mandatory for Individual : No

Mandatory for Non-Individual : No

perm_address_line1 *

string

permanent Address Line1

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

perm_address_line2

string

permanent Address Line2

Mandatory for Individual : No

Mandatory for Non-Individual : No

perm_address_line3

string

permanent Address Line3

Mandatory for Individual : No

Mandatory for Non-Individual : No

perm_address_city *

string

permanent Address City

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

perm_address_dist

string

permanent Address Dist

Mandatory for Individual : No

Mandatory for Non-Individual : No

perm_address_state *

string

permanent Address State

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

perm_address_country *

string

permanent Address Country, One must follow Country Code for 2 digit country code

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

perm_address_pincode *

string

permanent Address Pincode

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

perm_poa_type *

string

permanent Poa Type, One must follow Address Type for code of Proof of address type.

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

perm_current_same *

enum

➔ permanent Current Same

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

Allowed: Y┃N

curr_address_line1

string

current Address Line1, mandatory if flag indicating current/ permanent address is same as correspondence address is 'N'

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

curr_address_line2

string

current Address Line2

Mandatory for Individual : No

Mandatory for Non-Individual : No

curr_address_line3

string

current Address Line3

Mandatory for Individual : No

Mandatory for Non-Individual : No

curr_address_city

string

current Address City. mandatory if flag indicating current/ permanent address is same as correspondence address is 'N'

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

curr_address_dist

string

current Address Dist

Mandatory for Individual : No

Mandatory for Non-Individual : No

curr_address_state

string

current Address State

Mandatory for Individual : No

Mandatory for Non-Individual : No

curr_address_country

string

current Address Country, One must follow Country code for 2 digit country code

mandatory if flag indicating current/ permanent address is same as correspondence address is 'N'

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

curr_address_pincode

string

current Address Pincode

Mandatory for Individual : No

Mandatory for Non-Individual : No

curr_poa_type

string

current Poa Type, One must follow Poa Type for code of Proof of address type.

mandatory if flag indicating current/ permanent address is same as correspondence address is 'N'

Mandatory for Individual : No

Mandatory for Non-Individual : No

res_tel_std_code

string

res Tel Std Code, If residence telephone No. (STD) code is provided, residence telephone number is mandatory and vice versa

Mandatory for Individual : No

Mandatory for Non-Individual : No

res_tel_no

string

res Tel No, If residence telephone No. (STD) code is provided, residence telephone number is mandatory and vice versa

Mandatory for Individual : No

Mandatory for Non-Individual : No

office_tel_std_code

string

office Tel StdCode, If office telephone No. (STD) code is provided, office telephone number is mandatory and vice versa

Mandatory for Individual : No

Mandatory for Non-Individual : No

office_tel_no

string

office Tel No., If office telephone No. (STD) code is provided, office telephone number is mandatory and vice versa

Mandatory for Individual : No

Mandatory for Non-Individual : No

mobile_isd_code

string

mobile Isd Code, If mobile telephone No. (ISD) code is provided, mobile telephone number is mandatory and vice versa

Mandatory for Individual : No

Mandatory for Non-Individual : No

mobile_no

string

mobile Number, '- If mobile telephone No. (ISD) code is provided, mobile telephone number is mandatory and vice versa

If prefix is '+91', then mobile number needs to be 10 digits. Else, any numerical value upto 20 digits is permissable

Mandatory for Individual : No

Mandatory for Non-Individual : No

string

Mandatory for Individual : No

Mandatory for Non-Individual : No

dec_date *

dd-MM-yyyy

dec Date

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

dec_place *

string

dec Place

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_date *

dd-MM-yyyy

kyc Date

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_document_type *

enum

➔ kyc Document Type.

Allowed Values:

01- Certified Copies

02 - E-KYC data received from UIDAI

03 - Data received from offline verification

04 - Digital KYC process

05 - Equivalent e-document

06- Video-based KYC

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

Allowed: 01┃02┃03┃04┃05┃06

kyc_name *

string

KYC Verification Name

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_desig *

string

KYC Verification Designation

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_branch *

string

KYC Verification Branch

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_emp_code *

string

KYC Verification EMP code

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_org_name *

string

KYC Organisation Name

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

kyc_org_code *

string

KYC Organisation Code

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

din

string

DIN (Director Identification Number)

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : Yes, if related person type is 'Director'

remarks

string

remarks

Mandatory for Individual : No

Mandatory for Non-Individual : No

other_desc

string

Related Person type Others Description

Mandatory for Individual : Not applicable

Mandatory for Non-Individual : yes, if related person type is others

- images*

object

images

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

photograph *

string

Photograph

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

poi_poa *

string

Proof of Identity/ Proof of Address

Mandatory for Individual : Yes

Mandatory for Non-Individual : Yes

curr_address_proof

string

Current Address Proof

mandatory if flag indicating current/ permanent address is same as correspondence address is 'N'

Mandatory for Individual : No

Mandatory for Non-Individual : No

image1 *

binary

Image filename with its extension(e.g., image1.JPG) in JPEG/JPG/TIFF or PDF format declared in image_details in register_ckyc_request.

image2 *

binary

Image filename with its extension(e.g., image2.JPEG) in JPEG/JPG/TIFF or PDF format declared in image_details in register_ckyc_request.

image3 *

binary

Image filename, with its extension (e.g., image3.JPG), in JPEG, JPG, TIFF, or PDF format. It must be declared under the images field within related_person_details, in the photograph/POI/POA/current address proof sections.

RESPONSE

application/json

Field

Type

Description

reference_id

string

Reference number of the CKYC sets while registering the request to CKYC.

message

string

Message being received from CKYC.

status

string

Mapped status according to the response we received from CKYC.

It can have below statuses:

UPLOAD_PENDING -> Upload of request to SFTP is pending
AWAITING_APPROVAL -> Request is pending to be approved from Checker
AWAITING_RESPONSE -> Request is successfully uploaded and awaiting for response from CKYC
APPROVED -> Request is approved from CKYC
REJECTED -> Request is rejected by CKYC
SUCCESS -> Request is successfully added/updated in CKYC
FAILURE -> Request failed out at CKYC's end