License OCR V2

Endpoint Overview

POST /api/v1/ocr/license-v2

Description

This API endpoint processes images of a driver's license (both front and back sides) and extracts key information into a structured format. The service uses advanced OCR (Optical Character Recognition) technology to accurately identify and extract license details including the license number, holder's name, date of birth, and address information.

Key Benefits

Eliminates manual data entry errors and reduces processing time for license verification

Supports multiple input formats (direct image upload, base64 encoding, or image URL)

Provides standardized data output for easy integration with identity verification workflows

Helps meet KYC (Know Your Customer) compliance requirements with accurate document processing

Use Cases

Financial Services

Transportation & Logistics

Government & Public Sector

Customer onboarding for banking and financial applications

Identity verification for loan or credit card applications

Regulatory compliance for financial institutions requiring KYC

Technical Implementation

Authentication

All API requests require authentication using a JWT Bearer token. Authentication follows these steps:

Obtain API Credentials: Register with Surepass to receive your API key.

Generate JWT Token: Use your API key to generate a JWT token.

Include in Requests: Add the token to the Authorization header as Bearer TOKEN.

Different authentication tokens are used for sandbox and production environments:

Sandbox: https://sandbox.surepass.io

Production: https://kyc-api.surepass.io

Request Parameters

Request Headers

Header	Required	Description
Authorization	Yes	Bearer token authentication using JWT
Content-Type	Yes	Must be `multipart/form-data` for direct image upload or `application/json` for base64/URL inputs

Request Body

The API supports three different methods to submit license images:

Method 1: Direct Image Upload

Parameter	Type	Required	Description
front	Image	Yes	Front side image of the driver's license
back	Image	Yes	Back side image of the driver's license

Method 2: Base64 Encoded Images

Parameter	Type	Required	Description
front_base64	String	Yes	Base64 encoded string of the front side image
back_base64	String	Yes	Base64 encoded string of the back side image

Method 3: Image URLs

Parameter	Type	Required	Description
front_link	String	Yes	URL/link to the front side image of the license
back_link	String	Yes	URL/link to the back side image of the license

Example Request (using Image URLs)

{
  "front_link": "https://example.com/license-front.jpg",
  "back_link": "https://example.com/license-back.jpg"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains the extracted license information
data.client_id	String	Unique identifier for the OCR request
data.license_number	String	Extracted license number
data.dob	String	Date of birth in YYYY-MM-DD format
data.address	String	Full address extracted from the license
data.name	String	Full name of the license holder
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the request was successful
message	String	Additional information or error message (null if successful)
message_code	String	Code indicating the status of the request

Example Successful Response

{
    "data": {
        "client_id": "ocr_license_v2_peMjfqmmkooUlVNFzhWw",
        "license_number": "UP12 20200123456",
        "dob": "2000-07-20",
        "address": "SOUTH CIVIL LINE, Muzaffarnagar, UP 251001",
        "name": "SUDHANSHU"
    },
    "status_code": 200,
    "success": true,
    "message": null,
    "message_code": "success"
}

Possible Error Responses

Authentication Error

Invalid Image

Invalid File Format

Server Error

{
    "error": null,
    "message": "Your token is invalid. Please ensure that correct token is being used.",
    "status_code": 401,
    "success": false,
    "message_code": "invalid_token"
}

Occurs when the JWT token is missing, invalid, or expired.

Integration Best Practices

Security Recommendations

Store JWT tokens securely and never expose them in client-side code

Implement proper error handling to avoid exposing sensitive information

Use HTTPS for all API communications to ensure data is encrypted in transit

Implement token rotation and refresh mechanisms for long-running applications

User Experience Guidelines

Provide clear instructions to users on how to capture high-quality license images

Implement a preview feature to allow users to verify image quality before submission

Display a loading indicator during OCR processing to indicate activity

Implement proper validation and error messaging for a smooth user experience

Code Samples

cURL

Python

Node.js

Related APIs

OCR PAN Card API: Extracts information from PAN cards for identity verification

OCR Aadhaar Card API: Processes Aadhaar cards and extracts personal information

OCR Voter ID API: Extracts information from Voter ID cards

Face Match API: Compares a person's face with their ID document for verification

Compliance and Legal Considerations

When implementing this API, ensure you comply with data protection regulations such as GDPR, CCPA, or local data privacy laws. Obtain proper consent from users before processing their ID documents. Store extracted personal information securely and only for the duration necessary for your service. Consider implementing data minimization practices to only collect information that is essential for your business purpose.

{ "data": { "client_id": "ocr_license_v2_peMjfqmmkooUlVNFzhWw", "license_number": "UP12 20200123456", "dob": "2000-07-20", "address": "SOUTH CIVIL LINE, Muzaffarnagar, UP 251001", "name": "SUDHANSHU" }, "status_code": 200, "success": true, "message": null, "message_code": "success" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

License OCR V2

License OCR V2#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Method 1: Direct Image Upload#

Method 2: Base64 Encoded Images#

Method 3: Image URLs#

Example Request (using Image URLs)#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

License OCR V2

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Method 1: Direct Image Upload

Method 2: Base64 Encoded Images

Method 3: Image URLs

Example Request (using Image URLs)

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples