VoterID OCR

Endpoint Overview

POST /api/v1/ocr/voter

Description

This API endpoint performs Optical Character Recognition (OCR) on Voter ID card images, extracting key information such as the voter's name, age, gender, and EPIC number. The service processes the uploaded image and returns structured data with confidence scores for each extracted field, enabling automated data capture from Voter ID documents.

Key Benefits

Eliminates manual data entry by automatically extracting information from Voter ID cards

Provides confidence scores for each extracted field to help assess data reliability

Supports both front side of Voter ID cards with comprehensive field extraction

Reduces KYC processing time and improves accuracy in voter verification workflows

Use Cases

Financial Services

Government Services

Digital Platforms

KYC verification during account opening or loan applications

Identity verification for financial transactions

Customer onboarding automation with document verification

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 for authentication. Format: `Bearer {your_jwt_token}`
Content-Type	Yes	Must be set to `multipart/form-data` for file upload

Request Body

1. For File Upload

Parameter	Type	Description
file	Image	Upload Cheque Image
use_pdf	Boolean	If the file type is PDF, set this to true

2. For Base64 Input

Parameter	Type	Description
base_64	String	Cheque Image in Base64 format

3. For Image URL Input

Parameter	Type	Description
link	String	Cheque Image Link/URL

Example Request

# Multipart form data with file upload
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW

------WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="file"; filename="voter_id_front.jpg"
Content-Type: image/jpeg

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains the extracted information and client details
data.client_id	String	Unique identifier for the OCR request
data.ocr_fields	Array	List of extracted document information
data.ocr_fields[].document_type	String	Type of document processed (voterid_front)
data.ocr_fields[].full_name	Object	Extracted name with value and confidence score
data.ocr_fields[].age	Object	Extracted age with value and confidence score
data.ocr_fields[].care_of	Object	Extracted care of details with value and confidence score
data.ocr_fields[].dob	Object	Extracted date of birth with value and confidence score
data.ocr_fields[].doc	Object	Document issue date with value and confidence score
data.ocr_fields[].gender	Object	Extracted gender with value and confidence score
data.ocr_fields[].epic_number	Object	Extracted EPIC number with value and confidence score
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the API call was successful
message	String	Additional message (null if successful)
message_code	String	Code indicating the status of the request

Example Successful Response

{
    "data": {
        "client_id": "ocr_voter_skdzmnvczTmyvkAkdmfa",
        "ocr_fields": [
            {
                "document_type": "voterid_front",
                "full_name": {
                    "value": "Munna Bhaiya",
                    "confidence": 92
                },
                "age": {
                    "value": "30",
                    "confidence": 95
                },
                "care_of": {
                    "value": "Kaleen Bhaiya",
                    "confidence": 97
                },
                "dob": {
                    "value": "1990-01-01",
                    "confidence": 76
                },
                "doc": {
                    "value": "2020-01-01",
                    "confidence": 0
                },
                "gender": {
                    "value": "M",
                    "confidence": 84
                },
                "epic_number": {
                    "value": "WSN0123456",
                    "confidence": 95
                }
            }
        ]
    },
    "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 encryption in transit

Implement token refresh mechanisms to handle token expiration gracefully

User Experience Guidelines

Provide clear instructions to users on how to capture a high-quality image of their Voter ID

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

Display a loading indicator during OCR processing to indicate activity

Implement field validation on the extracted data and allow users to correct any inaccuracies

Code Samples

cURL

Python

Node.js

Related APIs

PAN Card OCR: Extract information from PAN cards using OCR technology

Aadhaar Card OCR: Extract information from Aadhaar cards using OCR technology

Driving License OCR: Extract information from driving licenses using OCR technology

Passport OCR: Extract information from passports using OCR technology

Compliance and Legal Considerations

When implementing this API, ensure you comply with data protection regulations such as GDPR or local data privacy laws. Always obtain explicit user consent before processing their Voter ID documents. The API includes a mandatory consent parameter to help maintain compliance. Store extracted data securely and only for the duration necessary for your business purpose.

{ "data": { "client_id": "ocr_voter_skdzmnvczTmyvkAkdmfa", "ocr_fields": [ { "document_type": "voterid_front", "full_name": { "value": "Munna Bhaiya", "confidence": 92 }, "age": { "value": "30", "confidence": 95 }, "care_of": { "value": "Kaleen Bhaiya", "confidence": 97 }, "dob": { "value": "1990-01-01", "confidence": 76 }, "doc": { "value": "2020-01-01", "confidence": 0 }, "gender": { "value": "M", "confidence": 84 }, "epic_number": { "value": "WSN0123456", "confidence": 95 } } ] }, "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 ********************

VoterID Upload

VoterID OCR#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

1. For File Upload#

2. For Base64 Input#

3. For Image URL Input#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses