API IntegrationNEW

API Reference for Indian ID Card OCR and Verification.

OCR and Verification can be done on the following ID Cards:

Aadhaar
Driving License
PAN Card
Vehicle RC
Passport
Voter ID

There are two APIs, namely:

For ID Card OCR and Verification: It is used for extracting data of the image uploaded using OCR and its verification
For ID card Verification: It is used for verification based on input provided.
For Vehicle RC Verification

For more details, refer to both the APIs as mentioned below.

For API Base URL's, click here

ID Card OCR and Verification API

post {BASE_URL}/v4/client/kyc/analyze/file/idcard

ID Card OCR and Verification API Details

REQUEST

REQUEST BODY multipart/form-data

front_part*

binary

Front Part of ID Card

back_part*

binary

Back Part of ID card

unique_request_id

string

Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request.

additional_request

string

Contains Options For OCR API

Examples: {"features":["MASK","CROP_ALIGN","VERIFY","SIGNATURE_EXTRACT","FACE_EXTRACT","SECURITY_FEATURE"],"expected_ids":["AADHAAR","PAN"],"additional_checks":["BLUR_IMAGE","BLACK_AND_WHITE_IMAGE"]}

API Server

https://api.digio.in

Authentication

Required (None Applied)

curl -X POST "https://api.digio.in/v4/client/kyc/analyze/file/idcard" \
 -H 'accept: application/json'

RESPONSE

ID Analysis Successful!

application/json

Field

Type

Description

- details

object

status *

boolean

OCR Status (true/false)

error_code

string

Error code if status is false

error_message

string

Error Description if status is false

- detections

array of object

id_type

enum

➔ Type of the ID Card detected from OCR

Allowed: PAN┃FORM_60┃VOTER_ID┃AADHAAR┃EAADHAAR┃PASSPORT┃DRIVING_LICENSE┃CHEQUE┃VEHICLE_RC┃CIN┃DIN┃TAN┃TIN┃UAADHAAR┃FSSAI┃OTHER┃KRA_PAN┃E_STAMP┃GST┃PAN_ADVANCED┃IFSC┃UDYAMAADHAAR┃PAN_GST┃GST_ADVANCED┃CIN_ADVANCED┃BANK_STATEMENT

detected_part

enum

➔ Describes if the detected part of the ID Card is FRONT, BACK or both

Allowed: FRONT┃BACK┃BOTH

- id_attributes

object

Attributes detected from the ID Card

name

string

Name detected from the ID Card

fathers_name

string

Father's Name detected from the ID Card

mothers_name

string

Mother's Name detected from the ID Card

husbands_name

string

Mother's Name detected from the ID Card

id_no

string

ID Number detected from the ID Card

dob

string

DOB detected from the ID Card

date_of_incorporation

string

Date of Incorporation

year_of_birth

string

Year of birth according to the ID Card

address

string

Address detected from the ID Card

gender

string

Gender detected from the ID Card

date_of_issue

string

Date of the issue of ID Card

bank_name

string

If id_type is CHEQUE, detected bank name from Cheque

account_no

string

If id_type is CHEQUE, detected account number from Cheque

ifsc

string

If id_type is CHEQUE, detected IFSC from Cheque

engine_no

string

If id_type is VEHICLE_RC, detected engine number

chassis_no

string

If id_type is VEHICLE_RC, detected chassis number

file_no

string

If id_type is PASSPORT, detected file number

type

string

If id_type is PASSPORT, detected type

country_code

string

If id_type is PASSPORT, detected country code

sur_name

string

If id_type is PASSPORT, detected surname

nationality

string

If id_type is PASSPORT, detected nationality

place_of_birth

string

If id_type is PASSPORT, detected place of birth

place_of_issue

string

If id_type is PASSPORT, detected place of issue of the passport

date_of_expiry

string

If id_type is PASSPORT, detected expiry date of the passport

spouces_name

string

If id_type is PASSPORT, detected spouse name

cin

string

In case of business verification, detected Corporate Identification Number

din

string

In case of business verification, detected Director Identification Number

tin

string

In case of business verification, detected Taxpayer Identification Number

validity

string

Detected Validity of the card

vehicle_types

[string]

Detected Vehicle types from the ID Card
⮕ [ Detected Vehicle types from the ID Card ]

- address_information

object

address

string

Full Address detected from the ID Card

locality_or_post_office

string

Locality detected from the ID Card

district_or_city

string

District or City detected from the ID Card

state

string

State detected from the ID Card

pincode

string

Pincode detected from the ID Card

phone_number

string

Phone Number detected from the ID Card

- output_images

object

front_part

string

Front part of the ID Card in base64 format

back_part

string

Back part of the ID Card in base64 format

photo

string

Photo detected from the ID Card in base64 format

signature

string

Signature from the ID Card in base64 format

front_masked_image

string

In case of masking, front masked image from the ID Card in base64 format

back_masked_image

string

In case of masking, back masked image from the ID Card in base64 format

detected_security_features

[enum]

➔ The type of security feature for the ID Card
⮕ [ The type of security feature for the ID Card ]

Allowed: QR_CODE┃BAR_CODE┃HOLOGRAM

- front_image_checks_result

object

Results from the checks for the front part of the ID Card

- [any-key]

object

Results from the checks for the back part of the ID Card

score

number

Confidence of image being live or real/acceptable. Higher the better

result

enum

➔ Result for the validation check (UNKNOWN is from Gray-area where manual verification can be done if you don't want customers to reattempt). Ideally consider Unknown also as Fail and ask user to reattempt.

Allowed: PASS┃FAIL┃UNKNOWN

errors

[string]

In case there are errors, list of errors found in image
⮕ [ In case there are errors, list of errors found in image ]

count

integer

Count

- back_image_checks_result

object

Results from the checks for the back part of the ID Card

- [any-key]

object

Results from the checks for the back part of the ID Card

score

number

Confidence of image being live or real/acceptable. Higher the better

result

enum

Allowed: PASS┃FAIL┃UNKNOWN

errors

[string]

In case there are errors, list of errors found in image
⮕ [ In case there are errors, list of errors found in image ]

count

integer

Count

- verification_result

object

verified

boolean

In case of verification, status of the verification

- result

object

In case of verification, result from the verification

[any-key]

boolean

In case of verification, result from the verification

- data

object

In case of verification, additional data from the verification

- [any-key]

object

In case of verification, additional data from the verification

error_message

string

In case of verification, error message from the verification process

empty

boolean

Fetch ID Card details

post {BASE_URL}/v3/client/kyc/fetch_id_data/{idCardType}

Request Body Params (application/json)

id_no*string

Identifier of the ID Card.

namestring

Name as per ID Card.

dobstring

Date of birth as per ID Card

file_nostring

Mandatory in case of PASSPORT

unique_request_idstring

Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request.

is_advancedboolean

Only for PAN_TO_GST. To fetch advanced details for the api

listing_typeenum

Only for PAN_TO_GST. To fetch listing type for the api

Allowed:

LIST_ONLY

| BASIC

REQUEST

PATH PARAMETERS

* idCardType

enum

Allowed: PAN ┃ PASSPORT ┃ VOTER_ID ┃ DRIVING_LICENSE ┃ CIN ┃ DIN ┃ UAADHAAR ┃ UDYAMAADHAAR ┃ FSSAI ┃ GST ┃ GST_ADVANCED ┃ PAN_TO_GST

ID Card Type

REQUEST BODY * application/json

Field

Type

Description

id_no *

string

Identifier of the ID Card.

name

string

Name as per ID Card.

dob

string

Date of birth as per ID Card

file_no

string

Mandatory in case of PASSPORT

unique_request_id

string

Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request.

is_advanced

boolean

Only for PAN_TO_GST. To fetch advanced details for the api

listing_type

enum

➔ Only for PAN_TO_GST. To fetch listing type for the api

Allowed: LIST_ONLY┃BASIC

API Server

https://api.digio.in

Authentication

Required (None Applied)

curl -X POST "https://api.digio.in/v3/client/kyc/fetch_id_data/{idCardType}" \
 -H 'accept: application/json'

RESPONSE

Call this API to Fetch ID Card details

application/json

Field

Type

Description

pan

string

Applicable in case of PAN.

Vehicle RC Verification

post {BASE_URL}/client/v4/apis/verify/vehicle_rc

Request Body Params (application/json)

id*string

vehicle RC Number

unique_request_idstring

Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request.

REQUEST

REQUEST BODY * application/json

Field

Type

Description

id *

string

vehicle RC Number

unique_request_id

string

➔ Unique request id for traceability of request and recon purpose. Businesses are required to pass unique id for every request.

Constraints: 1 to 70 chars

API Server

https://api.digio.in

Authentication

Required (None Applied)

curl -X POST "https://api.digio.in/client/v4/apis/verify/vehicle_rc" \
 -H 'accept: application/json'

RESPONSE

Rc details retrieved

application/json

Field

Type

Description

- user_details

object

owner_name

string

Vehicle owner name

father_name

string

Father name of Vehicle owner

mobile_number

string

Vehicle owner mobile number

owner_number

string

Owner number

present_address

string

Owner present address

permanent_address

string

Owner permanent address

- vehicle_details

object

rc_number

string

Vehicle RC number

registration_date

string

Vehicle registration date

vehicle_category

string

Vehicle category

vehicle_chassis_number

string

Vehicle chassis number

vehicle_engine_number

string

Vehicle engine number

maker_description

string

Vehicle company name or detail

maker_model

string

Vehicle model name

body_type

string

Vehicle body type

fuel_type

string

Vehicle fuel type(Petrol, Diesel)

color

string

Vehicle color

norms_type

string

Bharat Stage Emission Standards (BS4, BS6)

fit_up_to

string

Vehicle fitness expiry date in 'YYYY-MM-DD' format

vehicle_gross_weight

string

Vehicle Gross weight in 'K.G'

number_of_cylinders

string

Number of cylinders in vehicle

seat_capacity

string

Vehicle seat capacity

sleeper_capacity

string

Vehicle sleeper capacity

standing_capacity

string

Standing capacity

wheelbase

string

Vehicle wheelBase

unladen_weight

string

VEmpty vehicle weight in 'K.G'

vehicle_category_description

string

Vehicle category description (Car, Bike, Bus)

rc_status

string

RC status active or not

masked_name

boolean

Vehicle masked name

challan_details

string

Vehicle challan details

variant

string

Vehicle variant

registered_at

string

Vehicle RTO name

cubic_capacity

string

Vehicle engine cubic capacity (CC)

rto_code

string

Vehicle rto code

- finance_details

object

financier

string

Vehicle financier name

financed

boolean

Vehicle finance status True of Flase

insurance_company

string

Vehicle insurance company name

insurance_policy_number

string

Vehicle insurance policy number

insurance_upto

string

Vehicle insurance expiry date in 'YYYY-MM-DD' format

manufacturing_date

string

Vehicle manufacturing date in 'MM/YYYY' format

manufacturing_date_formatted

string

Vehicle manufacturing date in 'YYYY/MM format

latest_by

string

latest date in 'YYYY-MM-DD' format

less_info

boolean

Less info status

tax_upto

string

Vehicle tax upto date in 'YYYY-MM-DD' format

tax_paid_upto

string

Vehicle tax paid date in 'YYYY-MM-DD' format

- permit_details

object

permit_number

string

Vehicle permit number

permit_issue_date

string

Permit issue date

permit_valid_from

string

Permit start date in 'YYYY-MM-DD' format

permit_valid_upto

string

Permit expiry date in 'YYYY-MM-DD' format

permit_type

string

Vehicle permit type

national_permit_number

string

Vehicle national permit number

national_permit_upto

string

National permit expiry date in 'YYYY-MM-DD' format

national_permit_issued_by

string

National permit issued authority

non_use_status

string

Non use status

non_use_from

string

Non use from

non_use_to

string

Non use to

blacklist_status

string

Vehicle black list status or detail

noc_details

string

NOC detail

pucc_number

string

Vehicle pollution certificate number

pucc_upto

string

Pollution expiry date in 'YYYY-MM-DD' format