Aadhaar Upload

Endpoint Overview

POST /api/v1/ocr/aadhaar

Description

This API endpoint performs Optical Character Recognition (OCR) on Aadhaar card images to extract key information such as the cardholder's name, gender, date of birth, and Aadhaar number. It supports processing of the front side of Aadhaar cards and returns structured data with confidence scores for each extracted field.

Key Benefits

Automated extraction of Aadhaar card details with high accuracy

Confidence scores for each extracted field to assess reliability

Support for both masked and unmasked Aadhaar numbers

Streamlined KYC processes with minimal manual intervention

Use Cases

Financial Services

Telecom

Government Services

Customer onboarding for banking and financial institutions

Loan application processing with automated identity verification

Account opening procedures with reduced manual data entry

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	JWT Bearer token for authentication. Format: `Bearer <your_token>`
Content-Type	Yes	Must be set to `multipart/form-data`

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

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Container for the OCR results
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 detected (e.g., "aadhaar_front_bottom")
data.ocr_fields[].full_name	Object	Extracted name with value and confidence score
data.ocr_fields[].gender	Object	Extracted gender with value and confidence score
data.ocr_fields[].mother_name	Object	Extracted mother's name if available
data.ocr_fields[].dob	Object	Extracted date of birth in YYYY-MM-DD format with confidence score
data.ocr_fields[].aadhaar_number	Object	Extracted Aadhaar number with confidence score and masking status
data.ocr_fields[].image_url	String	URL to the processed image (if available)
data.ocr_fields[].uniqueness_id	String	Unique identifier for the document (if available)
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the request was successful
message	String	Additional information about the response (if any)
message_code	String	Code indicating the status of the request

Example Successful Response

{
    "data": {
        "client_id": "ocr_aadhaar_MRIosSXyczVbedsZvElu",
        "ocr_fields": [
            {
                "document_type": "aadhaar_front_bottom",
                "full_name": {
                    "value": "Munna Bhaiya",
                    "confidence": 91
                },
                "gender": {
                    "value": "M",
                    "confidence": 91
                },
                "mother_name": {
                    "value": null,
                    "confidence": null
                },
                "dob": {
                    "value": "1990-01-01",
                    "confidence": 93
                },
                "aadhaar_number": {
                    "value": "123456789010",
                    "confidence": 91,
                    "is_masked": false
                },
                "image_url": null,
                "uniqueness_id": null
            }
        ]
    },
    "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 for capturing high-quality Aadhaar card images

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

Display a loading indicator during OCR processing to indicate progress

Implement validation of 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

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

Voter ID OCR: Extract information from Voter ID cards using OCR technology

Passport OCR: Extract information from passports using OCR technology

Compliance and Legal Considerations

When handling Aadhaar data, ensure compliance with the Aadhaar Act, 2016 and UIDAI regulations. Do not store Aadhaar numbers unless explicitly permitted by law and with proper consent from users. Implement appropriate data protection measures as required by the Information Technology Act and other applicable regulations. Always obtain explicit user consent before processing Aadhaar information.

{ "data": { "client_id": "ocr_aadhaar_MRIosSXyczVbedsZvElu", "ocr_fields": [ { "document_type": "aadhaar_front_bottom", "full_name": { "value": "Munna Bhaiya", "confidence": 91 }, "gender": { "value": "M", "confidence": 91 }, "mother_name": { "value": null, "confidence": null }, "dob": { "value": "1990-01-01", "confidence": 93 }, "aadhaar_number": { "value": "123456789010", "confidence": 91, "is_masked": false }, "image_url": null, "uniqueness_id": null } ] }, "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 ********************

Aadhaar Upload

Aadhaar Upload#

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

Aadhaar Upload

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