This is the pre-configured journey a business could use to perform KYC OCR. The following documents could be digitised through this API.

Aadhaar OCR
PAN OCR
Driving Licence OCR
Voter ID OCR

Journey Input and Output

Journeys	Input	Output
Aadhaar OCR Verification	1. Aadhaar front image (Base 64 or URL) 2. Aadhaar back image (Base 64 or URL)	1. Aadhaar Number 2. Full Name as per Aadhaar
PAN OCR Verification	1. PAN Front Image (Base 64 or URL)*	1. PAN Number 2. Full Name as per PAN 3. D.O.B 4. Father’s Name
Driving Licence OCR Verification	1. Driving Licence front image (Base 64 or URL) 2. Driving Licence back image (Base 64 or URL)	1. Full name as per driving licence 2. DL Number 3. D.O.B 4. Gender 5. Father’s Name 6. Permanent Address 7. Blood group
Voter ID OCR Verification	1. Voter ID Front Image (Base 64 or URL) 2. Voter ID Back Image (Base 64 or URL)	1. Full Name 2. EPIC Number 3. D.O.B 4. Gender 5. Full Address 6. Age 7. Family Member Name 8. 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.

Ownership Check
Document Tampering Check
Source Verification Check
Photocopy Check

Journey Input Data

{
    "journey_id": "kyc_ocr_dev_test_v1",
    "transaction_id": "",
    "input_data": {
        "doc_front_url":"",
        "doc_back_url":"",
        "doc_front_base64":"",
        "doc_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": [
        {
          "aadhaar_no": "XXXX",
          "name": "XXXX XXX",
          "address": "XXXX XXXX XXXX XXXX",
          "gender": "XXXXX",
          "source": "nsdl",
          "issuer": "",
          "decision": "",
          "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",
  "decision": "CLEAR|MUST REVIEW|NEEDS REVIEW",
  "checks": [],
  "data": {
    "keys": {
      "pan": [
        {
          "father_name": "KIRTIKUMAR RAMESHCHANDRA GANDH",
          "dob": "20-11-2002",
          "pan_number": "DUCPG2368L",
          "date_of_issue": "",
          "name": "VATSAL KIRTIKUMAR GANDHI",
          "pan_type": "Individual",
          "issuer": "",
          "decision": "",
          "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",
  "decision": "CLEAR|MUST REVIEW|NEEDS REVIEW",
  "checks": [],
  "data": {
    "keys": {
      "dl": [
        {
          "expiry_date": "02/08/2037",
          "authorized_to_drive": [],
          "verification_type": "OCR",
          "transport_expiry_date": null,
          "dl_no": "TS01020170011169",
          "issuer_name": "Ministry of Road Transport and Highways",
          "dob": "27/05/1997",
          "name": "ANURADHA P",
          "issuer": "",
          "decision": "",
          "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",
  "decision": "CLEAR|MUST REVIEW|NEEDS REVIEW",
  "checks": [],
  "data": {
    "keys": {
      "voter_id": [
        {
          "gender": "Female",
          "epic_number": "JSF0039156",
          "address": "64 , RAHULANAGAR , KATAPUY VILLAGE KATAPUR RAHUL NAGAR TALUKA PAITHAN BAMICA ICICA DISTRICT AURANGABAD- 43 1440 HAER FIGUR STEERI 195- A",
          "dob": "",
          "name_of_relative": "Lakshmanarav Suryanarayan",
          "name": "Arunabai Lakshmanarav Suryanarayan",
          "address_pincode": "431140",
          "issuer": "",
          "decision": "",
          "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_file_uploaded	Invalid file. Please upload a PAN Card, Aadhaar Card, Driving License, or Voter ID
When no details found at Source for given PAN/Aadhaar/ Driving Licence/ Voter ID Image	200	FAILURE	document_not_found	Entity not found
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	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.