Digitap KYC & Asset Validation API Suite- API Doc_v1.73_29Feb2024

Digitap.
ai KYC & Asset

Validation API Suite
API Doc & Integration Guide
(Version 1.73, 29th Feb 2024)
A jumpstart guide to boosting your Business
Save Time, Save Cost
1
Table of Contents
1 Introduction 6
1.1 Validation API Suite Introduction 6
2 API Documentation 6
2.1 Introduction 6
2.2 Authentication 7
2.3 API Request & Response Format 7
2.4 HTTP Status/Response Codes and its response body format 7
2.4.1 Error Messages 8
2.5 API Result 9
2.6 Additional Notes 9
3 KYC - PAN Basic Validation API (V1) [DEPRECATED] 10
3.1 API Introduction 10
3.2 API URL 10
3.3 API Request 10
3.4 API Success Response 12
3.4.1 Successful Validation (result_code 101) Case 12
3.4.2 Unsuccessful Validation Cases 13
3.5 API Error Response 14
4 KYC - PAN Basic Validation API (V2) 14
4.2 API URL 14
4.3 API Request 15
5 KYC - PAN Advanced Validation API [DEPRECATED] 19
5.2 API URL 20
5.3 API Request 20
6 KYC - PAN Details Validation API 24
6.2 API URL 24
6.3 API Request 24
2
7 KYC - Form 206AB Compliance Status Validation API 37
7.2 API URL 37
7.3 API Request 37
8 KYC - PAN to F’Name Validation API 39
8.2 API URL 40
8.3 API Request 40
9 KYC - VoterID Validation API 42
9.2 API URL 42
9.3 API Request 42
9.4.2 Unsuccessful Validation Case 46
10 KYC - Passport Validation API 46
10.2 API URL 47
10.3 API Request 47
10.4.1 Successful Validation (result_code 101) Case & Application Rejected (result_code
108) Case 48
11 KYC - Aadhaar Advanced Validation API 50
11.2 API URL 50
11.3 API Request 50
3
12 KYC - Aadhaar Basic Validation API 53
12.2 API URL 53
12.3 API Request 54
13 KYC - PAN AADHAAR Link Validation API 56
13.2 API URL 56
13.3 API Request 56
14 KYC - PAN to Masked AADHAAR Validation API 60
14.2 API URL 60
14.3 API Request 60
15 KYC - AADHAAR to Masked PAN Validation API 62
15.2 API URL 62
15.3 API Request 63
16 KYC - Driving License Validation API 66
16.2 API URL 66
16.3 API Request 66
4
17 ASSET - Vehicle RC Validation API 71
17.2 API URL 71
17.3 API Request 72
5
1 Introduction
This document is intended for our enterprise partners who can easily integrate the services they
have chosen with Digitap.ai. Using this document they can jumpstart their business processes
and start using the Digitap.ai services as early as possible and also align their own business
processes seamlessly by integrating and making changes to their backend.
1.1 Validation API Suite Introduction

Digitap.ai Validation API Suite provides APIs to validate the KYC details of individual customers
assets validation like Vehicle RC, Mobile Validation, Bank Validation and Other Misc Utilities:
❏ KYC (Know Your Customer) Validation
❏ PAN Related:
❏ PAN Details:
❏ PAN Details Validation
❏ PAN Details Validation (Backward Compatability)
❏ PAN Basic Validation V1 (Deprecated)
❏ PAN Basic Validation V2
❏ PAN Advance Validation (Deprecated)
❏ PAN to F’Name
❏ PAN to Masked Aadhaar Validation
❏ PAN Aadhaar Link Validation
❏ Aadhaar Related
❏ Aadhaar Number Validation
❏ Aadhaar Basic Validation
❏ Aadhaar to Masked PAN
❏ Form 206AB Compliance Status Validation
❏ Voter ID Validation
❏ Passport Validation
❏ Driving Licence Validation
❏ Asset Validation
❏ Vehicle RC Validation
Note: Digitap.ai reserves the right to modify this API documentation from time-to-time. If you are
a business using this Service, you will be notified well in advance, prior to any impactful change
being made.
2 API Documentation
2.1 Introduction
Digitap.ai Validation Suite provides RESTFul/standard HTTP Web APIs which help to validate a
specific data point by providing the response synchronously in the same API Call. The API uses
the standard HTTP status/response codes to indicate the success or API errors.
6
2.2 Authentication
To use API, one needs to register with Digitap and get a client id & client secret key. The client
ID & secret key are different for the UAT & production environment.
2.3 API Request & Response Format

● Both the input request and response follow the JSON format.
● In each APIs input, a client reference number is accepted to easily identify the given
request from a client and the same is also mirrored in the output. The other parameters
required in the input and their format are explained in specific APIs.
● The API error is normally returned as standard HTTP Status/Response Codes and also
mirrored in the body of the response.
● When the API request is accepted, HTTP status code 200 is returned and whether the
validation is successful or not is returned in the result_code. The various possible values
of the validation is explained under the section “API Result”
● In all the responses, an unique request-id (unique UUID) would be returned, which can
be used for easier debugging in the future. Clients are requested to provide this
request-id when raising an issue or discussing the response.
2.4 HTTP Status/Response Codes and its response body format

The API Error Codes are returned as HTTP Status Codes. Following status codes would be
returned by the APIs.
Code Message Description
200 OK Request Successful

(Note: 200 does not mean that Validation is
success, but indicates that the request is
successful. result_code in the Response
body indicates whether the validation is
successful or not).
400 One or more parameters format Input parameter passed by the customer is
is wrong missing or invalid
401 Client Authentication failed Access to API is denied
500 Internal Error Internal Server Error identified through its

number
7
503 Website is in maintenance The source for authentication is down for
maintenance or inaccessible.
504 Endpoint request Timed out The response latency from the source for
authentication is >30sec.
Format of the response body for successful request case (http Status code 200) is like below:
{
"http_response_code": 200,
"client _ref_num": “abcd123”,
"request_id": "97a9f2ce-cd70-11ea-ba26-4ef9447da577",
“result_code”:nnn,
// Optional items based on result_code

“result”:nnn,
“message”:”yyy”,
}
Format of the response body for failure cases (http Status code other than 200) is like below:
{
"http_response_code": nnn,
"error": “xxxx
}
2.4.1 Error Messages

Error messages for each of the failure cases is given below:
Code Error Message
400 One or more parameters format is wrong or missing
401 Client Authentication Failed
500 Internal Error 1/2/3
503 Website is in maintenance
504 Endpoint request Timed out
8
Please see the respective APIs for any additional details.
2.5 API Result

When the API returns HTTP status code 200/OK, the API request is accepted and result of the
request is provided in the key called “result_code” in the response body:
{
"client _ref_num": “abcd123”
"result_code": nnn,
}
Various possible values of result_code and is tabled below:
result_code Description
101 Validation Successful
102 Invalid id number or combination of inputs
103 No record found for the given input
104 Source failed to respond with proper details
105 Unexpected Response from source
106 Multiple records exists
108 If the user’s application is rejected
Please see the respective APIs for details of which result code occurs in the specific API.
2.6 Additional Notes

● API will be billable for any successful responses with http response code 200
irrespective of result code.
9
3 KYC - PAN Basic Validation API (V1)
[DEPRECATED]
Note: This API will be deprecated by March 31st
3.1 API Introduction

This API helps to validate the basic details of PAN card Holder - PAN Number and Name of the
PAN Card Holder. This API returns a success response if the PAN exists in the NSDL database
and returns the Status of PAN (Active/Invalid) and the name is matched exactly as per request
data.
Note: Because of the source level changes, this API is being deprecated.
3.2 API URL

Following are the URLs for UAT & production Environment.
UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/pan_basic
Production Env https://svc.digitap.ai/validation/kyc/v1/pan_basic
3.3 API Request

● Method: POST
● Header:
Key Mandatory/Optional Value

(M/O)
content-type M JSON/application
authorization M Type: Basic Auth, Username:client_id,

password:client_secret
/
BasicBase64encodedValueOf
(client_id:client_secret)
● Request Body:
Key Mandatory/ Value

Optional
(M/O)
client_ref_num M Unique ID for the OCR request from the Client side
[Max of 45 chars]
10
pan M PAN Number to be authenticated
minLength: 10
maxLength: 10
Pattern:
^([a-zA-Z]{3})([abcfghljpteABCFGHLJPTE]{1})([a-z
A-Z]{1})([0-9]{4})([a-zA-Z]{1})$
name O Exact name as per PAN
minLength: 1
maxLength: 150
name_match_method O Either `fuzzy` or èxact` or `dg_name_match`.
Default: `fuzzy`
èxact` - Exact Word Name Match (See Notes for

more details)
`fuzzy` - Rule engine based Fuzzy matching (V1

of PAN name match)
`dg_name_match` - Name Matching as per the

Digitap’s Name Matching Utility (V2 of PAN Name
Match)
Note:
● exact name match method:
○ Exact Name match method gives name_match as true and name_match_score
as 100 if it satisfies one of the below condition:
■ Input Name = PAN NAME
■ Input Name = PAN DISPLAY NAME
■ if there are two words in Input Name, Input Name (Words Reversed) =
PAN NAME
○ Otherwise, it gives name_match as false and name_match_score as 0
● fuzzy name match method:
○ Fuzzy name method uses fuzzy name matching techniques on both PAN name
and display name (like full & partial token sort & set ratios) combined with a rule
engine to give a better name match.
● dg_name_match name match method:
○ Digitap Name Matching utility is a separate utility provided by Digitap for name
match purposes. It is similar to that of the “fuzzy” name method, but with more
capabilities (like handling abbreviations like Mohd, MD, Salutations like Mr, ) and
enhancements (like handling missing common surnames like bhai, rao).
○ dg_name_match method uses the Digitap’s Name Matching Utility on both the
PAN Name and Display Name, and gives the best result among them.
11
3.4 API Success Response
3.4.1 Successful Validation (result_code 101) Case

When the PAN details are matched, result_code 101 would be returned. The response format
for the same is as follows:
{
"result_code": 101,
"result": {
"pan":"DQEPJ7722Q",
"status":"Active",
"name":"JOHN DOE",
"pan_display_name":"JOHN DOE",
"name_match":true,
"name_match_score":100
}
}
Keys of Result Object are explained below:
Key Type Value
status string Status of the PAN (Active / Invalid)
name string Name of PAN card holder (as per NSDL database)
pan_display_name string Name Printed on the PAN Card. (See the note below
to understand more about pan_display_name)
If there is no pan_display_name or if the source

does not provide this data, then this field would be
empty.
name_match boolean Name match result based on

name_matching_method - true or false.
name_match_score integer Name matching score based on the

name_match_method.
.
Values range from 0 - 100
For fuzzy and dg_name_match method, the score

will be from 0 to 100 based on the match.
12
For the exact method, the score will be either 0 or
100.
Note:
● pan_display_name:
○ PAN provides the customization option of printing the PAN card with a small
change (like changing the order of the words in the name, abbreviating the name
with initials,etc). For e.g. for one person, the full name is “DEVARAJAN
CHANDRA PRAKASH” and the name that is printed on the PAN card is
“CHANDRA PRAKASH D”.
○ Display name comes only for a few PAN numbers from the source and not for all
PAN cards even if the printed name is customised.
● If no name is provided in the input, then name_match would be false and

name_match_score would be 0.
3.4.2 Unsuccessful Validation Cases

The following response would be provided in case if the PAN could not be validated
1. If the given PAN number is Invalid (Deactivated, Deleted, Fake, Inoperative, etc), then the below
response would be provided.
{
"result_code": 102,
"message": "Invalid ID number or combination of inputs",
"result": {
"pan":"DQEPJ7722Q",
"status":"Invalid",
"name":"",
"pan_display_name":"",
"name_match":false,
}
}
2. If the given PAN number is Invalid (Not Allocated), then the below response would be provided.
13
{
"result_code": 103,
"message": "No record found for the given input",
"result": {
"pan":"DQEPJ7722Q",
"status":"Invalid",
"name":"",
"name_match":false,
}
}
3.5 API Error Response

1. If input parameters are wrong, then the below response would be provided.
{
"error": "One or more parameters format is wrong or missing"
}
In case of Error, the response as explained in the Section 2.5 and error messages as defined in
the Section 2.5.1 Error Messages would be returned.
4 KYC - PAN Basic Validation API (V2)

This API helps to validate the PAN Status along with basic details of PAN card Holder - PAN
Number and Name of the PAN Card Holder, Name on Card, DOB. This API provides the status
of the PAN along with Match Details of Name, Name on Card & DOB and Aadhaar Seeding
Status.
4.2 API URL

UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v2/pan_basic
Production Env https://svc.digitap.ai/validation/kyc/v2/pan_basic
14
4.3 API Request
● Method: POST
● Header:

(M/O)

/
● Request Body:

Optional
(M/O)
[Max of 45 chars]

minLength: 10
maxLength: 10
Pattern:
A-Z]{1})([0-9]{4})([a-zA-Z]{1})$
first_name O PAN Holder’s First Name

maxLength: 25
middle_name O PAN Holder’s Middle Name

maxLength: 25
last_name M PAN Holder’s Last Name

maxLength: 75
name_on_card M Name on PAN Card. It cannot be empty.

maxLength: 85
dob M Date of Birth in the format (DD/MM/YYYY) and it

should be separated with slash (/).
Length: 10
15
Please note that format of D/M/YYYY is not
accepted (like 2/9/1992 is not accepted, it should
be 02/09/1992).

{
"result_code": 101,
"result": {
"pan":"DQEPJ7722Q",
"status":"Active",
"status_code":"E",
"name":"Y",
"pan_display_name":"Y",
"dob":"Y",
"aadhaar_seeding_status":"Y"
}
}
Key Type Value
pan string User PAN Number
status string PAN Status whether Active or Invalid.
“Active” is given when the status code is “E” and

“invalid” is given for all other status_code.
status_code string PAN verification status are below :
“E”- EXISTING AND VALID,

"F" - Marked as Fake
"X" - Marked as Deactivated
"D" - Deleted
"N" - Record (PAN) Not Found in ITD Data-

base/Invalid PAN
"EA" - Existing and Valid but event marked as
16
“Amalgamation” in ITD database
"EC" - Existing and Valid but event marked as
“Acquisition” in ITD database
"ED" - Existing and Valid but event marked as
“Death” in ITD database
"EI" - Existing and Valid but event marked as
“Dissolution” in ITD database
"EL" - Existing and Valid but event marked as
“Liquidated” in ITD database
"EM" - Existing and Valid but event marked as
“Merger” in ITD database
"EP" - Existing and Valid but event marked as
“Partition” in ITD database
"ES" - Existing and Valid but event marked as
“Split” in ITD database
"EU" - Existing and Valid but event marked as
“Under Liquidation” in ITD database
name string Name Match Status (match between the Input

Name(first_name+middle_name+last_name) and
Government Database Name).
Possible values are Y/N/[Empty String].
Y – YES (If matched with Database)

N - NO (If not matched with Database)
Y/N is given when status_code is E or E along with

the event (EA, EC,etc).
For others, this field would be an empty string.
Match Method is exact match.
pan_display_name string “Name on Card” Match Status.(match between the

Input name_on_card and Government Database
PAN display name).
Possible values are Y/N/NA/[Empty String].
Y – YES (If matched with database)

N - NO (If not matched with database)
NA - Not Available (If not present in database)
Y/N/NA is given when status_code is E or E along

with the event (EA, EC,etc).
Match Method is exact match.
17
dob string Date of Birth Match Status.(match between the Input
dob and Government Database dob value).
Possible values are Y/N/[Empty String].
Y – YES (If matched with database)

N - NO (If not matched with database)
Y/N is given when status_code is E or E along with

the event (EA, EC,etc).
aadhaar_seeding_st string Aadhaar Seeding Status.

atus
Possible values are Y/R/NA/[Empty String].
Y – Operative PAN
R - Inoperative PAN
NA -For all non-Individual PANs
Y/R is given for individual PANs (fourth letter is P)

with status_code is E or E along with the event (EA,
EC,etc) and NA is given for all Non-Individual PANs
with status_code is E or E along with the event (EA,
EC,etc).

1. If the given PAN number has become Invalid (like Deactivated, Deleted, Fake,
Inoperative, Existing but marked as Death, etc), then the below response would be
provided.
{
"result_code": 102,
"message": "Invalid ID number or combination of inputs",
"result": {
"pan":"DQEPJ7722Q",
"status":"Invalid",
"status_code":"D",
"name":"",
"dob":"",
"aadhaar_seeding_status":""
}
18
}
Note: Above is the result for an deleted PAN. status_code would change for other cases.
2. If the given PAN number is Not Allotted PAN Number, then the below response would be
provided.
{
"result_code": 103,
"result": {
"pan":"DQEPJ7722Q",
"status":"Invalid",
"status_code":"N",
"name":"",
"dob":"",
"aadhaar_seeding_status":""
}
}

1. If input parameters are wrong, then the below response would be provided.
{
"error": "One or more parameters format is wrong.<Error Message>"
}
5 KYC - PAN Advanced Validation API

[DEPRECATED]

This API helps to validate all the details of PAN card Holder - PAN Number, Date of Birth and
Name of the PAN Card Holder. Along with this API also gives detailed information related to
PAN card (Ref 4.3.1). This API returns PAN & DOB are match status and returns the Status of
19
PAN (Active/Inactive/Duplicate) and the name is matched as per input or not and also the
detailed information like pan display name, first name, middle name, last name, PAN status
code,PAN aadhaar seeding status etc(Ref 4.3.1).
Note: Currently, this API validates only the Individual PAN Details (i.e. the fourth letter of PAN
Number is ‘P’). If any other type of PAN needs to be validated, please discuss with the Business
Team.
Note: Because of the source level changes, this API is being deprecated.
5.2 API URL

UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/pan
Production Env https://svc.digitap.ai/validation/kyc/v1/pan
5.3 API Request

● Method: POST
● Header:

(M/O)

/
● Request Body:

Optional
(M/O)
[Max of 45 chars]

minLength: 10
maxLength: 10
20
Pattern:
^[A-Za-z]{3}[pP]{1}[A-Za-z]{1}\d{4}[A-Za-z]{1}$
Note: PAN number should be individual PAN -

(i.e. the fourth letter of PAN Number is ‘P’)
name M Exact name as per PAN

minLength: 1
maxLength: 150
dob M Date of birth as per PAN

Format:
● DD/MM/YYYY
● D/MM/YYYY
● DD/M/YYYY

{
"result_code": "101",
"result": {
"status": "Active",
"name_match": true,
"dob_match": true,
"first_name":”XXX”,
"middle_name":”YYY”,
"last_name":”ZZZ”,
"display_name":”XXX YYY ZZZ”,
"pan_status_code": E,
"pan_title":”abc”,
"pan_last_update_date":”DD/MM/YYYY”,
“name_match_score” : 0.8,
"pan_aadhaar_seeding_status": Y
},
}
Key Value
status Status of the PAN (Active/Inactive/Duplicate)
21
name_match Whether the given name matches with the ITD Records. It
would have one of the following values:
true - name is exactly matching with ITD Records
false - name is NOT exactly matching with ITD Records
null - name match not done (See Note 1 Below)
dob_match Whether the given date of birth matches with the ITD
Records:
true - dob is matching with ITD Records

false - dob is NOT matching with ITD Records
null - dob match not done (See Note 1 Below)
first_name First name of the applicant as per ITD records
middle_name Middle name of the applicant as per ITD records
last_name Last name of the applicant as per ITD records
display_name Name displayed on the physical card
pan_status_code Status codes are explained in below table(if available)
pan_title Salutation
pan_last_update_date PAN records last update date as per ITD records
name_match_score Fuzzy score match for input name and name as per ITD
records(float)
pan_aadhaar_seeding PAN - Aadhaar linking status

_status Note: Status codes are explained in below table
PAN Status Description Status Code
Existing and Valid E
Existing and Valid but event marked as Acquisition in ITD database EC
Existing and Valid but event marked as Amalgamation in ITD EA

database
Existing and Valid but event marked as Death in ITD database ED
Existing and Valid but event marked as Dissolution in ITD database EI
Existing and Valid but event marked as Liquidated in ITD database EL
Existing and Valid but event marked as Merger in ITD database EM
Existing and Valid but event marked as Partition in ITD database EP
Existing and Valid but event marked as Split in ITD database ES
22
Existing and Valid but event marked as Under Liquidation in ITD EU
database
Inoperative I
Aadhaar Status Description Value
Aadhaar seeding is Successful Y
Aadhaar seeding is Unsuccessful R
Aadhaar is not seeded null
Aadhaar seeding Not Applicable NA
Note 1: Digitap validates the PAN, DOB & Name from various sources and chooses the best
source available at that time. Some sources validate the name details, some sources validate
DOB, some sources do not. If the source used for validation does not match any field, null value
is returned. Individual field (name/dob) match is also done based on the client agreement.

1. If there is no record found for the given PAN number, then the below response would be provided.
{
"message": “No record found for the given input”,
}
2. If the chosen source validates both the PAN & DOB together and no record found for the given
combination of PAN & DOB, then the response will be in the below format with result_code as
102 and message as “invalid id number or combination of inputs”
{
"message":“Invalid ID number or combination of inputs”,
}
23
In case of Failure, the response as explained in the Section 2.5 and error messages as defined
in the Section 2.5.1 Error Messages would be returned.
6 KYC - PAN Details Validation API

This API helps to get various details related to the PAN.
● Demographic details like dob, gender, etc,
● Aadhaar Linking Status & Linked aadhaar number
● Address available against PAN with the Income Tax Department (ITD) (usually provided
during the PAN card registration or updation)
● Type of PAN (like individual PAN, Company PAN, etc)
● Contact Details (like Mobile & Email Address)
● Father’s Name (for individual PAN)*
● PAN Status (when pan_status_check has been enabled)*
Note:
● The “father_name” feature has additional commercial implications and please discuss
with RM for details.
● “pan_status_check” feature can be enabled at client ID level. When the
“pan_status_check” feature has been enabled, this API calls the PAN Basic API (V1 or
V2) and gets the authentic status of the PAN number and provides the same in the
Output. The “pan_status_check” feature has additional commercial implications. Please
discuss with RM for details.
6.2 API URL

UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/pan_details
Production Env https://svc.digitap.ai/validation/kyc/v1/pan_details
For the clients who want the response to be compatible with PAN Basic V1 API, please use the
following URL.
UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/pan_details_bc
Production Env https://svc.digitap.ai/validation/kyc/v1/pan_details_bc
6.3 API Request

● Method: POST
24
● Header:

(M/O)

/
● Request Body:

Optional
(M/O)
[Max of 45 chars]

minLength: 10
maxLength: 10
Pattern:
A-Z]{1})([0-9]{4})([a-zA-Z]{1})$
father_name O Flag to indicate whether to get the father’s name

or not. Allowed values are `true` or `false` (String
data type)
Default: `false`
`true` - it will return Father’s Name
name O Name to match and provide the match result &

score in the output.
When this field is given, this API compares the

input name with output name based on
“name_match_method” and provides the output.
minLength: 1
maxLength: 150
name_match_method O Either `fuzzy` or èxact` or `dg_name_match`.
Default: `fuzzy`
25
èxact` - Exact Word Name Match (See Notes for
more details)
`fuzzy` - Rule engine based Fuzzy matching (V1

of PAN name match)
`dg_name_match` - Name Matching as per the

Digitap’s Name Matching Utility (V2 of PAN Name
Match)

1. Without pan_status_check feature (and without Father’s name feature):
{
"result_code": 101,
"client_ref_num": "abcd123",
"result": {
"pan": "DQEPJ7722Q",
"pan_type": "Individual",
"fullname": “JOHN DOE”,
"first_name": "JOHN",
"middle_name": "",
"last_name": "DOE",
"gender": "male",
"aadhaar_number": "XXXXXXXX1234",
"aadhaar_linked": true,
"dob": "11/08/1970",
"address": {
"building_name": "A-703 IVORY TOWER APARTMENT",
"locality": "VASUNDHARA",
"street_name": "INDIRA NAGAR",
"pincode": "201012",
"city": "GHAZIABAD",
"state": "UTTAR PRADESH",
"country": "INDIA"
},
"mobile": "9876543210",
"email": "john.deo@gmail.com"
}
}
2. With pan_status_check Feature (and without Father’s Name Feature):
26
{
"result_code": 101,
"result": {
"pan_status": "Active",
"middle_name": "",
"last_name": "DOE",
"gender": "male",
"dob": "11/08/1970",
"address": {
"pincode": "201012",
"country": "INDIA"
},
"mobile": "9876543210",
"email": "john.deo@gmail.com"
}
}
3. With Father’s Name Feature:
{
"result_code": 101,
"result": {
"middle_name": "",
"last_name": "DOE",
"father_name": "RICHARD JOHN"
"gender": "male",
"dob": "11/08/1970",
"address": {
"pincode": "201012",
27
"country": "INDIA"
},
"mobile": "9876543210",
"email": "john.deo@gmail.com",
}
}
4. Name Match Scenario:

When the input provided contains the input “name” to match (like below):
{
"client_ref_num": 200,
"pan": “DQEPJ7722Q”,
"name": "Arun Kumar K",
}
Output would be like the following:

{
"result_code": 101,
"result": {
"fullname": "ARUN KUMAR KULTHIA",
"first_name": "ARUN",
"middle_name": "KUMAR",
"last_name": "KULTHIA",
"gender": "male",
"dob": "11/08/1970",
"address": {
"pincode": "201012",
"country": "INDIA"
},
"mobile": "9876543210",
"email": "arunkumarkulthia@gmail.com",
"name_match": true,
"name_match_score": 90,
}
}
28
Note: In the above example, input name - Arun Kumar K has been fuzzy matched with “ARUN
KUMAR KULTHIA” and match results are given.
5. When “pan_details_bc” endpoint is used:

When the “pan_details_bc” is used, Output would be like the following:
{
"result_code": 101,
"result": {
"pan_status": "Active",
"status": "Active",
"name": “JOHN DOE”,
"pan_display_name": “”,
"middle_name": "",
"last_name": "DOE",
"gender": "male",
"dob": "11/08/1970",
"address": {
"pincode": "201012",
"country": "INDIA"
},
"mobile": "9876543210",
"email": "john.deo@gmail.com",
"name_match": false,
"name_match_score": 0,
}
}
29
Keys of Response Object are explained below:
Key Type Value
http_response_code int Internal Status Code that denotes the status of the
request
result_code String Internal Status Code that denotes the status of the
request
request_id int Unique id for each API request
client_ref_num String Ref number sent in the input by client
result Dict Response object for the given inputs.
|- pan String PAN of the Individual / Entity
|- pan_status String PAN Status of the Individual / Entity
Possible values: Active, Invalid
(Note: This field given only when the

“pan_status_check” feature has been enabled for
the client)
|- pan_type String Type of PAN (Refer the table below to know various
PAN types)
|- fullname String Full name of the Applicant / Entity as per ITD records,
including first name, middle name & last name.
|- first_name String First name of the applicant as per ITD records
|- middle_name String Middle name of the applicant as per ITD records
|- last_name String Last Name of the applicant as per ITD records
|- father_name String Father’s Name of the Individual.
Note:
● This field is given only when the
“father_name” argument is set to “true”
during input
● For non-individual PAN types, this field
would be empty string.
|- gender String Individual’s gender as per PAN. Possible Values:
● male
● female
● transgender
30
(for other PAN types, this field would be empty string)
|- dob String Date of birth or Incorporation in the format

DD/MM/YYYY
|- aadhaar_number String Aadhaar linked to PAN (provided in masked form - first

8 digits masked and last 4 digits unmasked).
Applicable only for the Individual PAN (for other PAN

types, this field would be empty string)
|- aadhaar_linked Bool Aadhaar Linked Status.

true - Aadhaar Linked
false - Aadhaar Not Linked
Applicable only for Individual PAN (for other PAN

types, this field would be null)
|- address Dict Object containing the address available against PAN

with the Income Tax Department (ITD) (usually
provided during the PAN card registration or updation)
|-|- building_name String Building Name of the Address
|-|- locality String Address Locality
|-|- street_name String Street Name of the Address
|-|- pincode String Pincode of the Address
|-|- city String City of the Address
|-|- state String State of the Address
|-|- country String Country of the Address
Note: For Indian Address, this field is generally given

as “”(empty string) from the source and for other
countries, this field contains the country name.
|- mobile String Mobile number associated with PAN (usually provided

during the PAN card registration or updation)
|- email String Email ID registered for given PAN Number (usually

provided during the PAN card registration or updation)
|- name_match boolean Name match result based on name_matching_method

- true or false (boolean data type)
Note: This field is given when the input contains the

“name”.
31
|- name_match_score integer Name matching score based on the
name_match_method.
.
Values range from 0 - 100 (integer data type)
For fuzzy and dg_name_match method, the score will

be from 0 to 100 based on the match.
For the exact method, the score will be either 0 or 100.
Note: This field is given when the input contains the

“name”.
Following additional keys are provided in the response when pan_details_bc endpoint is used
(which is provided for easier compatibility with PAN Basic V1 response for the clients migrating
from PAN Basic V1 to PAN Details API).
|- name String Same as fullname.
Full Name of the Applicant / Entity as per ITD

Records, including first name, middle name & last
name
|- status String Same as pan_status
PAN Status of the Individual / Entity
Possible values: Active, Invalid
(Note: This field given only when the

“pan_status_check” feature has been enabled for
the client)
|- pan_display_name String This field would always be an empty string and

provided for backward compatibility.
|- name_match boolean Name match result based on name_matching_method

- true or false (boolean data type)
This field is always given irrespective of whether

“name” is given in the input when pan_details_bc is
used.
|- name_match_score integer Name matching score based on the

name_match_method.
.
Values range from 0 - 100 (integer data type)
For fuzzy and dg_name_match method, the score will

be from 0 to 100 based on the match.
32
For the exact method, the score will be either 0 or 100.
This field is always given irrespective of whether

“name” is given in the input when pan_details_bc is
used.
Various PAN Types
Individual
Company
Hindu Undivided Family (HUF)
Association of Persons (AOP)
Body of Individuals (BOI)
Government Agency
Artificial Juridical Person
Local Authority
Firm/Limited Liability Partnership
Trust

1. Without pan_status_check feature
If the given PAN number is found to be Invalid / Inactive through internal source, then the below response
would be provided (result code - 102).
{
"result_code": 102,
"message": Invalid ID number or combination of inputs,
"request_id": "10f66706-77b2-11ee-9c0c-f359806a26c7",
"client_ref_num": "dg-test-2dfe7ca3-5e33-48f8-b1ed-97398b868d05",
"result": {
"pan": "LJKPK2266E",
"pan_type": "",
"fullname": "",
"first_name": "",
"middle_name": "",
"last_name": "",
33
"gender": "",
"dob": "",
"aadhaar_number": "",
"aadhaar_linked": "",
"address": {
"building_name": "",
"locality": "",
"street_name": "",
"pincode": "",
"city": "",
"state": "",
"country": ""
},
"mobile": "",
"email": ""
}
}
If the given PAN number is found to be Not Alloted through internal source, then the below response
{
"result_code": 103,
"result": {
"pan_type": "",
"fullname": "",
"first_name": "",
"middle_name": "",
"last_name": "",
"gender": "",
"dob": "",
"address": {
"locality": "",
"street_name": "",
"pincode": "",
"city": "",
"state": "",
"country": ""
},
"mobile": "",
"email": ""
}
}
2. With pan_status_check feature
34
If the given PAN number is found to be Invalid / Inactive / Deactivated / Deleted through PAN Basic API,
then the below response would be provided (result code - 102).
{
"result_code": 102,
"message": Invalid ID number or combination of inputs,
"result": {
"pan_status": "Invalid",
"pan_type": "",
"fullname": "",
"first_name": "",
"middle_name": "",
"last_name": "",
"gender": "",
"dob": "",
"address": {
"locality": "",
"street_name": "",
"pincode": "",
"city": "",
"state": "",
"country": ""
},
"mobile": "",
"email": ""
}
}
If the given PAN number is found to be Not Alloted through PAN Basic API, then the below response
{
"result_code": 103,
"result": {
"pan_status": "Invalid",
"pan_type": "",
"fullname": "",
"first_name": "",
"middle_name": "",
"last_name": "",
"gender": "",
35
"dob": "",
"address": {
"locality": "",
"street_name": "",
"pincode": "",
"city": "",
"state": "",
"country": ""
},
"mobile": "",
"email": ""
}
}
If the given PAN number is Invalid (does not meet the input parameter criteria), then the below response
would be provided.
{
"error": "Invalid ID number or combination of inputs"
}
If digitap is not able fetch the response for the given PAN number, then the below response would be
provided.
{
"error": "Digitap is unable to fetch the response at this moment"
}
In case of other errors, the response as explained in the Section 2.5 and error messages as
defined in the Section 2.5.1 Error Messages would be returned.
36
7 KYC - Form 206AB Compliance Status
Validation API

This API to check the Section 206AB and 206CCA compliance status for the given PAN
Number.
Note: Specified Person as per Section 206AB and 206CCA is the one who, Has not filed the
income tax return (ITR) for the preceding FY, and the income tax return (not belated return) filing
due date has expired and the Total amount of tax deducted or collected (TDS and TCS) in the
last FY is Rs.50,000 or more. (Please refer to the Income Tax website for more details on
Specified persons under Section 206AB & 206CCA).
7.2 API URL

UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/form206ab_complia
nce_status
Production Env https://svc.digitap.ai/validation/kyc/v1/form206ab_compliance_stat

us
7.3 API Request

● Method: POST
● Header:

(M/O)

/
● Request Body:
37
Optional
(M/O)
[Max of 45 chars]

minLength: 10
maxLength: 10
Pattern: ^[A-Za-z]{4}[A-Za-z]{1}\d{4}[A-Za-z]{1}$

{
"result_code": 101,
"result": {
"pan": "BRMPK*****",
"pan_name": "NXXXXT KXXXU",
"specified_person": "N",
"fin_year": "2023-24",
"checked_date": "2023-07-04",
"pan_allotment_date": "2010-07-20"
}
}
Key Type Value
http_response_code int Internal Status Code that denotes the status of the request
result_code String Internal Status Code that denotes the status of the request
38
|- pan String PAN of the Individual / Entity
|- pan_name String Full name of the Applicant / Entity as per ITD records,
including your first name, middle name.
|- specifed_person String Indicates whether the person is a specified person under

the Section 206AB and 206CCA.
Possible values are
● Y - Specified Person
● N - Not a specified Person
|- fin_year String Financial year when the check is done.

(Format - YYYY-YY)
|- checked_date String Date when the Specified Person check is done

Format - YYYY-MM-DD
|- pan_allotment_date String PAN allotment date of the given PAN

Format - YYYY-MM-DD

The following response would be provided in case if the PAN is Invalid
{
"message": “Invalid ID number or combination of inputs”,
}

In case of error, the response as explained in the Section 2.5 and error messages as defined in
8 KYC - PAN to F’Name Validation API

This API to check father’s name for the given PAN Number.
Note: This API validates Individual PAN Details (i.e. the fourth letter of PAN Number is ‘P’).
39
8.2 API URL
UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/pan_to_fname
Production Env https://svc.digitap.ai/validation/kyc/v1/pan_to_fname
8.3 API Request

● Method: POST
● Header:

(M/O)

/
● Request Body:

Optional
(M/O)
[Max of 45 chars]

minLength: 10
maxLength: 10

When the Father’s Name is Found, result_code 101 would be returned. The response format for
the same is as follows:
40
{
"result_code": 101,
"result": {
"pan": "BRMPK*****",
"father_name": "NXXXXT KXXXU"
}
}
Key Type Value
http_response_code int Internal Status Code that denotes the status of the request
result_code String Internal Status Code that denotes the status of the request
|- pan String PAN of the Individua
|- father_name String Father Name of the Applicant as per ITD records

1. If the given PAN number is found to be Invalid through internal source, then the below response
{
"message": “Invalid ID number or combination of inputs”,
}
2. If the given PAN number is found to be Not Alloted through internal source, then the below
response would be provided (result code - 103).
{
41
}

If the given PAN number is not Individual PAN Type, then the below response would be provided.
{
"error": "Father Name not supported for Input PAN type."
}
In case of error, the response as explained in the Section 2.5 and error messages as defined in
9 KYC - VoterID Validation API

This API helps to validate whether the given EPIC (voterID) is valid at the query time or not.
Along with the validation, this API returns various other details related to the VoterID:
● Name, Age & Gender of the EPIC Holder
● Relative Name and Relative Type (Father/Husband,etc)
● District & State of the EPIC Holder
● Constituency (Assembly & Parliamentary) & Polling Station Details
● Last Updated Date of the Details in Government Database
Note: Please note that this API validates only the Active Voter / EPIC Cards. The Old EPIC
cards which have been invalidated due to issue of new card (due to new card format issuance)
or Constituency Change/Transposition cannot be validated through this API.
9.2 API URL

UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/voter
Production Env https://svc.digitap.ai/validation/kyc/v1/aadhaar
9.3 API Request

● Method: POST
42
● Header:

(M/O)

/
Base64encodedValueOf (client_id:client_secret)
● Request Body:

Optional
(M/O)
[Max of 45 chars]
epic_number M Epic number present in the Voter ID card

minLength: 10
maxLength: 23
Regex:
^(([a-zA-Z]{3}\/?\d{6,7})|([a-zA-Z]{2}\/\d{1,3}\/\d{2,3}
\/\d{6,7})|([a-zA-Z]{2}\d{10,12}))$

When the EPIC number is matched and active, result_code 101 would be returned. The
response format for the same is as follows:
{
"request_id": "1e1ea598-cd12-11ea-8513-7a889cb4768d",
"result_code": 101,
"result": {
"epic_no": "Sxxxxxxxxx",
"name": "XYZ",
"name_v1": "XYZ ",
"name_v2": "",
"name_v3": "",
43
"gender": "M",
"age": 23,
"rln_name": "XYZ",
"rln_name_v1": "XYZ ",
"rln_name_v2": "",
"rln_name_v3": "",
"rln_type": "F",
"dist_name": "B.B.M.P(NORTH)",
"dist_name_v1": "ಬಿ.ಬಿ.ಎಂ.ಪಿ ( ಉತ್ತರ )",
"dist_no": "32",
"st_code": "S10",
"st_name": "Karnataka",
"ac_name": "Hebbal",
"ac_name_v1": "XYZ",
"ac_no": "158",
"pc_name": "Bangalore North",

"pc_name_v1": "XYZ",
"pc_no": "24",
"part_name": "YYY"
"part_name_v1": "YYY, ನಾಗಶೇಟ್ಟಿಹಳ್ಳಿ",
"part_no": "82",
"section_no": "4",
"slno_inpart": "428",
"ps_name": "Public School, ",

"ps_name_v1": "YYY, ನಾಗಶೇಟ್ಟಿಹಳ್ಳಿ",
"ps_no": "82",
"ps_lat_long": "0.0,0.0",
"ps_lat_long_0_coordinate": "",
"ps_lat_long_1_coordinate": "",
"id": "Sxxxxxxxxxxxxxxx",
"last_update": "26/12/2019",
},
}
Key Value
epic_no EPIC Voter ID number to be authenticated
name Name of the card holder in English
name_v1 Name of the card holder in Vernacular Language
44
gender Gender of the card holder
age Age of the Card Holder inYears
rln_name Relative Name in English
rln_name_v1 Relative Name in Vernacular Language
rln_type Relationship type: "F" = Father, "H" = Husband
dist_name District of the Electoral Office in English
dist_name_v1 District of the Electoral Office in Vernacular Language
dist_no District Number
st_code State Code
st_name State Name in English
ac_name Assembly Constituency Name in English
ac_name_v1 Assembly Constituency Name in Vernacular Language
ac_no Assembly Constituency Number
pc_name Parliament Constituency Name in English
pc_name_v1 Parliament Constituency Name in Vernacular Language
pc_no Parliament Constituency Number
part_name Number of the part (location) in the constituency applicable to the card
holder
part_name_v1 Number of the part (location) in the constituency applicable to the card
holder in Vernacular Language
part_no Part Number inside the constituency
section_no Section of the Electoral Book where the Card Holder name is present
slno_inpart Serial Number in the Book where the Card Holder name is present
ps_name Polling Station Name in English
ps_name_v1 Polling Station Name in Vernacular Language
ps_no Polling Station Number
45
ps_lat_long Lat Long for the Polling Station (Polling Booth) applicable to the card
holder
ps_lat_long_0_coordinate Lat Long for the Polling Station (Polling Booth) applicable to the card
holder
ps_lat_long_1_coordinate Lat Long for the Polling Station (Polling Booth) applicable to the card
holder
id Unique ID of the card holder [st_code+ ac_no + part_no + section_no +

slno_inpart]
last_update Last date of update to the records against the given epic_no in
Government Records.
9.4.2 Unsuccessful Validation Case

The following response would be provided in case if the Voter ID could not be validated
If there is no record found for the given EPIC number, then the below response would be
provided.
{
}

10 KYC - Passport Validation API

This API helps to validate the passport details with the provided file number and date of birth of
the passport holder.
When the file number related to a passport & DOB is matched, this API provides the matching
passport number, name (given name & surname), date of application and date of dispatch. This
API also helps to identify rejected passport application file numbers by giving a different
result_code 108.
46
From the response, once can match with the passport number, name, date of issuance of the
passport present in the Passport.
10.2 API URL

UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/passport
Production Env https://svc.digitap.ai/validation/kyc/v1/passport
10.3 API Request

● Method: POST
● Header:

(M/O)

/
● Request Body:

Optional
(M/O)
[Max of 45 chars]
file_number M Passport File number
minLength:10
maxLength:14
Regex:
^[a-zA-Z]{2}\d{2}[A-Z0-9]\d{10}$|^[a-zA-Z]{4}\d{8}$
dob M Date of birth in the passport
Format: DD/MM/YYYY
47
10.4.1 Successful Validation (result_code 101) Case & Application

Rejected (result_code 108) Case
When the passport is validated successfully with the given file number and date of birth, the
below response will be provided.
{
"client_ref_num": "1234",
"request_id": "76287f9c-cdae-11ea-85c0-e60fc8f818f8",
"result_code": 101,
"result": {
"file_number": "GZ10xxxxxxxxxxx",
"dob": "06/04/1993",
"passport_number": "Pxxxxxxx",
"given_name": "XYZ",
"surname": "XYZ",
"application_type": "Normal",
"application_date": "09/09/2016",
"date_of_dispatch": "31/10/2016"
}
}
When the given input is validated successfully but the application has been rejected, then the
below response would be provided with result_code as 108.
{
"request_id": "06e7613c-cce8-11ea-822b-5ef05b03730e",
"result_code": 108,
"result": {
"file_number": "Bxxxxxxxxxxxxxx",
"dob": "11/04/1990",
"given_name": "XYZ",
"surname": "XYZ",
"application_type": "Normal",
"application_date": "18/11/2017"
}
}
Key Value
48
file_number Individual’s Passport file number
dob Date of birth in passport
passport_number Passport number
given_name Given name in passport
surname Surname in passport
application_type The passport application type Normal/Tatkal
application_date Date of application
date_of_dispatch Date on which passport issued

When the passport could not be validated with the given inputs then the following response will
be provided.
If the file number is an invalid file number, then the response will be in the below format with
result_code as 102 and message as “invalid id number or combination of inputs”
{
"result_code": 102,
"message":“Invalid id number or combination of inputs”,
}
If there is no record found for the requested File Number with specific DOB, then the below
response would be provided.
{
"result_code": 103,
"message":“No record found for the given input ”,
}

49
11 KYC - Aadhaar Advanced Validation API

This API helps to verify the given Aadhaar number. When the Aadhaar number is validated
(exists), then this API provides additional details like Gender, Age Range, Linked Mobile
Number (in masked form) and state to which the Aadhaar Holder belongs to.
11.2 API URL

UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/aadhaar
Production Env https://svc.digitap.ai/validation/kyc/v1/aadhaar
11.3 API Request

● Method: POST
● Header:

(M/O)

/
● Request Body:

Optional
(M/O)
[Max of 45 chars]
aadhaar M 12 Digit aadhaar number
50

When the given aadhaar number is successfully verified the below response will be provided
{
"request_id": "aaf7f324-cd45-11ea-8517-ea8eca8158c7",
"result_code": 101,
"result": {
"aadhaar_result": "Aadhaar Number xxxxxxxx1234 Exists!"
"aadhaar_age_band": "30-40",
"aadhaar_gender": "MALE",
"aadhaar_phone": "xxxxxxx577",
"aadhaar_state": "Maharashtra",
},
}
Key Value
aadhaar_result Whether the aadhaar number exists or not.
aadhaar_age_band Individual’s age band as per aadhaar (in range of 10

years, 0-10, 10-20,20-30,etc)
aadhaar_gender Individual’s gender as per aadhaar (MALE/FEMALE)
aadhaar_phone Individual's phone number linked to aadhaar (provided in

masked form - first 7 digits masked)
aadhaar_state Individual's state as per aadhaar

When the given Aadhaar number could not be verified, the below response will be provided and
along with below message as
When the given aadhaar number is not found, the below response will be provided
{
"result_code": 103,
"message":“No records found for the given Input”
51
}
When the given aadhaar number starts with zero 1, the below response will be provided
{
"client_ref_num": "test989",
"request_id": "ac529358-5c47-11ed-a8f9-46ea22d4d73e",
"result_code": 102,
"message": "Invalid Aadhaar"
}
Aadhaar Number xxxxxxxxxxxx has been deactivated
{
"request_id": "8dbc6e56-11a9-11ee-815e-da5dd771cab3",
"result_code": 103,
"message":“Aadhaar Number xxxxxxxx1234 has been deactivated”,
}
Aadhaar Number xxxxxxxxxxxx has been cancelled
{
"request_id": "d0600808-1244-11ee-af67-cebe3ef87f86",
"result_code": 103,
"message":“Aadhaar Number xxxxxxxx1234 has been cancelled”,
}
Aadhaar Number xxxxxxxxxxxx is not active
{
"request_id": "d0600808-1244-11ee-af67-cebe3ef87f86",
"result_code": 103,
"message":“Aadhaar Number xxxxxxxx1234 is not active”,
}

When the given aadhaar number is wrong, the below response will be provided
52
{
"error": "One or more parameters format is wrong"
}
{
"error": "Invalid Aadhaar. Aadhaar number cannot start with zero"
}
When the given aadhaar number failed in Verhoeff Check, the below response will be provided
{
"error": "Invalid Aadhaar. Vernhoeff Check failed"
}
12 KYC - Aadhaar Basic Validation API

This API helps to verify the given Aadhaar number.This API gives a basic information on
Aadhaar number whether the provided aadhaar number is valid and exists or it is invalid or not
active.
12.2 API URL

UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/basic_aadhaar
Production Env https://svc.digitap.ai/validation/kyc/v1/basic_aadhaar
53
12.3 API Request
● Method: POST
● Header:

(M/O)

/
● Request Body:

Optional
(M/O)
[Max of 45 chars]
aadhaar M 12 Digit aadhaar number

When the given aadhaar number is successfully verified the below response will be provided
{
"request_id": "1d345e96-5c41-11ed-8eca-0eade9b31ca9",
"result_code": 101,
"result": {
"aadhaar_result": "Aadhaar Number xxxxxxxx8672 Exists!"
},
}

54
{
"result_code": 103,
}
When the given aadhaar number is not active, the below response will be provided
{
"request_id": "367fcd52-5c48-11ed-a8f9-46ea22d4d73e",
"result_code": 103,
"message": "Aadhaar Not Active",
}
{
"result_code": 102,
}

{
}
{
55
}
{
}
In case of Eror, the response as explained in the Section 2.5 and error messages as defined in
13 KYC - PAN AADHAAR Link Validation API

This API helps to validate if the PAN is linked with AADHAAR or vice-versa. This API takes
primarily PAN and AADHAAR as input and responds to the status between them.
13.2 API URL

UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/pan_aadhaar_link
Production Env https://svc.digitap.ai/validation/kyc/v1/pan_aadhaar_link
13.3 API Request

● Method: POST
● Header:

(M/O)

/
56
● Request Body:

Optional
(M/O)
[Max of 45 chars]

minLength: 10
maxLength: 10
aadhaar M AADHAAR Number to be authenticated

minLength: 12
maxLength: 12
Pattern: 12 digit number

When the PAN and AADHAAR are linked, result_code 101 would be returned. The response
format for the same is as follows:
{
"result": {
"message": "PAN is linked to Aadhaar number",
"code": "LINK-001"
},
"request_id": "880dd801-46cf-11ec-b85c-15746d739503",
"client_ref_num": "dbe90be9-1597-47d4-b151-8157d1f9bf64",
"result_code": 101
}
Key Value
code Linking status of PAN and AADHAAR
message Message as per the linking status
result_code E2E validation result based on conclusiveness
57
code message result_code
LINK-001 PAN is linked to Aadhaar number 101
LINK-002 PAN not linked with Aadhaar 103
LINK-003 PAN does not exist 103
LINK-004 Please enter a valid 12 digit Aadhaar number 102
LINK-005 Please enter a valid Aadhaar Number 102
LINK-006 This PAN is linked to some other Aadhaar 103
LINK-007 This Aadhaar is linked to some other PAN 103
LINK-008 Aadhaar PAN linking failed due to DOB mismatch 108
LINK-009 Aadhaar PAN linking failed due to Name mismatch 108
LINK-010 Please enter valid Pan Card Number 102
LINK-011 Invalid PAN or Aadhaar Number 102
LINK-012 Link Aadhaar request is not found for the given PAN and 108
Aadhaar Number
LINK-013 Kindly visit the nearest UIDAI enrollment center to update 103
bio-metric details for activation of Aadhaar number
LINK-999 Unexpected response from source 105

If the PAN and AADHAAR are not linked.
{
"result": {
"message": "PAN not linked with Aadhaar",
"code": "LINK-003"
},
"request_id": "c6587117-46bd-11ec-960e-ffa682131796",
"client_ref_num": "bd7b5d0a-fa14-43cd-bffc-0862f216415c",
"result_code": 103
}
If the PAN does not exist.
58
{
"result": {
"message": "PAN does not exist",
"code": "LINK-005"
},
"result_code": 103
}
If the PAN is linked to different AADHAAR.
{
"result": {
"message": "This PAN is linked to some other Aadhaar",
"code": "LINK-004"
},
"result_code": 103
}
If the PAN or AADHAAR is invalid.
{
"result": {
"message": "Invalid PAN or Aadhaar Number",
"code": "LINK-006"
},
"result_code": 103
}

59
14 KYC - PAN to Masked AADHAAR Validation
API

This API helps to get the masked aadhaar number which is linked to the input PAN number.
14.2 API URL

UAT/DEMO Env https://svcdemo.digitap.work/validation/kyc/v1/pan_to_masked_aa
dhaar
Production Env https://svc.digitap.ai/validation/kyc/v1/pan_to_masked_aadhaar
14.3 API Request

● Method: POST
● Header:

(M/O)

/
● Request Body:

Optional
(M/O)
[Max of 45 chars]

minLength: 10
maxLength: 10
60

The following response would be provided in case if the PAN to Masked Aadhaar could be
validated
If aadhaar is linked with the given PAN number, then the below response would be provided.
{
"http_response_code":200,
"request_id":"f5c7f180-1caa-11ee-9143-922d4621dab8",
"client_ref_num":"abc123",
"result_code": 101,
"result":{
"linked": "y",
"aadhaar_number": "98XXXXXXXX72"
}
}
If aadhaar is not linked with the given PAN number, then the below response would be provided.
{
"http_response_code":200,
"result_code": 101,
"result":{
"linked": "n",
"aadhaar_number": ""
}
}
Keys Type Value
request
request
61
|- linked String PAN Aadhaar Link Status

● Linked - y
● Not Linked - n
|- aadhaar_number String Masked aadhaar number related to the input PAN

number

The following response would be provided in case if the PAN is invalid.
{
"request_id": "eaded2f0-1cac-11ee-8d3a-720730d77877",
"client_ref_num": "abc123",
"result_code": 102,
"message": "Invalid ID Number or Combination of Inputs"
}

15 KYC - AADHAAR to Masked PAN Validation

API

This API helps to get the masked pan number which is linked to the input AADHAAR number.
15.2 API URL

UAT/DEMO Env https://svcdemo.digitap.ai/validation/kyc/v1/aadhaar_to_masked_p
an
Production Env https://svc.digitap.ai/validation/kyc/v1/aadhaar_to_masked_pan
62
15.3 API Request
● Method: POST
● Header:

(M/O)

/
● Request Body:

Optional
(M/O)
[Max of 45 chars]
aadhaar M AADHAAR Number to be authenticated

minLength: 12
maxLength: 12
Pattern: 12 digit number

The following response would be provided in case if the Aadhaar to Masked PAN could be
validated
If pan is linked with the given Aadhaar number, then the below response would be provided.
{
"result_code": 101,
63
"result": {
"linked": "y",
"pan": "DQXXXXXX2Q"
}
}
If pan is not linked with the given Aadhaar number, then the below response would be provided.
{
"result_code": 101,
"result":{
"linked": "n",
"pan": ""
}
}
Keys Type Value
request
request
|- linked String PAN Aadhaar Link Status

● Linked - y
● Not Linked - n
|- aadhaar_number String Masked aadhaar number related to the input PAN

number

64
{
"result_code": 103,
}
When the given aadhaar number is not active, the below response will be provided
{
"request_id": "367fcd52-5c48-11ed-a8f9-46ea22d4d73e",
"result_code": 105,
"message": "Aadhaar Not Active",
}
{
"result_code": 102,
}

{
}
{
}
65
{
}
16 KYC - Driving License Validation API

This sync API extracts the details linked with the Driving License number. It takes mandatory
input as a DL number and provides the information in json format.
16.2 API URL

UAT/DEMO Env https://svcdemo.digitap.ai/validation/kyc/v1/dl
Production Env https://svc.digitap.ai/validation/kyc/v1/dl
16.3 API Request

● Method: POST
● Header:

(M/O)

/
66
● Request Body:

Optional
(M/O)
[Max of 45 chars]
dl_number M DL number for which information need to be

extracted
(Min Length: 9
Max Length: 50)
dob M Date of birth according DL document
Format: DD/MM/YYYY

When the DL number is valid and if the information related to DL is extracted successfully then
below json is returned:
{
"request_id": "d44d769c-09a0-11ed-8f2f-962d5f2b2369",
"result_code": 101,
"result": {
"dob": "26-02-1999",
"dl_number": "TN302017000XXXX",
"dl_validity": {
"transport": {
"to": "",
"from": ""
},
"non_transport": {
"to": "16-07-2037",
"from": "17-07-2017"
},
"hill_valid_till": "",
"hazardous_valid_till": ""
},
"badge_details": [
{
"badge_no": "",
"badge_issue_date": "",
"class_of_vehicle": [
67
"LMV",
"MCWG"
]
}
],
"details_of_driving_licence": {
"name": "CHANDRA KUMAR",
"photo": "",
"status": "",
"address": "SEKAR DRIVING SCHOOL, 6 DR SUBBARAYAN ROAD,
SALEM,TN SEKAR DRIVING SCHOOL, 6 DR SUBBARAYAN ROAD, SALEM,TN",
"address_list": [
{
"type": "permanent",
"split_address": {
"city": [
"SALEM"
],
"state": [
[
"TAMIL NADU",
"TN"
]
],
"country": [
"IN",
"IND",
"INDIA"
],
"pincode": "636001",
"district": [
"SALEM"
],
"address_line": "SEKAR DRIVING SCHOOL,6 DR SUBBARAYAN
ROAD"
},
"complete_address": "SEKAR DRIVING SCHOOL, 6 DR SUBBARAYAN
ROAD, SALEM,TN 636001"
},
{
"type": "temporary",
"split_address": {
"city": [
"DR. THOTTAM"
],
"state": [
[
"TAMIL NADU",
"TN"
]
],
"country": [
"IN",
"IND",
"INDIA"
],
"pincode": "636010",
68
"district": [
"SALEM"
],
"address_line": "SEKAR DRIVING SCHOOL,6 DR SUBBARAYAN
ROAD TN SEKAR DRIVING SCHOOL,6 DR SUBBARAYAN ROAD,SALEM"
},
"complete_address": "SEKAR DRIVING SCHOOL, 6 DR SUBBARAYAN
ROAD, SALEM,TN SEKAR DRIVING SCHOOL, 6 DR SUBBARAYAN ROAD,
SALEM,TN"
}
],
"date_of_issue": "17-07-2017",
"split_address": {
"city": [
"DR. THOTTAM"
],
"state": [
[
"TAMIL NADU",
"TN"
]
],
"country": [
"IN",
"IND",
"INDIA"
],
"pincode": "636010",
"district": [
"SALEM"
],
"address_line": "SEKAR DRIVING SCHOOL,6 DR SUBBARAYAN ROAD
TN SEKAR DRIVING SCHOOL,6 DR SUBBARAYAN ROAD,SALEM"
},
"last_transacted_at": "",
"father_or_husband_name": "DEVARAJAN K",
"date_of_last_transaction": ""
}
},
}
Key Value
request_id Unique id for each API request
client_ref_num Ref number sent in the input by client
result_code Internal Status Code that denotes the status of the

request
result Response object for the given inputs.
69
|- dob Date of birth registered with DL number
|- dl_number Input DL number
|- dl_validity Validity of DL number
|-|- transport |- from Validity of DL number for transport vehicle start date
|-|- transport |- to Validity of DL number for transport vehicle end date
|-|- non_transport |- from Validity of DL number for non_transport vehicle start

date
|-|- non_transport |- to Validity of DL number for non_transport vehicle end

date
|-|- hill_valid_till
|-|- hazardous_valid_till
|-badge_details Authorisation to drive transport vehicle
|-|-badge_no Badge number
|-|-badge_issue_date Date on which Badge is issued
|-|-class_of_vehicle Vehicle class permitted to drive
|-details_of_driving_licence Driver data like name,address, photo etc
|-|-name Registered name in driving licence
|-|-photo Photo registered on driving licence
|-|-status Status of driving licence
|-|-address Address registered for driving licence
|-|-address_list List of address linked with driving licence
|-|-|-type Type of address
|-|-|-split_address Split of address
|-date_of_issue Date of issue of driving licence
|-father_or_husband_name Father or husband name registered
|-date_of_last_transaction Date on which the DL information were modified
|-last_transacted_at Place in which the DL information was last modified
70
When the DL number could not be validated with the given inputs then the following response
will be provided.
If the DL number is an invalid number, then the response will be in the below format
{
"result_code": 102,
}
If there is no record found for the DL Number, then the below response would be provided.
{
"result_code": 103,
}

17 ASSET - Vehicle RC Validation API

This sync API extracts the details linked with the vehicle registration number. It takes mandatory
input as a vehicle RC number and provides the information in json format.
17.2 API URL

UAT/DEMO Env https://svcdemo.digitap.ai/validation/kyc/v1/rc
Production Env https://svc.digitap.ai/validation/kyc/v1/rc
71
17.3 API Request
● Method: POST
● Header:

(M/O)

/
● Request Body:

Optional
(M/O)
[Max of 45 chars]
reg_no M Vehicle number of which information need to be

extracted
(Min Length: 6
Max Length: 20)
Pattern:
“^[A-Z]{2}\d[A-Z]{2}\d{4}$|^[A-Z]{2}\d{2}[A-Z0-9]{2}\
d{3,4}$|^[A-Z]{2}\d{2}[A-Z]\d{4}$|^[A-Z]{2}\d{6}$|^[A
-Z]{3}\d{4}|^[A-Z]{2}\d{1}[A-Z]{3}\d{3,4}$|^[A-Z]{2}\d
{1}[A-Z]{1}\d{4}|^[A-Z]{2}\d{2}[A-Z]{1}\d{3}$|^[A-Z]{
2}\d[A-Z]{3}\d{4}$|^[A-Z]{2}\d{2}[A-Z]{1,2}\d{2}$|^[0
-9]{2}[B,H]{2}[0-9]{4}[A-Z]{1,2}$

When the Vehicle RC number is valid and if the information related to RC is extracted
successfully, then below template json is returned:
72
{
"request_id": "c3e02028-0be6-11ed-a523-5ab8b3ec914a",
"result_code": 101,
"result": {
"reg_no": "WB26AX1234",
"class": "Motor Car(LMV)",
"chassis": "MA3EUA61S00B61234",
"engine": "F8DN5911234",
"vehicle_manufacturer_name": "MARUTI SUZUKI INDIA LTD",
"model": "MARUTI ALTO 800 VXI",
"vehicle_colour": "BLAZING RED",
"type": "PETROL",
"norms_type": "BHARAT STAGE IV",
"body_type": "SALOON",
"owner_count": "1",
"owner_name": "PRODYUT KUMAR DATTA",
"owner_father_name": "LAKSHMI KANTA",
"mobile_number": "",
"status": "ACTIVE",
"status_as_on": "21-07-2022",
"reg_authority": "BARASAT RTO, WEST BENGAL",
"reg_date": "31-01-2018",
"vehicle_manufacturing_month_year": "10-2017",
"rc_expiry_date": "30-01-2033",
"vehicle_tax_upto": "15-01-2023",
"vehicle_insurance_company_name": "SHRIRAM GENERAL INSURANCE CO.
LTD.",
"vehicle_insurance_upto": "25-01-2023",
"vehicle_insurance_policy_number": "10019/31/22/079351",
"rc_financer": "INDUSIND BANK",
"present_address": "FLAT NO 123,GEETANJALI APPARTMENT,20 NO
JESSORE ROAD WEST,BARASAT M)KOLKATA-700123",
"split_present_address": {
"district": [
"NORTH 24 PARGANAS"
],
"state": [
[
"WEST BENGAL",
"WB"
]
],
"city": [
"BARASAT - I"
],
"pincode": "700124",
"country": [
"IN",
"IND",
"INDIA"
],
"address_line": "FLAT NO 123,GEETANJALI APPARTMENT,20 NO
JESSORE ROAD WEST,BARASAT M)KOLKATA"
},
73
"permanent_address": "FLAT NO 123,GEETANJALI APPARTMENT,20 NO
JESSORE ROAD WEST,BARASAT M)KOLKATA-700123",
"split_permanent_address": {
"district": [
"NORTH 24 PARGANAS"
],
"state": [
[
"WEST BENGAL",
"WB"
]
],
"city": [
"BARASAT - I"
],
"pincode": "700124",
"country": [
"IN",
"IND",
"INDIA"
],
"address_line": "FLAT NO 123,GEETANJALI APPARTMENT,20 NO
JESSORE ROAD WEST,BARASAT M)KOLKATA"
},
"vehicle_cubic_capacity": "796",
"gross_vehicle_weight": "1185",
"unladen_weight": "725",
"vehicle_category": "LMV",
"rc_standard_cap": "0",
"vehicle_cylinders_no": "3",
"vehicle_seat_capacity": "5",
"vehicle_sleeper_capacity": "0",
"vehicle_standing_capacity": "0",
"wheelbase": "2360",
"vehicle_number": "WB26AX1234",
"pucc_number": "WB02500990023123",
"pucc_upto": "29-08-2022",
"blacklist_status": "",
"permit_issue_date": "NA",
"permit_number": "",
"permit_type": "",
"permit_valid_from": "NA",
"permit_valid_upto": "NA",
"non_use_status": "",
"non_use_from": "NA",
"non_use_to": "NA",
"national_permit_number": "",
"national_permit_upto": "NA",
"national_permit_issued_by": "",
"noc_details": ""
}
}
74
Key Value
request_id Unique id for each API request
client_ref_num Ref number sent in the input by client
result_code Internal Status Code that denotes the status of the

request
result Response object for the given inputs.
|- reg_no Vehicle registration number given in the input
|- class Description of Vehicle Class
|- chassis Chassis Number of the Vehicle
|- engine Engine Number of the vehicle
|- vehicle_manufacturer_name Name of Vehicle Manufacturer
|- model Vehicle Model
|- vehicle_colour Vehicle Color
|- type Vehicle Fuel Type
|- norms_type Vehicle Pollution Norms Description
|- body_type Body Type of the Vehicle
|- owner_count
|- owner Registered Name of Owner
|- owner_father_name Father's Name of Registered Owner of the vehicle
|- mobile_number Mobile number registered for given RC number
|- status RC status of vehicle
|- status_as_on Date of RC Status Verification
|- reg_authority Location of RTO where the vehicle was registered
|- reg_date Date of Registration of the Vehicle
|-vehicle_manufacturing_month Month & Year of Vehicle Manufacture

_year
|- rc_expiry_date RC expiry date
|- vehicle_tax_upto Duration till the Tax on the Vehicle has been paid
(Life time / One time)
75
|-vehicle_insurance_company_n Insurer Name of the Vehicle
ame
|- vehicle_insurance_upto Date of validity of RC Insurance
|-vehicle_insurance_policy_num Insurance Policy Number of the Vehicle

ber
|- rc_financer Name of Vehicle Financier
|- present_address Registered Permanent Address of the Vehicle

Owner
|- split_present_address Split of the present address
|-|- district District of PA(present address)
|-|- state State of PA(present address)
|-|- city City of PA(present address)
|-|- pincode Pincode of PA(present address)
|-|- country Country
|-permanent_address Registered Permanent Address of the Vehicle

Owner
|-split_permanent_address Split of permanent address
|-vehicle_cubic_capacity Cubic Capacity of the Vehicle Engine
|-gross_vehicle_weight Gross Weight of the Vehicle
|-unladen_weight Unladen Weight of the Vehicle
|-vehicle_category Category of vehicle
|-rc_standard_cap
|-vehicle_cylinders_no Total number of cylinders in the Vehicle
|-vehicle_seat_capacity Total seating capacity in the Vehicle
|-vehicle_sleeper_capacity Sleeper capacity of the vehicle
|-vehicle_standing_capacity Standing capacity of the vehicle
|-wheelbase Wheelbase in mm of the vehicle
|-pucc_number PUC Registration Number of the vehicle
|-pucc_upto Expiry date of PUC certificate of the vehicle
|-blacklist_status Blacklist status of the vehicle
|-permit_issue_date Date of issue of State Permit of the vehicle
76
|-permit_number State Permit Number of the vehicle
|-permit_type Type of State Permit issued for the vehicle
|-permit_valid_from State permit start date
|-permit_valid_upto State permit end date
|-non_use_status Vehicle RC Non use status
|-non_use_from Vehicle RC Non use from date
|-non_use_to Vehicle RC Non use to date
|-national_permit_number National Permit Number of the vehicle
|-national_permit_upto Expiry date of the national permit of the vehicle
|-national_permit_issued_by Name of the body which issued the National Permit

for the vehicle
|-noc_details Vehicle No Objection Certificate details issued by

RTO

When the Vehicle RC could not be validated with the given inputs, then the following response
will be provided.
1. If the Vehicle RC is an invalid number, then the response will be in the below format with
result_code as 102 and message as “invalid id number or combination of inputs”.
{
"result_code": 102,
}
2. If there is no record found for the RC Number, then the below response would be provided.
{
"result_code": 103,
}
3. If more than one record is found (records found in different offices) for the given registration
number, then the below response would be provided.
77
{
"result_code": 104,
"message":“Multiple records exist”,
}

------------------------------------------------ End of Document ------------------------------------------------
78

Digitap KYC &amp; Asset Validation API Suite- API Doc_v1.73_29Feb2024

Uploaded by

Copyright:

Available Formats

You might also like

Digitap KYC &amp; Asset Validation API Suite- API Doc_v1.73_29Feb2024

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Digitap KYC &amp; Asset Validation API Suite- API Doc_v1.73_29Feb2024

Uploaded by

Copyright:

Available Formats

Digitap.

ai KYC & Asset

A jumpstart guide to boosting your Business

Save Time, Save Cost

1.1 Validation API Suite Introduction

2.3 API Request & Response Format

2.4 HTTP Status/Response Codes and its response body format

Code Message Description

200 OK Request Successful

401 Client Authentication failed Access to API is denied

500 Internal Error Internal Server Error identified through its

// Optional items based on result_code

2.4.1 Error Messages

Code Error Message

400 One or more parameters format is wrong or missing

401 Client Authentication Failed

500 Internal Error 1/2/3

503 Website is in maintenance

504 Endpoint request Timed out

2.5 API Result

Various possible values of result_code and is tabled below:

101 Validation Successful

102 Invalid id number or combination of inputs

103 No record found for the given input

104 Source failed to respond with proper details

105 Unexpected Response from source

106 Multiple records exists

108 If the user’s application is rejected

2.6 Additional Notes

3.1 API Introduction

3.2 API URL

Production Env https://svc.digitap.ai/validation/kyc/v1/pan_basic

3.3 API Request

Key Mandatory/Optional Value

authorization M Type: Basic Auth, Username:client_id,

Key Mandatory/ Value

name O Exact name as per PAN

name_match_method O Either `fuzzy` or `exact` or `dg_name_match`.

`exact` - Exact Word Name Match (See Notes for

`fuzzy` - Rule engine based Fuzzy matching (V1

`dg_name_match` - Name Matching as per the

3.4.1 Successful Validation (result_code 101) Case

Keys of Result Object are explained below:

Key Type Value

status string Status of the PAN (Active / Invalid)

If there is no pan_display_name or if the source

name_match boolean Name match result based on

name_match_score integer Name matching score based on the

For fuzzy and dg_name_match method, the score

● If no name is provided in the input, then name_match would be false and

3.4.2 Unsuccessful Validation Cases

3.5 API Error Response

4 KYC - PAN Basic Validation API (V2)

4.1 API Introduction

4.2 API URL

Production Env https://svc.digitap.ai/validation/kyc/v2/pan_basic

Key Mandatory/Optional Value

authorization M Type: Basic Auth, Username:client_id,

Key Mandatory/ Value

Digitap KYC & Asset Validation API Suite- API Doc_v1.73_29Feb2024

Digitap KYC & Asset Validation API Suite- API Doc_v1.73_29Feb2024

Digitap KYC & Asset Validation API Suite- API Doc_v1.73_29Feb2024