@@ -19,14 +19,16 @@ This documentation describes the validation API. The postman collection can be f
19
19
- [DL Verification and Extraction](#dl-verification-and-extraction)
20
20
- [VoterId Check](#voterId-check)
21
21
- [Bank Account Verification](#bank-account-verification)
22
- - [Passport Verification](#verify-passport)
22
+ - [Passport Verification](#passport-verification)
23
+ - [Aadhaar Pan Link Status](#aadhaar-pan-link-status)
23
24
- [Response Structure](#response-structure)
24
25
- [Verify PAN](#verify-pan-1)
25
26
- [PAN Name Fetch](#pan-name-fetch-1)
26
27
- [DL Verification and Extraction](#dl-verification-and-extraction-1)
27
28
- [VoterId Check](#voterId-check-1)
28
29
- [Bank Account Verification](#bank-account-verification-1)
29
- - [Passport Verification](#verify-passport-1)
30
+ - [Passport Verification](#passport-verification-1)
31
+ - [Aadhaar Pan Link Status](#aadhaar-pan-link-status-1)
30
32
- [Status Codes](#status-codes)
31
33
32
34
@@ -151,7 +153,23 @@ Please do not expose the appid and appkey on browser applications. In case of a
151
153
152
154
* **Request Body**
153
155
* *fileNo* : The Passport Reference File Number
154
- * *dob* : Date of Birth as mentioned in the
156
+ * *dob* : Date of Birth
157
+
158
+ 7 ) ** Aadhaar Pan Link Status**
159
+ * ** URL**
160
+ - /api/verifyAadhaarPanLink
161
+
162
+ * **Method**
163
+ `POST`
164
+
165
+ * **Header**
166
+ * content-type : application/json
167
+ * appId
168
+ * appKey
169
+
170
+ * **Request Body**
171
+ * *aadhaarNumber* : Aadhaar Number
172
+ * *panNumber* : Pan Number
155
173
156
174
## Request Structure
157
175
@@ -190,14 +208,20 @@ Please do not expose the appid and appkey on browser applications. In case of a
190
208
accountNumber: <required, String>
191
209
}
192
210
```
193
- ### Verify Passport
211
+ ### Passport Verification
194
212
```
195
213
{
196
214
fileNo: <required, String>,
197
215
dob: <required, String>
198
216
}
199
217
```
200
-
218
+ ### Aadhaar Pan Link Status
219
+ ```
220
+ {
221
+ aadhaarNumber: <required, String>,
222
+ panNumber: <required, String>
223
+ }
224
+ ```
201
225
## Response Structure
202
226
203
227
### Verify PAN
@@ -428,8 +452,8 @@ Please do not expose the appid and appkey on browser applications. In case of a
428
452
* Code: **200**
429
453
* Incase of a successful validation, the response would have the following schema.
430
454
431
- ```
432
- {
455
+ ```
456
+ {
433
457
"status": "success",
434
458
"statusCode": "200",
435
459
"result": {
@@ -449,20 +473,48 @@ Please do not expose the appid and appkey on browser applications. In case of a
449
473
"nameFromPassport": "OMKAR MILIND"
450
474
},
451
475
"typeOfApplication": "Tatkaal"
452
- }
476
+ }
453
477
}
454
- ```
478
+ ```
455
479
456
480
* Error Responses:
457
481
458
482
* Incase the file Number or dob are incorrect, then following response will be sent with status code `422` and **result.status** `failure`
459
- ```
460
- {
483
+ ```
484
+ {
461
485
"status": "failure",
462
486
"statusCode": "422",
463
487
"error": "Entered id is not found in any database"
464
488
}
465
- ```
489
+ ```
490
+
491
+ ### Aadhaar Pan Link Status
492
+
493
+ * Success Response:
494
+
495
+ * Code: **200**
496
+ * Incase of a successful validation, the response would have the following schema.
497
+
498
+ ```
499
+ {
500
+ "status": "success",
501
+ "statusCode": "200",
502
+ "result": {
503
+ "message": "Your PAN is linked to Aadhaar Number XXXX XXXX 2071."
504
+ }
505
+ }
506
+ ```
507
+
508
+ * Error Responses:
509
+
510
+ * Incase the aadhaar number and pan number are incorrect, then following response will be sent with status code `422` and **result.status** `failure`
511
+ ```
512
+ {
513
+ "status": "failure",
514
+ "statusCode": "422",
515
+ "error": "Invalid Pan or Aadhaar"
516
+ }
517
+ ```
466
518
467
519
#### Common Errors:
468
520
* Incase the format of input is incorrect, the following response will be sent status code ` 400 `
@@ -498,10 +550,12 @@ The following are the various error codes
498
550
|Code|Description|
499
551
|----|----|
500
552
|200|Success - Data was present in DB and the necessary details have been returned in the body|
501
- |422|Not found in DB or invalid input combination|
502
553
|400|Invalid Input Format or Missing Input parameter. Please check your input to the API|
503
554
|401|Unauthorized - Please contact HyperVerge|
555
+ |404|Invalid Endpoint - Please check the API call|
556
+ |422|Not found in DB or invalid input combination|
504
557
|429|Rate Limit Exceeded - Please contact HyperVerge to increase rate limit|
505
558
|500|Internal Server Error - Please retry|
506
559
|503|Source not Available - Please retry after some time|
507
- |404|Invalid Endpoint - Please check the API call|
560
+ |504|Issue with the external service|
561
+
0 commit comments