PAN Upload

Endpoint Overview

POST /api/v1/ocr/pan

Description

This API endpoint allows you to upload and extract information from a PAN (Permanent Account Number) card image using OCR (Optical Character Recognition) technology. The service automatically detects and extracts key information from the PAN card including the PAN number, cardholder's full name, father's name, and date of birth, along with confidence scores for each extracted field.

Key Benefits

Automated extraction of PAN card details with high accuracy

Confidence scores for each extracted field to assess reliability

Reduced manual data entry and associated human errors

Faster KYC processing and customer onboarding

Use Cases

Financial Services

Insurance

HR & Employment

Account opening and KYC verification for banks and financial institutions

Customer onboarding for investment platforms and wealth management services

Loan application processing and identity 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

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Container for the response data
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 (always "pan" for this endpoint)
data.ocr_fields[].pan_number	Object	Contains the extracted PAN number and confidence score
data.ocr_fields[].full_name	Object	Contains the extracted full name and confidence score
data.ocr_fields[].father_name	Object	Contains the extracted father's name and confidence score
data.ocr_fields[].dob	Object	Contains the extracted date of birth and confidence score
status_code	Integer	HTTP status code of the response
message_code	String	Status message code
message	String	Additional message information (null if successful)
success	Boolean	Indicates if the request was successful

Example Successful Response

{
    "data": {
        "client_id": "pan_photo_mesSqeyCjoohnpbdxerB",
        "ocr_fields": [
            {
                "document_type": "pan",
                "pan_number": {
                    "value": "ABCPD1234E",
                    "confidence": 99
                },
                "full_name": {
                    "value": "Munna Bhaiya",
                    "confidence": 99
                },
                "father_name": {
                    "value": "Kaleen Bhaiya",
                    "confidence": 99
                },
                "dob": {
                    "value": "01/01/1990",
                    "confidence": 99
                }
            }
        ]
    },
    "status_code": 200,
    "message_code": "success",
    "message": null,
    "success": true
}

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 token refresh mechanisms to handle token expiration

Use HTTPS for all API communications to ensure data encryption in transit

Implement proper error handling to avoid exposing sensitive information

User Experience Guidelines

Provide clear instructions to users about acceptable PAN card image quality

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

Display a loading indicator during the OCR process to indicate progress

Allow users to manually correct OCR results if confidence scores are low

Code Samples

cURL

Python

Node.js

Related APIs

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

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

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

PAN Verification API: Verify PAN details against government databases

Compliance and Legal Considerations

PAN card information is sensitive personal data and must be handled in accordance with applicable data protection laws

Ensure compliance with the Information Technology Act, 2000 and the Personal Data Protection Bill

Obtain explicit consent from users before processing their PAN card information

Implement appropriate data retention and deletion policies for PAN card data

{ "data": { "client_id": "pan_photo_mesSqeyCjoohnpbdxerB", "ocr_fields": [ { "document_type": "pan", "pan_number": { "value": "ABCPD1234E", "confidence": 99 }, "full_name": { "value": "Munna Bhaiya", "confidence": 99 }, "father_name": { "value": "Kaleen Bhaiya", "confidence": 99 }, "dob": { "value": "01/01/1990", "confidence": 99 } } ] }, "status_code": 200, "message_code": "success", "message": null, "success": true }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

PAN Upload

PAN Upload#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

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

PAN Upload

Description

Use Cases

Technical Implementation

Request Headers

Request Body

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