Skip to content

Commit ff5a69f

Browse files
committed
Add aadhar-pan-link documentation
1 parent 3822dcb commit ff5a69f

File tree

1 file changed

+68
-14
lines changed

1 file changed

+68
-14
lines changed

README.md

Lines changed: 68 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,16 @@ This documentation describes the validation API. The postman collection can be f
1919
- [DL Verification and Extraction](#dl-verification-and-extraction)
2020
- [VoterId Check](#voterId-check)
2121
- [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)
2324
- [Response Structure](#response-structure)
2425
- [Verify PAN](#verify-pan-1)
2526
- [PAN Name Fetch](#pan-name-fetch-1)
2627
- [DL Verification and Extraction](#dl-verification-and-extraction-1)
2728
- [VoterId Check](#voterId-check-1)
2829
- [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)
3032
- [Status Codes](#status-codes)
3133

3234

@@ -151,7 +153,23 @@ Please do not expose the appid and appkey on browser applications. In case of a
151153

152154
* **Request Body**
153155
* *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
155173

156174
## Request Structure
157175

@@ -190,14 +208,20 @@ Please do not expose the appid and appkey on browser applications. In case of a
190208
accountNumber: <required, String>
191209
}
192210
```
193-
### Verify Passport
211+
### Passport Verification
194212
```
195213
{
196214
fileNo: <required, String>,
197215
dob: <required, String>
198216
}
199217
```
200-
218+
### Aadhaar Pan Link Status
219+
```
220+
{
221+
aadhaarNumber: <required, String>,
222+
panNumber: <required, String>
223+
}
224+
```
201225
## Response Structure
202226

203227
### Verify PAN
@@ -428,8 +452,8 @@ Please do not expose the appid and appkey on browser applications. In case of a
428452
* Code: **200**
429453
* Incase of a successful validation, the response would have the following schema.
430454

431-
```
432-
{
455+
```
456+
{
433457
"status": "success",
434458
"statusCode": "200",
435459
"result": {
@@ -449,20 +473,48 @@ Please do not expose the appid and appkey on browser applications. In case of a
449473
"nameFromPassport": "OMKAR MILIND"
450474
},
451475
"typeOfApplication": "Tatkaal"
452-
}
476+
}
453477
}
454-
```
478+
```
455479

456480
* Error Responses:
457481

458482
* 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+
{
461485
"status": "failure",
462486
"statusCode": "422",
463487
"error": "Entered id is not found in any database"
464488
}
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+
```
466518

467519
#### Common Errors:
468520
* 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
498550
|Code|Description|
499551
|----|----|
500552
|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|
502553
|400|Invalid Input Format or Missing Input parameter. Please check your input to the API|
503554
|401|Unauthorized - Please contact HyperVerge|
555+
|404|Invalid Endpoint - Please check the API call|
556+
|422|Not found in DB or invalid input combination|
504557
|429|Rate Limit Exceeded - Please contact HyperVerge to increase rate limit|
505558
|500|Internal Server Error - Please retry|
506559
|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

Comments
 (0)