Response Parameters
Sample Output Parameters:
<input type="hidden" name="param"
value="{"ClientID":"XXXXX",
"TrxnResNo":"20220322223637297_ShnZAVFj77z85hD805qyNcq0ZSzCQKDm",
"SessionID":"89e8e0b8590345488e8d77f410f733b7",
"Key":"cNJ/WtfFMo87RnYze/eMeKkds90IieAI12GSCW/dZBJaqAqc01ssQD+OSts63DUfjMpcP+V3pj9IrQlK9kz/Lr/1NROnE4NZviDJJw/a/vYPTXFPRCyaUOq+9zOZEjUUDb87/prFbCIm0uc4QAduFwnGg+nD7JpChs53aNUhWrdDIx3ERsMbW+ao0PrL60GFkHSnzkDhGTlIsWGMrnwZ+/powhA49+vJ9fTRYj2EY46pfFQJls1wGx5TgOBSn90LbJPHkgY4van3MNBZOthOTT7zp1TKNHm5biWWdOpXKCjmc1bO6vVodMOjFdJ1TZt4LWBB6wEd8S7ZOGJHs1BH+g==",
"Data":"K8GoXSn4RCux9UMg5Hz5fpDQWO+oRApS5rBIAhep93q+84tV1bk8OtHwy0/jLBvJGx1HXXmCmDrQN34ON28NaUW586P0YUwnsBVrBkM1RqyiZeEDpVXivSsvUiZHrUoN",
"Hash":"JU2BffYn3TG+7MWImgx+M6kXG+U++t5vckeDAuUQRxtF4Yxr4qFhw7smBs06Yzo7IVxUd1MVwB5aXtMhi1SIy+mWesrC2nY9IE0fkLhYFW8="}"
/>Response Parameters:
Field Name
Description
Type
Max Length
Required [Yes/ No]
ClientID
Client ID that was provided during the application registration process
String
100
Yes
SessionID
Client application identifier for the current session if any inputted
String
250
No
TrxnResNo
Application unique ID of current transaction
String
100
Yes
Key
RSA encrypted data of randomly generated AES IV and AES KEY using client public key
String
-
Yes
Data
Encrypted request data using AES algorithm
String
-
Yes
Hash
SHA 256 hash data of plain request data, further encrypted using AES algorithm
String
-
Yes
Sample Response:
Plain Response Data:
#
Field Name
Description
1
StatusCode
Response status code
String
100
Yes
2
StatusDecription
Response status description
String
100
Yes
3
DocumentType
Unique document type. Possible values are ADH, PAN, and DRV.
String
5
Yes
4
Document
Base64 content of fetched document
Base64 String
-
Yes
5
DocumentName
Name of the document as provided by DigiLocker
String
100
No
6
DOB
Date of birth of user in dd-MM-yyyy format
Date
10
No
7
Gender
Gender as per the issued document. Possible values are M – Male, F – Female, and T – Transgender
String
1
No
8
Name
Username as per the issued document
String
100
No
9
CareOf
Care of detail as per the issued document
String
100
No
10
Country
Country name of requested issued document
String
100
No
11
District
District name of requested issued document
String
100
No
12
House
House number as per issued document
String
100
No
13
Pincode
Pin code as per issued document
Number
6
No
14
State
State name as per issued document
String
100
No
15
Address1
Address 1 as per issued document if available
String
250
No
16
Address2
Address 2 as per issued document if available
String
250
No
17
VTC
Village town city name as per issued document
String
100
No
18
Photo
Base64 content of user photo.
Base64 String
-
No
19
Tittle
Salutation of the user available in issued document
String
100
No
20
MaritalStatus
Marital status as per issued document
String
100
No
21
Religion
Religion name as per issued document
String
100
No
22
Phone
Phone number as provided in incoming request
Number
10
No
23
Email ID as provided in incoming request
String
150
No
24
Landmark
Landmark as issued document if available
String
100
No
25
Locality
Locality as issued document if available
String
100
No
Sample Response:
Sample Success Response with Multiple Documents:
Sample Response Failure:
Response Status Code and Status Description:
If the request fails, corresponding status code will be returned along with the status description in the response parameter.
The following table lists the possible status codes:
#
Status Code
Status Description
1
CDL101
Client id or Client Secret is mandatory field.
2
CDL102
Client private key file name is empty.
3
CDL103
Client is inactive.
4
CDL104
Your password has expired.
5
CDL105
Encryption key is empty
6
CDL106
Encryption hash is empty.
7
CDL107
Encryption data is empty
8
CDL108
Signature verification failed
9
CDL109
Your request description failed
10
CDL110
User id or password is empty
11
CDL111
Invalid PAN
12
CDL112
Invalid mobile number
13
CDL113
Invalid email id
14
CDL114
Document type is empty
15
CDL115
User authentication failed
16
CDL116
Invalid Intermediary ID
17
CDL117
Invalid Document type
18
CDL118
We are experiencing technical issues at the moment with one or more of our partners. Please try again later. Regret inconvenience
19
CDL119
Failed to retrieve data.
20
CDL120
Invalid request
21
CDL200
Data Fetched successfully.
22
CDL202
No document is available for the input.
23
CDL500
Internal Error
Last updated