Request Parameters
The parameters that are going to be passed and their descriptions are given in the table below:
S. No
Parameter Name
Description
Max. Length
Data Type
Mandatory
1
APP_UPLOAD_TYPE
This field will contain Upload Type and cannot be null. For example ā Upload Type ā 01 (Only send data), Upload Type ā 02 (Only send document Images), Upload Type ā 03 (Send both the data and document Images).
2
string
Yes
2
APP_USER_ID
The authorized user id of the CAMSKRA system should be enabled to use the web services.
20
string
Yes
3
APP_PASSWORD
The encrypted password can be fetched by the user using the GetPassword Method of the web services.
50
string
Yes
4
APP_OTHER_KRA
Intermediary code
10
string
Yes
5
APP_PASSKEY
The key has to be used for encryption of the password.
string
Yes
6
APP_PAN
KYC verification PAN
10
string
Yes
7
APP_DOB
KYC Holder Date of Birth
15
string
Yes
8
APP_AMC
The AMC in which the investment is to be made
5
string
Yes
9
APP_IPV_DATE
In person verification Date
15
Yes
10
APP_UID_NO
Aadhaar number for KYC holder
20
string
No
11
APP_APPLICANT_TITLE
Honorific for KYC holder(Mr,Mrs,Miss,Dr)
10
string
Yes
12
APP_APPLICANT_F_NAME
KYC Holder's First Name
105
string
Yes
13
APP_APPLICANT_M_NAME
KYC Holder's Middle Name
105
string
No
14
APP_APPLICANT_L_NAME
KYC Holder's Last Name
105
string
No
15
APP_RELATIONSHIP
Relationship for KYC holder 1. F (Father) 2. S (Spouse)
1
string
Yes
16
APP_FATHER_TITLE
Honorific for Father/Spouse(Mr/Mrs)
10
string
Yes
17
APP_FATHER_F_NAME
KYC Holder's Father First Name
105
string
Yes
18
APP_FATHER_M_NAME
KYC Holder's Father Middle Name
105
string
No
19
APP_FATHER_L_NAME
KYC Holder's Father Last Name
105
string
No
20
APP_MOTHER_TITLE
Honorific for Mother(Mrs)
10
string
No
21
APP_MOTHER_F_NAME
KYC Holder's Mother First Name
105
string
No
22
APP_MOTHER_M_NAME
KYC Holder's Mother Middle Name
105
string
No
23
APP_MOTHER_L_NAME
KYC Holder's Mother Last Name
105
string
No
24
APP_MAIDEN_TITLE
Honorific for Maiden. This field is mandatory if the Gender is Female.(Miss)
10
string
No
25
APP_MAIDEN_F_NAME
KYC Holder's Maiden First Name.
105
string
No
26
APP_MAIDEN_M_NAME
KYC Holder's Maiden Middle Name
105
string
No
27
APP_MAIDEN_L_NAME
KYC Holder's Maiden Last Name
105
string
No
28
APP_GENDER
KYC Holder's Gender Type -- Refer master file
1
string
Yes
29
APP_MARITAL_STATUS
KYC Holder's Marital Status -- Refer master file
2
string
Yes
30
APP_OCCUPATION
KYC Holder's Occupation Type -- Refer master file
35
string
Yes
31
APP_APPLICANT_CITIZENSHIP
Citizenship of KYC Holder -- Refer master file
20
string
Yes
32
APP_APPLICANT_OTHER_CITIZEN
If KYC Holder is an Indian citizen this field can be null, otherwise this field is mandatory.- - Refer master file
20
string
No
33
APP_APPLICANT_STATUS
Applicant Status of KYC Holder. -- Refer master file
20
string
Yes
34
APP_ID_PROOF
ID proof of KYC holder -- Refer master file
10
string
Yes
35
APP_ID_PROOF_IDENTNO
Identification number of ID proof
20
string
Yes
36
APP_APPLICANT_KYCNO
KYC number of the KYC Holder .
14
Number
No
37
APP_APPLICANT_KYC_ACC_TYPE
KYC Account type of the KYC Holder -- Refer master file
2
string
Yes
38
APP_COMM_ADDR1
Communication Address1 of the KYC Holder
55
string
Yes
39
APP_COMM_ADDR2
Communication Address2 of the KYC Holder
55
string
No
40
APP_COMM_ADDR3
Communication Address3 of the KYC Holder
55
string
No
41
APP_COMM_PINCODE
Pincode of the Communication Address
10
string
Yes
42
APP_COMM_CITY
City name of the communication address
40
string
Yes
43
APP_COMM_DISTRICT
District name of the communication address
100
string
Yes
44
APP_COMM_STATE
State name of the communication address -- Refer master file
40
string
Yes
45
APP_COMM_COUNTRY
Country name of the communication address -- Refer master file
40
string
Yes
46
APP_COMM_TELL_NO_OFF_CODE
Telephone code of the office
5
Number
No
47
APP_COMM_TELL_NO_OFF
Telephone number of the office
10
Number
No
48
APP_COMM_TELL_NO_RES_CODE
Telephone code of the residence
5
Number
No
49
APP_COMM_TELL_NO_RES
Telephone number of the residence
10
Number
No
50
APP_COMM_MOBILE_NO_CODE
Country code of the Mobile phone
5
Number
Yes
51
APP_COMM_MOBILE_NO
Mobile number of the KYC Holder
10
Number
Yes
52
APP_COMM_FAX_CODE
Country code of the Fax number
5
Number
No
53
APP_COMM_FAX
Fax number of the KYC Holder
10
Number
No
54
APP_COMM_EMAIL_ID
Email ID of the KYC holder
100
string
Yes
55
APP_COMM_ADDR_TYPE
Address type of the KYC holder -- Refer master file
10
string
Yes
56
APP_COMM_ADDR_PROOF
Address proof for communication address -- Refer master file
10
string
Yes
57
APP_COMM_IDENT_NO
Identification number of the above mentioned Address Proof
20
string
Yes
58
APP_COMM_ADDR_PROOF_EXP_DATE
If expiry date is available for the address proof then this field is mandatory otherwise can be null.
15
string
No
59
APP_PER_ADDR1
Permanent address1 of the KYC holder
55
string
Yes
60
APP_PER_ADDR2
Permanent address2 of the KYC holder
55
string
No
61
APP_PER_ADDR3
Permanent address3 of the KYC holder
55
string
No
62
APP_PER_PINCODE
Pincode of the permanent address
10
string
Yes
63
APP_PER_CIT
City name of the permanent address
40
string
Yes
64
APP_PER_DISTRICT
District name of the for permanent address
100
string
Yes
65
APP_PER_STATE
State of the permanent address -- Refer master file
40
string
Yes
66
APP_PER_COUNTRY
Country of the permanent address -- Refer master file
40
string
Yes
67
APP_PER_ADDR_PROOF
Address proof for permanent address -- Refer master file
10
string
Yes
68
APP_PER_IDENT_NO
Identification number of the above mentioned Address Proof
20
string
Yes
69
APP_PER_ADDR_PROOF_EXP_DATE
If expiry date is available for the address proof then this field is mandatory otherwise can be null.
15
string
No
70
APP_FATCA_TAX_JURISDICTION
Residence for TAX purposes in jurisdiction(s) outside India?(Y/N)
1
string
Yes
71
APP_FATCA_COUNTRYOF_JURISDICTION
Country of Jurisdiction of residence. If the residence for TAX purposes in jurisdiction is outside India then this field is mandatory. - Refer master file
3
string
No
72
APP_FATCA_PLACE_BIRTH
Place of birth. If the residence for TAX purposes in jurisdiction is outside India then this field is mandatory.
40
string
No
73
APP_FATCA_COUNTRY_BIRTH
Country of birth. If the residence for TAX purposes in jurisdiction is outside India then this field is mandatory. - Refer master file
3
string
No
74
APP_FATCA_TIN
Taxpayer Identification Number for FATCA person. If the residence for TAX purposes in jurisdiction is outside India then this field is mandatory.
20
string
No
75
APP_FATCA_ADDR1
FATCA address1. If the residence for TAX purposes in jurisdiction is outside India then this field is mandatory.
120
string
No
76
APP_FATCA_ADDR2
FATCA address2
120
string
No
77
APP_FATCA_ADDR3
FATCA address3
120
string
No
78
APP_FATCA_PINCODE
Pincode for Fatca address. If the residence for TAX purposes in jurisdiction is outside India then this field is mandatory.
10
string
No
79
APP_FATCA_CITY
City of the Fatca address. If the residence for TAX purposes in jurisdiction is outside India then this field is mandatory.
40
string
No
80
APP_FATCA_DISTRICT
District of the Fatca address. If the residence for TAX purposes in jurisdiction is outside India then this field is mandatory.
100
string
No
81
APP_FATCA_STATE
State of the Fatca address. If the residence for TAX purposes in jurisdiction is outside India then this field is mandatory.
40
string
No
82
APP_FATCA_COUNTRY
Country of the fatca address. If the residence for TAX purposes in jurisdiction is outside India then this field is mandatory. - Refer master file
40
string
No
83
APP_FATCA_REL_PERSON
Related person?(Y/N)
1
string
Yes
84
APP_REL_PER_KYCNO
KYC number of the related person. If there is a related person then this field is mandatory.
14
string
No
85
APP_REL_PER_TITLE
Honorific of the Related person. If there is a related person then this field is mandatory.
10
string
No
86
APP_REL_F_NAME
First name of the related person. If there is a related person then this field is mandatory.
105
string
No
87
APP_REL_M_NAME
Middle name of the related person
105
string
No
88
APP_REL_L_NAME
Last name of the related person
105
string
No
89
APP_REL_PER_TYPE
Type of related person. If there is a related person then this field is mandatory. - Refer master file
1
string
No
90
APP_REL_PER_ADDR_TYPE
Proof of Identity of the related person. If there is a related person then this field is mandatory.- Refer master file
2
string
No
91
APP_REL_PER_ADDR_TYPE_EXP_DATE
If expiry date is available for the identity proof then this field is mandatory otherwise can be null.If there is a related person then this field is mandatory.
15
string
No
92
APP_REL_PER_IDENT_NO
Identification number of the above mentioned Identity Proof.If there is a related person then this field is mandatory.
20
string
No
93
APP_DOB_DECLARATION
Date of Declaration
15
string
Yes
94
APP_PLACE_DECLARATION
Place of Declaration
100
string
Yes
95
APP_EKYC_TYPE
I for Individual, N for Non-Individual
25
string
Yes
96
APP_DOC_PAN
Soft copy of KYC Holder's PAN document Mandatory for Upload Type ā 03
Base64 string
Yes
97
APP_DOC_ADDR_PROOF
Soft copy of KYC Holder's Address Proof Mandatory for Upload Type ā 03
Base64 string
Yes
98
APP_DOC_PHOTO
Soft copy of KYC Holder's Photo Mandatory for Upload Type ā 03
Base64 string
Yes
99
APP_DOC_CANCELLED_CHQ
Soft copy of KYC Holder's Canceled Cheque Mandatory for Upload Type ā 03
Base64 string
Yes
100
APP_DOC_SIGN
Soft copy of KYC Holder's Signature Mandatory for Upload Type ā 03
Base64 string
Yes
101
APP_DOC_PER_VER_VIDEO
For 30 seconds, KYC Holder must record the video in the following format. 1.For the first 10 seconds KYC Holder should record his ID Proof 2.For the next 10 seconds KYC Holder should record his Address proof 3. For the last 10 seconds KYC Holder should take his selfie. Mandatory for Upload Type ā 03
Base64 string
Yes
102
APP_IPV_EMP_NAME
In Person Verification Employee name
105
String
Yes
103
APP_IPV_EMP_CODE
In Person Verification Employee Code
20
String
Yes
104
APP_IPV_EMP_DESIGNATION
In person Verification Employee Designation
105
String
Yes
105
APP_IPV_EMP_BRANCH
In Person Verification Employee Branch
105
String
Yes
106
APP_IPV_INSTITUTION_CODE
In Person Verification Institution Code
105
String
Yes
107
APP_IPV_INSTITUTION_NAME
In Person Verification Institution Name
105
String
Yes
108
APP_IPV_DONE_BY
In person Verification Done BY
100
String
Yes
108
APP_KYC_DATE
Application Date
Date
Yes
109
APP_KYC_EMP_NAME
KYC Employee Name
105
String
Yes
110
APP_KYC_EMP_CODE
KYC Employee Code
20
String
Yes
111
APP_KYC_EMP_BRANCH
KYC Employee Branch
105
String
Yes
112
APP_KYC_EMP_DESIGNATION
KYC Employee Designation
105
String
Yes
113
APP_KYC_INSTITUTION_CODE
KYC Institution Code
105
String
Yes
114
APP_KYC_INSTITUTION_NAME
KYC Institution Name
105
String
Yes
115
APP_KRA_INFO
APP_KRA_INFO value to be eKYC-eIPV
20
String
Yes
116
APP_PAN_COPY
Pan number is available then APP_PAN_COPY value to be āYā else āNā
1
String
Yes
117
APP_EXMT_CAT
Pan number is exempted category then APP_EXMT_CAT value to be āYā else āNā
1
String
Yes
118
APP_DOC_ESIGN_FORM
Soft copy of KYC Holder's eSign Document Mandatory for Upload Type ā 03
Base64 string
Yes
119
APP_KYC_MODE
Allowed Values :- eKYC-OTP(For OTP cases), eKYC-IRIS, eKYC-BIO(For Biometric), eKYC-OVD, eKYC-Aadhaar_XML(For offline Aadhaar), DIGILOCKER. Otherwise the value to be sent as null.
30
String
No
120
KYC_TYPE
For eKYC-OTP =1, eKYC-BIO =2, eKYC-IRIS =2, eKYC-OVD =3, eKYC-Aadhaar_XML =4, DIGILOCKER=5 and rest of all the cases 3 should be sent which means Online KYC.
1
String
Yes
121
AADHAR_XML
Pass AADHAAR XML as Base64string format
Base64 string
Yes
122
AADHAR_PASSCODE
Passcode of AADHAAR XML
Base64 string
Yes
123
AADHAR_DIGIT
Last digit of Aadhaar number
1
Number
Yes
Proof of Documents:
Soft copy of KYC Holder's valid address document.
Soft copy of KYC Holder's valid identification document.
Soft copy of KYC Holder's Photo.
Soft copy of KYC Holder's canceled cheque document.
Soft copy of KYC Holder's signature.
KYC Holder's video.
Soft copy of KYC Holder's eSign Document
Note:
Document must be uploaded only in PNG, JPEG or tiff format and the size of the document should not be more than 3MB.
Uploaded video must be in webm format only and size of the video should not be more than 5MB.
Documents and video should be converted to base64string before uploading them.
In this API only post method will be allowed.
AADHAR_XML is mandatory if <KYC_TYPE> is 1, 2, 4, 5 and <APP_PER_ADDR_PROOF> is 31 or <APP_COMM_ADDR_PROOF> is 31.
API Request will be not accepted If <APP_PER_ADDR_PROOF> value is 31 or <APP_COMM_ADDR_PROOF> is 31 and <KYC_TYPE> value is other than 1, 2, 4, 5.
For <KYC_TYPE> is 3, AADHAAR PDF will be mandatory (Optional). Data should be passed through AADHAR_XML column with Base64string format.
Last updated