Passport Upload

Endpoint Overview

POST /api/v1/ocr/passport

Description

This API endpoint extracts and validates information from passport documents using Optical Character Recognition (OCR) technology. It processes both front and back sides of passports, extracting key details such as personal information, address, file number, and family details with confidence scores for each extracted field.

Key Benefits

Automated extraction of passport data with high accuracy, reducing manual data entry errors

Confidence scores for each extracted field to help assess data reliability

Comprehensive extraction of both personal and address information from passport documents

Seamless integration into existing KYC and onboarding workflows

Use Cases

Financial Services

Travel & Hospitality

Government & Public Services

Customer onboarding for banking and financial institutions

KYC verification for investment platforms and wealth management services

Identity verification for loan and credit card applications

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

Request Body Formats

1. For File Upload

Parameter	Type	Required	Description
file	Image	Yes	Upload Cheque Image
use_pdf	Boolean	No	Set to true if the file type is PDF

2. For Base64 Input

Parameter	Type	Required	Description
base_64	String	Yes	Cheque Image in Base64 format

3. For Image URL Input

Parameter	Type	Required	Description
link	String	Yes	Cheque Image Link/URL

Example Request

# Multipart form data
file: [passport_image.jpg]

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains the extracted information and client identification
data.client_id	String	Unique identifier for the OCR request
data.ocr_fields	Array	List of extracted field objects
data.ocr_fields[].document_type	String	Type of document processed (e.g., passport_back)
data.ocr_fields[].address	Object	Extracted address information with value and confidence score
data.ocr_fields[].father	Object	Father's name with value and confidence score
data.ocr_fields[].mother	Object	Mother's name with value and confidence score
data.ocr_fields[].file_num	Object	Passport file number with value and confidence score
data.ocr_fields[].old_doi	Object	Old date of issue with value and confidence score
data.ocr_fields[].old_passport_num	Object	Old passport number with value and confidence score
data.ocr_fields[].old_place_of_issue	Object	Old place of issue with value and confidence score
data.ocr_fields[].pin	Object	PIN/Postal code with value and confidence score
data.ocr_fields[].spouse	Object	Spouse's name 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 information about the response (null if successful)
message_code	String	Code indicating the status of the request

Example Successful Response

{
    "data": {
        "client_id": "ocr_passport_fSdixDiwGPhybykSTRdf",
        "ocr_fields": [
            {
                "document_type": "passport_back",
                "address": {
                    "value": "TRIPATHI HAVELI, MIRZAPUR, UTTAR PRADESH",
                    "confidence": 94
                },
                "father": {
                    "value": "Kaleen Bhaiya",
                    "confidence": 94
                },
                "mother": {
                    "value": "Bina Devi",
                    "confidence": 91
                },
                "file_num": {
                    "value": "DL1061961923456",
                    "confidence": 91
                },
                "old_doi": {
                    "value": "",
                    "confidence": 0
                },
                "old_passport_num": {
                    "value": "",
                    "confidence": 0
                },
                "old_place_of_issue": {
                    "value": "",
                    "confidence": 0
                },
                "pin": {
                    "value": "231001",
                    "confidence": 94
                },
                "spouse": {
                    "value": "",
                    "confidence": 0
                }
            }
        ]
    },
    "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 passport images

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

Display a loading indicator during OCR processing to inform users of ongoing operations

Implement field validation based on confidence scores to prompt users for verification of low-confidence fields

Code Samples

cURL

Python

Node.js

Related APIs

OCR Aadhaar Card: Extract information from Aadhaar cards using OCR

OCR PAN Card: Extract information from PAN cards using OCR

OCR Driving License: Extract information from driving licenses using OCR

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

Compliance and Legal Considerations

When using this API, ensure compliance with data protection regulations such as GDPR, PDPA, or other applicable laws in your jurisdiction. Always obtain explicit user consent before processing passport data, and ensure proper data handling and storage practices. The API includes consent parameters to help maintain compliance with these regulations.

{ "data": { "client_id": "ocr_passport_fSdixDiwGPhybykSTRdf", "ocr_fields": [ { "document_type": "passport_back", "address": { "value": "TRIPATHI HAVELI, MIRZAPUR, UTTAR PRADESH", "confidence": 94 }, "father": { "value": "Kaleen Bhaiya", "confidence": 94 }, "mother": { "value": "Bina Devi", "confidence": 91 }, "file_num": { "value": "DL1061961923456", "confidence": 91 }, "old_doi": { "value": "", "confidence": 0 }, "old_passport_num": { "value": "", "confidence": 0 }, "old_place_of_issue": { "value": "", "confidence": 0 }, "pin": { "value": "231001", "confidence": 94 }, "spouse": { "value": "", "confidence": 0 } } ] }, "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 ********************

Passport Upload

Passport Upload#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Request Body Formats#

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

Passport Upload

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Request Body Formats

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