Upload/Update Details APINEW

Digi KYC
KRA
API Integration
Upload/Update Details API

The KRA upload details api can be used to upload/update details of an individual/business. Please note that as per the recent communication by CVL KRA, while PAN shall continue to serve as the unique identification number for all participants in the securities market, PAN will no longer be accepted as a Proof of Identity (POI) for KYC purposes.Effective August 01, 2025, CVL-KRA requires submission of an alternate valid POI document while filing KYC. This means that for Bulk/API uploads you need to pass -

pan_copy/ app_pan_copy field as "N"
app_exmt_id_proof should not be 01, you can pass 02 for UID No.

For API Base URL's, click here

Use object common_kra_registration_request instead of register_pan_request to use our new KRA API.

KRA registration

post {BASE_URL}/v3/client/kyc/kra/app/register

Call this API to register details into KRA.

REQUEST

REQUEST BODY application/json

Field

Type

Description

- common_kra_registration_request

object

Request for registering PAN using switch

uid_no

string

UID / Aadhaar No of the applicant in case of Individuals only. Value will be mandatory for E-KYC Transactions. Only Last 4 Digit is acceptable

pan_no

string

Pan Number

dob_date

string

Date of Birth for Individual Format to be used is dd/mm/yyyy 01/01/2011 31/07/2011

ipv_date

string

Date should not be greater than the current date. Date will be in dd/mm/yyyy format.

gender

string

GENDER of the applicant applicable to Individuals only. M → Male F → Female T → Transgender

martial_status

string

MARITAL STATUS 01 → Married 02 → Unmarried

occupation

string

OCCUPATION 01 Private Sector Service

02 Public Sector

03 Business

04 Professional

05 Agriculturist

06 Retired

07 Housewife

08 Student

09 Forex Dealer

10 Government Service

99 Others

mob_no

string

Mobile Number

fax_no

string

FAX Telephone Number

string

Personal Email Id

per_add1

string

Address line 1 of the applicant. (Character Limit - 55)

per_add2

string

Permanent Address line 2

per_add3

string

Permanent Address line 3

per_city

string

Permanent/Registered Address City

per_pincode

string

Permanent/Registered Address Pin Code - (10 digit alphanumeric in case of non-India locations only.)

per_state

string

Permanent/Registered Address State. Details to be entered if the code is 99.

per_country

string

Permanent/Registered Address Country.

per_district

string

Permanent District

per_add_proof

string

ADDRESS PROOF of Permanent/Foreign/Permanent Address Proof.

pan_copy

string

Pan copy if enclosed or not. (Y/N)

applicant_name

string

Name of the Individual / Entity Name in case of Non-Individuals

father_name

string

Name of the Father / Husband in case of Individual

applicant_citizenship

string

Applicant citizenship

applicant_other_citizen

string

Applicant other citizenship

comm_addr1

string

Communication Address line 1

comm_addr2

string

Communication Address line 2

comm_addr3

string

Communication Address line 3

comm_pincode

string

Communication Address Pincode

comm_city

string

Communication Address City

comm_state

string

Communication Address State

comm_country

string

Communication Address Country

comm_tell_no_off_code

string

Communication Telephone number office code

comm_tell_no_off

string

Communication Telephone number office

comm_tell_no_res_code

string

Communication Telephone Number Residential Code

comm_tell_no_res

string

Communication Telephone number resedential

comm_mobile_no_code

string

Communication mobile code

comm_addr_type

string

Communication Address Type

comm_addr_proof

string

Communication Address Prood

comm_ident_no

string

Communication Address Identity Number

per_ident_no

string

Permanent Identity Number

fatca_place_birth

string

FATCA Place of birth

fatca_country_birth

string

FATCA Country of birth

fatca_tin

string

FATCA TIN

application_type

string

Applicant's EKYC Type

ipv_emp_designation

string

IPV Employee designation

ipv_emp_name

string

IPV employee name

ipv_institution_name

string

IPV institution name

kyc_date

string

KYC Date

doc_esign_form

string

Document Esign form base64 string

kyc_mode

string

e-KYC is applicable only for New Individual KYC

0 Normal KYC

1 e-KYC with OTP (Applicable for New Individual only with UID No Mandatory)

2 e-KYC with Biometric (Applicable for New Individual only with UID No Mandatory)

3 Online Data Entry and IPV 4 Offline KYC - Aadhaar (Applicable for New Individual only with UID No Mandatory)

5 Digilocker (Applicable for New Individual only with UID No. Mandatory)

kyc_type

string

KYC Type

app_upload_type

string

Upload Type

app_amc

string

Application AMC

app_applicant_title

string

Applicant Title

app_relationship

string

Applicant Relationship

app_father_title

string

Application Father title

app_mother_title

string

Applicant's Mother Title

app_ipv_done_by

string

IPV Done by

app_mother_name

string

Applicant's Mother name

app_maiden_title

string

Applicant's Maiden Title

app_maiden_name

string

Applicant's Maiden Name

app_applicant_status

string

Applicant Status

app_id_proof

string

ID Proof

app_id_proof_identno

string

ID Proof Identity Number

app_applicant_kycno

string

Applicant KYC Number

app_ipv_institution_code

string

IPV institution code

app_applicant_kyc_acc_type

string

Applicant KYC Account Type

app_comm_district

string

Communication Address District

app_comm_fax_code

string

Communication Fax code

app_comm_addr_proof_exp_date

string

Communication Address Proof expiry date

app_per_addr_proof_exp_date

string

Permanent Address proof expiry date

app_fatca_tax_jurisdiction

string

Fatca TAX Jurisdiction

app_fatca_countryof_jurisdiction

string

FATCA TAX Country of jurisdiction

app_fatca_addr1

string

FATCA Address line 1

app_fatca_addr2

string

FATCA Address line 2

app_fatca_addr3

string

FATCA Address line 3

app_fatca_pincode

string

FATCA Pincode

app_fatca_city

string

FATCA Address City

app_fatca_district

string

FATCA Address district

app_fatca_state

string

FATCA Address state

app_fatca_rel_person

string

FATCA Relative person

app_rel_per_kycno

string

Relative person KYC Number

app_rel_per_title

string

Relative person title

relative_name

string

Relative first name

app_rel_per_type

string

Relative Person type

app_rel_per_addr_type

string

Relative person address type

app_rel_per_addr_type_exp_date

string

Relative person address type expiry date

app_rel_per_ident_no

string

Relative person Identification number

app_dob_declaration

string

Applicant's Date of birth declaration

app_place_declaration

string

Applicant's place declaration

app_doc_pan

string

Application Document PAN

app_doc_addr_proof

string

Document Address Proof

app_doc_photo

string

Document Photo

app_doc_cancelled_chq

string

Document Cancelled Cheque

app_doc_sign

string

Document Sign

app_doc_per_ver_video

string

Document Person Verified video

app_ipv_emp_code

string

IPV Employee code

app_ipv_emp_branch

string

IPV Employee branch

app_ipv_institution_name

string

IPV institution name

app_kyc_emp_name

string

KYC Employer Name

app_kyc_emp_code

string

KYC Employee Code

app_kyc_emp_branch

string

KYC Employee Branch

app_kyc_emp_designation

string

KYC Employee Designation

app_kyc_institution_code

string

KYC institution code

app_kyc_institution_name

string

KYC Insititution name

kra_info

string

KRA Information

aadhaar_passcode

string

Aadhaar Passcode

aadhaar_digit

string

Aadhaar Digital

app_source_doc

string

Source Doc

app_auth_qc_flag

string

Authentication QC Flag

app_ipv_emp_no

string

IPV Employee Number

app_fatca_country_residency1

string

FATCA Country Residency 1

app_fatca_tax_identification_no1

string

FATCA Tax Identification Number 1

app_fatca_tax_exempt_flag1

string

FATCA Tax Exempt Flag 1

app_fatca_tax_exempt_reason1

string

FATCA Tax Exempt Reason 1

app_fatca_country_residency2

string

FATCA Country Residency 2

app_fatca_tax_identification_no2

string

FATCA Tax Identification Number 2

app_fatca_tax_exempt_flag2

string

FATCA Tax Exempt Flag 2

app_fatca_tax_exempt_reason2

string

FATCA Tax Exempt Reason 2

app_fatca_country_residency3

string

FATCA Country Residency 3

app_fatca_tax_identification_no3

string

FATCA Tax Identification Number 3

app_fatca_tax_exempt_flag3

string

FATCA Tax Exempt Flag 3

app_fatca_tax_exempt_reason3

string

FATCA Tax Exempt Reason 3

app_fatca_country_residency4

string

FATCA Country Residency 4

app_fatca_tax_identification_no4

string

FATCA Tax Identification Number 4

app_fatca_tax_exempt_flag4

string

FATCA Tax Exempt Flag 4

app_fatca_tax_exempt_reason4

string

FATCA Tax Exempt Reason 4

app_req_type

string

Request Type

app_communication_address_doc

string

Base64 for communication address doc

app_ipv_doc_received

string

App IPV Doc Received

app_doc_source

string

App Doc Source

app_residential_status

string

App Residential Status

app_exmt_cat

string

Category under which person or entity is exempt. Mandatory if the PAN Exempt flag is Yes . Possible Values are below. 01 -> SIKKIM Resident 02 -> Transactions carried out on behalf of STATE GOVT 03 -> Transactions carried out on behalf of CENTRAL GOVT 04 -> COURT APPOINTED OFFICIALS 05 -> UN Entity/Multilateral agency exempt from paying tax in India 06 -> Official Liquidator 07 -> Court Receiver 08 -> SIP of Mutual Funds Upto Rs. 50,000/- p.a. 11 -> OTHER DOCUMENTS (Only allowed for Old Records)

update_flag

string

UPDATE TYPE -> Possible values 01 -> New 02 -> Modify with documents 03 -> Modify without documents 04 -> Dump 05 -> Suspended 06 -> Deceased 07 -> Old KYC Record 11 -> Old KYC Record Modification 99 -> Interop Modification

kra_code

string

CVLKRA → CVL KRA NDML → NDML KRA DOTEX → Dotex KRA CAMS → CAMS KRA KARVY → KARVY KRA BSE → BSE KRA

pos_code

string

RTA to update the POS code of the AMC on whose behalf they are updating the request. All other intermediaries to update their own POS code

app_no

string

Application Number

app_exmt

string

If a person or entity is exempt for PAN. (Y/N)

app_exmt_id_proof

string

IDENTITY PROOF Possible Values 01 -> PAN 02 -> UID NO. 03 -> Passport 04 -> Driving License 05 -> Voter Identity Card 06 -> ID Card with applicant's photo issued by Central / State Government and its Depts 07 -> ID Card with applicant's photo issued by Statutory / Regulatory Authorities 08 -> ID Card with applicant's photo issued by Public Sector Undertakings 09 -> ID Card with applicant's photo issued by Scheduled Commercial Banks 10 -> ID Card with applicant's photo issued by Public Financial Institutions 11 -> ID Card with applicant's photo issued by Colleges affiliated to universities 12 -> ID Card issued by Professional Bodies such as ICAI, ICWAI, ICSI, Bar Council, etc. to their Members 13 -> Credit Card with Photo of applicant issued by banks 16 -> OTHER ID PROOF (Only for old record)

ipv_flag

string

IN PERSON VERIFICATION FLAG:

Y → Yes

N → No

E → Exempted (Applicable for Online mode KYC and application completed with e-Sign)

reg_no

string

Registration Number of the Entity

dob_incorp

string

Date of Incorporation for Non-Individual. Format to be used is dd/mm/yyyy 01/01/2011 31/07/2011

commence_date

string

BUSINESS COMMENCEMENT DATE OF THE COMPANY. If same as date of Incorporation then the date should be the same.

nationality

string

NATIONALITY 01 -> Indian 02 -> Others

other_nationality

string

NATIONALITY details in case of others

comp_status

string

COMPANY TYPE

01 Private Ltd Company

02 Public Ltd Company

03 Body Corporate

04 Partnership

05 Trust / Charities / NGOs

06 FI

07 FII

08 HUF

09 AOP

10 Bank

11 Government Body

12 Non-Government Organization

13 Defense Establishment

14 Body of Individuals

15 Society

16 LLP

17 QFI

18 Eligible Foreign Investor - Category I

19 Eligible Foreign Investor - Category II

20 Eligible Foreign Investor - Category III

21 COMPANY

99 Others

oth_comp_status

string

Company Status, if "Others"

res_status_proof

string

NRI ADDRESS PROOF

01 → Passport

02 → PIO Card

03 → OCI Card

off_isd

string

Office ISD code

off_std

string

Office STD code

res_isd

string

Residential ISD

res_std

string

Residential STD

res_no

string

Residential Number

mob_isd

string

Mobile ISD

fax_isd

string

FAX ISD

fax_std

string

FAX STD

cor_add_date

string

Format to be used is dd/mm/yyyy 01/01/2011 31/07/2011

per_add_flag

string

PERMANENT ADDRESS PROOF DETAILS if same as Correspondence address or not. If the details are not the same then they should be captured. Y → Yes N → No

per_add_date

string

Format to be used is dd/mm/yyyy 01/01/2011 31/07/2011

income

string

GROSS ANNUAL INCOME

01 BELOW 1 LAC

02 1-5 LAC

03 5-10 LAC

04 10-25 LAC

05 > 25 LAC (Only for Individuals)

06 25 LAC - 1 CR (Available only for non-individuals)

07 > 1 CR (Available only for non-individuals)

other_occupation

string

Occupation Description, if OCCUPATIONAL DETAILS IS SET TO Others this field is mandatory.

pol_conn

string

PEP STATUS

NA → Not Applicable

RPEP → Related to Politically Exposed Person

PEP → Politically Exposed Person

doc_proof

string

DOCUMENT SUBMISSION DETAILS S → Self Certified Copies Submitted (Originals Verified) T → True Copies of Documents Received

internal_ref

string

Internal Reference No for Intermediaries to refer back

branch_code

string

Branch Code to which the KYC is attached to.

net_worth

string

Networth of the Entity (Only Numeric is allowed). This would be non-mandatory for Individuals and non-Individuals.

net_worth_date

string

Net Worth as on Date. This would be non-mandatory for individuals if the Gross Annual Income has been specified. However, if the Networth has been specified in case of non-individuals then the Networth Date is mandatory. Format to be used is dd/mm/yyyy 01/01/2011 31/07/2011

incorp_plc

string

Incorporation Place for Non-Individual

other_info

string

Any Other Information e.g “”MOBILE NUMBER , EMAIL ID”

acc_open_date

string

ACCOUNT OPENING DATE ( entry_date)

acc_active_date

string

ACCOUNT ACTIVATION DATE (status_date)

acc_update_date

string

ACCOUNT LAST UPDATE DATE (modification_date)

vid_no

string

VID (Aadhaar virtual id) of the applicant in case of Individuals only.

uid_token

string

UID Token received from UIDAI as part of the response for Aadhaar based transaction in case of Individuals only. Value will be mandatory for E-KYC Transactions

auth_name

string

FPI Authoriser Name

auth_email

string

FPI Authoriser Email Mandatory for Eligible Foreign Investor - Category II Eligible Foreign Investor - Category III

auth_email1

string

FPI Authoriser Email (additional)

auth_email2

string

FPI Authoriser Email (additional)

auth_mobile

string

FPI Authoriser Mobile

auth_fpi_consent

string

FPI Consent Flag Mandatory for Eligible Foreign Investor - Category II Eligible Foreign Investor - Category III Possible Values: Y → WITH CONSENT N → WITHOUT CONSENT

auth_ubo_consent

string

FPI UBO Flag Possible Values Y → WITH CONSENT N → WITHOUT CONSENT

mobile_flag

string

MOBILE VALIDATION (Y/N)

email_flag

string

EMAIL VALIDATION (Y/N)

otp_ref_no

string

OTP Reference Number

corr_district

string

Corresponding District

fatca_applicable

string

Possible Values - Y/N

app_fatca_date_declaration

string

Date Format - dd/mm/yyyy

- fatca_additional_details

array of object

List of FATCA details
⮕ [ List of FATCA details ]

app_fatca_entity_pan

string

Entity pan

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_fatca_country_residency

string

Country Residency

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_fatca_tax_identification_type

string

Tax identification Type

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_fatca_tax_identification_number

string

Tax identification number

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_fatca_tax_exempt_flag

string

Tax Exempt Flag

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_fatca_tax_exempt_reason

string

Tax exempt reason

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

- additional_details

array of object

List of Additional Details
⮕ [ List of Additional Details ]

app_addldata_updtflg

string

UPDATE TYPE

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : Yes

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_entity_pan

string

PAN No

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : Yes

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_addldata_pan

string

PAN No should be provided in absence of DIN

app_addldata_name

string

Name

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : Yes

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_addldata_din_uid

string

DIN/UID should be provided in absence of PAN

app_addldata_id_type

enum

➔ Type of ID No provided.

Allowed: UID┃DIN

app_addldata_relationship

string

RELATIONSHIP of the person to the entity

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : Yes

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_addldata_polconn

string

PEP STATUS

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_adddata_regdadd1

string

If Address line 1 of the applicant then all Add fields should be mandatory.

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : Yes

app_appdata_regdadd2

string

If user is providing the address line 2 details then the same should be recorded.

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_appdata_regdadd3

string

If user is providing the address line 3 details then the same should be recorded.

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : No

app_adddata_city

string

If Address is provided then Permanent/Registered Address City is Mandatory.

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : Yes

app_adddata_pincd

string

If Address is provided then Permanent/Registered Address Pin Code - (10 digit alphanumeric in case of non-India locations only.

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : Yes

app_adddata_state

string

If Address is provided then Permanent/Registered Address State. Details to be entered if the code is 99

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : Yes

app_adddata_country

string

If Address is provided then Permanent/Registered Address Country

Mandatory for Individual (NEW) : No

Mandatory for Non-Individual (NEW) : No

Mandatory for Individual (EXISTING) : No

Mandatory for Non-Individual (EXISTING) : Yes

app_addldata_filler1

string

app_addldata_filler2

string

app_addldata_filler3

string

kyc_document

string

PAN Card Copy (Base64 String) Or esigned pdf copy (Base64 String)

aadhaar_document

string

Aadhaar Copy (Base64 String)Mandatory for Individual (NEW) : Either aadhaar_document or xml_document has to be passed

Mandatory for Non-Individual (NEW) : Either aadhaar_document or xml_document has to be passed

Mandatory for Individual (EXISTING) : Either aadhaar_document or xml_document has to be passed

Mandatory for Non-Individual (EXISTING) : Either aadhaar_document or xml_document has to be passed

aadhaar_xml

string

Aadhaar XML

uidai_refno

string

Unique reference number provided by UIDAI

ubo_applicable

string

Indicates if UBO (Ultimate Beneficial Owner) information is applicable

ubo_date

string

Date when UBO details were recorded or became applicable

ubo_exempt_reason

string

Reason for exemption if UBO is not applicable

ubo_dod

string

Date of death for the Ultimate Beneficial Owner, if applicable

shp_applicable

string

Indicates if SHP (Significant Holder Person) information is applicable

shp_date

string

Date when SHP details were recorded or became applicable

shp_dod

string

Date of death for the Significant Holder Person, if applicable

bs_applicable

string

Indicates if BS (Beneficial Shareholder) information is applicable

bs_date1

string

Start date of the BS record period

bs_date2

string

End date of the BS record period

bs_dod

string

Date of death for the Beneficial Shareholder, if applicable

app_fatca_country

string

FATCA Address country. Specify country of 1st citizenship

Mandatory for Individual (NEW) : Yes

Mandatory for Non-Individual (NEW) : Yes

Mandatory for Individual (EXISTING) : Yes

Mandatory for Non-Individual (EXISTING) : Yes

non_individual_ubo

string

Non Individual UBO file

non_individual_shp

string

Non Individual Shareholding pattern file

non_individual_bs

string

Non Individual Business Structure file

unique_request_id

string

Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request.

api_request_type

enum

➔

Allowed: stateless┃workflow┃stateless_async

service_provider

enum

➔ kra service provider

Allowed: NDML┃CDSL┃CAMS

kra_providers

enum

➔ list of kra provider (CAMS and CDSL allowed)

Allowed: NDML┃CDSL┃CAMS

REQUEST HEADERS

X_REFERENCE_ID

string

RESPONSE

application/json

Field

Type

Description

serviceProvider

enum

➔ response service

Allowed: NDML┃CDSL┃CAMS

requestId

string

request id for traceability of request

panNumber

string

Pan Number

dateOfBirth

string

Date Of Birth

name

string

Name of customer

status

string

Digio status code

remarks

string

Remarks

kraStatusCode

string

Status Code from KRA

ack

string

Acknowledgement from KRA

statusDescription

string

Digio status description

kraStatusDescription

string

Status Description Of KRA

kraEntryDate

string

Entry date for PAN

kraPosCode

string

KRA Pos Code

responseDate

string

KRA response date

totalRecordsCount

string

Number of KYC records available with KRA

- error

object

errorMessage

string

Error Message

errorCode

string

error code

- additionalErrors

array of object

columnName

string

errorMessage

string

documentUploadStatus

enum

➔

Allowed: DOCUMENT_PENDING┃UPLOAD_PENDING┃UPLOAD_SUCCESS┃UPLOAD_FAILED

queuedForRetry

boolean