Skip to content

Commit c995513

Browse files
author
Yatin Gupta
committed
Update Match Field Req Structure and fix indent
1 parent f356ed1 commit c995513

File tree

1 file changed

+32
-33
lines changed

1 file changed

+32
-33
lines changed

README.md

Lines changed: 32 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ This documentation describes the validation API. The postman collection can be f
2121
- [Bank Account Verification](#bank-account-verification)
2222
- [Passport Verification](#passport-verification)
2323
- [Aadhaar Pan Link Status](#aadhaar-pan-link-status)
24-
- [Match Fields](#match-fields)
24+
- [Match Fields-Name](#match-fields-Name)
2525
- [Response Structure](#response-structure)
2626
- [Verify PAN](#verify-pan-1)
2727
- [PAN Name Fetch](#pan-name-fetch-1)
@@ -30,7 +30,7 @@ This documentation describes the validation API. The postman collection can be f
3030
- [Bank Account Verification](#bank-account-verification-1)
3131
- [Passport Verification](#passport-verification-1)
3232
- [Aadhaar Pan Link Status](#aadhaar-pan-link-status-1)
33-
- [Match Fields](#match-fields-1)
33+
- [Match Fields-Name-](#match-fields-Name-1)
3434
- [Status Codes](#status-codes)
3535

3636

@@ -176,7 +176,7 @@ Please do not expose the appid and appkey on browser applications. In case of a
176176
* *aadhaarNumber* : Aadhaar Number
177177
* *panNumber* : Pan Number
178178

179-
8) **Match Fields**
179+
8) **Match Fields-Name**
180180
* **URL**
181181
- /api/matchFields
182182

@@ -249,13 +249,14 @@ Please do not expose the appid and appkey on browser applications. In case of a
249249
}
250250
```
251251

252-
### Match Fields
252+
### Match Fields-Name
253253
```
254254
{
255-
name: <required, Object>,
256-
value1: <required, String>,
257-
value2: <required, String>,
258-
leniency: <String>
255+
name: <required, Object> {
256+
value1: <required, String>,
257+
value2: <required, String>,
258+
leniency: <String>
259+
}
259260
}
260261
261262
```
@@ -491,7 +492,7 @@ Please do not expose the appid and appkey on browser applications. In case of a
491492
* Incase of a successful validation, the response would have the following schema.
492493

493494
```
494-
{
495+
{
495496
"status": "success",
496497
"statusCode": "200",
497498
"result": {
@@ -511,20 +512,20 @@ Please do not expose the appid and appkey on browser applications. In case of a
511512
"nameFromPassport": "SAMPLE SAMPLE"
512513
},
513514
"typeOfApplication": "SAMPLE"
514-
}
515-
}
515+
}
516+
}
516517
```
517518

518519
* Error Responses:
519520

520521
* Incase the file Number or dob are incorrect, then following response will be sent with status code `422` and **result.status** `failure`
521-
```
522-
{
522+
```
523+
{
523524
"status": "failure",
524525
"statusCode": "422",
525526
"error": "Entered id is not found in any database"
526-
}
527-
```
527+
}
528+
```
528529

529530
### Aadhaar Pan Link Status
530531

@@ -534,42 +535,42 @@ Please do not expose the appid and appkey on browser applications. In case of a
534535
* Incase the Aadhaar and Pan are linked, the response would have the following schema.
535536

536537
```
537-
{
538+
{
538539
"status": "success",
539540
"statusCode": "200",
540541
"result": {
541542
"message": "Your PAN is linked to Aadhaar Number XXXX XXXX 2071."
543+
}
542544
}
543-
}
544545
```
545546
* Success Response:
546547

547548
* Code: **200**
548549
* Incase the Aadhar and Pan are not linked, the response would have the following schema.
549550

550551
```
551-
{
552+
{
552553
"status": "success",
553554
"statusCode": "200",
554555
"result": {
555556
"code": 535,
556557
"message": "Aadhar and Pan are not linked"
557558
}
558-
}
559+
}
559560
```
560561

561562
* Error Responses:
562563

563564
* Incase the aadhaar number and pan number are incorrect, then following response will be sent with status code `422` and **result.status** `failure`
564-
```
565-
{
565+
```
566+
{
566567
"status": "failure",
567568
"statusCode": "422",
568569
"error": "Invalid Pan or Aadhaar"
569-
}
570-
```
570+
}
571+
```
571572

572-
### Match Fields
573+
### Match Fields-Name
573574

574575
* Success Response:
575576

@@ -578,31 +579,29 @@ Please do not expose the appid and appkey on browser applications. In case of a
578579

579580

580581
```
581-
{
582+
{
582583
"status": "success",
583584
"statusCode": "200",
584585
"result": {
585586
"name": true,
586-
"all": true
587-
}
588-
}
589-
587+
"all": true
588+
}
589+
}
590590
```
591591
* Success Response:
592592

593593
* Code: **200**
594594
* Incase the two values are have low similiarity.
595595

596596
```
597-
{
597+
{
598598
"status": "success",
599599
"statusCode": "200",
600600
"result": {
601601
"name": false,
602-
"all": false
602+
"all": false
603603
}
604-
}
605-
604+
}
606605
```
607606

608607

0 commit comments

Comments
 (0)