These journeys are pre-configured to perform the Government ID OCR Verification. Businesses can use any one of these journeys to perform Government ID Verification.

Currently, there are four predefined journeys to verify PAN

Aadhaar OCR Verification
PAN OCR Verification
Driving Licence OCR Verification
Voter ID OCR Verification

Journey Details

Journeys	Doc_type	Input	Output
Aadhaar OCR Verification	aadhaar	- Aadhaar front image (Base 64 or URL) - Aadhaar back image (Base 64 or URL)	- Aadhaar Number - Full Name as per Aadhaar
PAN OCR Verification	pan	- PAN Front Image (Base 64 or URL)*	- PAN Number - Full Name as per PAN - D.O.B - Father's Name
Driving Licence OCR Verification	driving_licence	- Driving Licence front image (Base 64 or URL) - Driving Licence back image (Base 64 or URL)	- Full name as per driving licence - DL Number - D.O.B - Gender - Father's Name - Permanent Address - Blood group
Voter ID OCR Verification	voter_id	- Voter ID Front Image (Base 64 or URL) - Voter ID Back Image (Base 64 or URL)	- Full Name - EPIC Number - D.O.B - Gender - Full Address - Age - Family Member Name - Family Member Relation

📘

*Size of the image should be less than 2 MB.

*The supported image formats for OCR image are JPEG, JPG and PNG

The businesses can configure these checks with our Government ID OCR Verification journey. They need to pass the doc_type based on the document they need to verify.

Journey Input Data

For each government ID, businesses must use a specific doc_type to perform OCR, as required for that particular ID.

Aadhaar Card: aadhaar
PAN Card: pan
Driving Licence: driving_licence
Voter ID Card: voter_id

{
  "doc_type": "aadhaar",
  "front_url": "",
  "back_url": "",
  "front_base64": "",
  "back_base64": ""
}

AADHAAR

Journey Output Data

{
  "transaction_id": "",
  "journey_transaction_id": "",
  "journey_id": "",
  "status": "SUCCESS|FAILURE|IN_PROGRESS",
  "status_code": "Refer to the table below",
  "message": "Refer to the table below",
  "checks": [],
  "data": {
    "keys": {
      "aadhaar": [
        {
          "masked_aadhaar_no": "XXXX",
          "dob":"",
          "gender":"",
          "address":"",
          "name": "XXXX XXX",
          "checks": []
        }
      ]
    }
  }
}

PAN

Journey Output Data

{
  "transaction_id": "",
  "journey_transaction_id": "",
  "journey_id": "",
  "status": "SUCCESS|FAILURE|IN_PROGRESS",
  "status_code": "Refer to the table below",
  "message": "Refer to the table below",
  "checks": [],
  "data": {
    "keys": {
      "pan": [
        {
          "pan_no": "XXXX",
          "name": "XXXX XXX",
          "dob": "18/05/1992",
          "fathers_name": "",
          "user_pan_image": "<Image link>|base64",
          "source": "OCR",
          "issuer": "ITR",
          "decision": "CLEAR|MUST REVIEW|NEEDS REVIEW",
          "checks": []
        }
      ]
    }
  }
}

DRIVING LICENCE

Journey Output Data

{
  "transaction_id": "",
  "journey_transaction_id": "",
  "journey_id": "",
  "status": "SUCCESS|FAILURE|IN_PROGRESS",
  "status_code": "Refer to the table below",
  "message": "Refer to the table below",
  "checks": [],
  "data": {
    "keys": {
      "driving_licence": [
        {
          "dl_no": "<Driving Licence Number as Input>",
          "name": "",
          "dob": "",
          "address": "",
          "issuer_name":"",
          "key_issued_date":"",
          "authorized_to_drive":[],
          "expiry_date":"",
          "checks": []
        }
      ]
    }
  }
}

VOTER ID

Journey Output Data

{
  "transaction_id": "",
  "journey_transaction_id": "",
  "journey_id": "",
  "status": "SUCCESS|FAILURE|IN_PROGRESS",
  "status_code": "Refer to the table below",
  "message": "Refer to the table below",
  "checks": [],
  "data": {
    "keys": {
      "voter_id": [
        {
          "epic_number": "<VoterId Epic Number>",
          "name": "",
          "dob": "",
          "gender": "",
          "address": "",
          "issuer_name": "ITR",
          "checks": []
        }
      ]
    }
  }
}

📘

*Size of the image should be less than 2 MB.

*The supported formats for OCR input are JPG, JPEG and PNG.

The format for base64 should be data:content/type;base64,<base64_encoded_data>

📘
These journeys do not include any pre-configured Ownership or Fraud Checks. To add these checks, please contact your Account Manager.

Status Codes

Scenario	Http Status Code	status	status_code	message
When request is successful and details are available.	200	SUCCESS	success	Request successful
Invalid image	200	FAILURE	invalid_input	Invalid Image, please upload a valid image
When no details found at Source for given PAN/Aadhaar/ Driving Licence/ Voter ID Image	200	FAILURE	document_not_found	Entity not found
The doc_type entered is invalid.	400	FAILURE	invalid_input	Please provide a valid document type.
Invalid Client Credentials	401	FAILURE	invalid_credentials	Invalid Client Credentials
Any unhandled error from Equal end	500	FAILURE	internal_server_error	Something went wrong, please try again.
Too many requests	429	No object will be sent, throttling happens at the gateway level.
Service Unavailable	503
Both formats(Base 64 and URL) are entered	400	FAILURE	invalid_request	Enter only one Base 64 or URL
None of the inputs (Base 64 or URL) provided	400	FAILURE	invalid_request	One of the inputs Base 64 or URL is required
Unsupported media types	400	FAILURE	invalid_request	Invalid file type, only PNG, JPG, and JPEG files are allowed
Image too large	400	FAILURE	invalid_request	File size exceeds the maximum limit of 2MB
Invalid Base 64	400	FAILURE	invalid_request	Invalid base64 content
Invalid URL	400	FAILURE	invalid_request	Invalid URL

Status (Journey Status)

Possible Values	Description
SUCCESS	Shows that the verification process was completed successfully.
FAILURE	Indicates that the verification process did not succeed.
IN_PROGRESS	Signifies that the verification process is currently underway and has not yet been completed.

Decision

Possible Values	Description
CLEAR	Indicates that the verification has been completed and the information is confirmed as accurate and legitimate.
MUST REVIEW	Signifies that further review is needed due to potential issues or inconsistencies in the verification results.
NEEDS REVIEW	Suggests that the verification has identified areas that require further investigation or clarification before a final determination can be made.

📘
Journey ID will be shared as part of Onboarding

Key Descriptions

Key	Description
transaction_id	Unique identifier for the transaction.
journey_transaction_id	Unique identifier for the journey transaction.
journey_id	Unique identifier for the journey.
status	Current status of the transaction. Possible values: SUCCESS, FAILURE, IN_PROGRESS.
status_code	Code representing the specific status of the transaction. Refer to the documentation for possible values.
message	Detailed message about the transaction status. Refer to the documentation for specific messages.
decision	Final decision based on all checks. Possible values: CLEAR, MUST REVIEW, NEEDS REVIEW.
checks	List of checks performed during the transaction.
pan	List of PAN-related data points.
pan_no	PAN number for verification.
name	Name associated with the PAN.
dob	Date of birth associated with the PAN.
father's_name	Father's name associated with the PAN.
issuer_name	Name of the entity that issued the document (e.g., UIDAI, IT department).
aadhaar	List of Aadhaar-related data points.
aadhaar_no	Aadhaar number for verification.
address	Address associated with the Aadhaar record.
dl	List of driving license-related data points.
dl_no	Driving license number for verification.
swd	Specially-abled status of the driving license holder (if applicable).
address (DL)	Address of the driving license holder.
voter_id	List of voter ID-related data points.
epic_number	Voter ID epic number for verification.
full_name	Full name of the voter.
age	Age of the voter.