International Passport V2

Endpoint Overview

POST /api/v1/ocr/international-passport-v2

Description

The International Passport OCR API V2 extracts detailed information from international passports using advanced Optical Character Recognition (OCR) technology. This endpoint processes passport images or PDFs and returns structured data including personal details, document information, and Machine Readable Zone (MRZ) content. The service supports various passport formats from different countries and provides accurate extraction of critical identity information.

Key Benefits

Automated extraction of over 20 passport data fields with high accuracy

Support for both image and PDF passport documents

MRZ data extraction and validation for enhanced verification

Streamlined identity verification for KYC and onboarding processes

Use Cases

Financial Services

Travel & Hospitality

Government & Immigration

Customer onboarding for banking and financial institutions

KYC verification for investment platforms and cryptocurrency exchanges

Fraud prevention during account opening processes

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 format
Content-Type	Yes	multipart/form-data

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

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Container for the extracted passport information
data.client_id	String	Unique identifier for the OCR request
data.passport_type	String	Type of passport (e.g., international_passport)
data.passport_number	String	The passport's identification number
data.country	String	Country that issued the passport
data.surname	String	Last name of the passport holder
data.given_names	String	First and middle names of the passport holder
data.nationality	String	Nationality of the passport holder
data.nationality_code	String	Three-letter code representing the nationality
data.sex	String	Gender of the passport holder (M/F)
data.date_of_birth	String	Birth date in YYYY-MM-DD format
data.place_of_birth	String	Location where the passport holder was born
data.issuing_authority	String	Organization that issued the passport
data.issue_date	String	Date when the passport was issued (YYYY-MM-DD)
data.expiry_date	String	Date when the passport expires (YYYY-MM-DD)
data.code	String	Additional code associated with the passport (if available)
data.type	String	Type classification of the passport
data.height	String	Height of the passport holder (if available)
data.personal_code_number	String	Personal identification code (if available)
data.country_code	String	Country code from the passport (if available)
data.profession	String	Profession of the passport holder (if available)
data.mrz_line_1	String	First line of the Machine Readable Zone
data.mrz_line_2	String	Second line of the Machine Readable Zone
status_code	Integer	HTTP status code of the response
success	Boolean	Indicates if the request was successful
message	String	Human-readable status message
message_code	String	Machine-readable status code

Example Successful Response

{
    "data": {
        "client_id": "ocr_international_passport_v2_fPxSdoAgvlNptLHmYDPu",
        "passport_type": "international_passport",
        "passport_number": "N 0148412345",
        "country": "SYRIAN ARAB REPUBLIC",
        "surname": "SHEHADEH",
        "given_names": "AMMAR",
        "nationality": "SYRIAN ARAB REPUBLIC",
        "nationality_code": "SYR",
        "sex": "M",
        "date_of_birth": "1988-06-01",
        "place_of_birth": "DAMASCUS",
        "issuing_authority": "INTERIOR-DEPARTMENT OF IMMIGRATION AND PASSPORTS",
        "issue_date": "2021-10-23",
        "expiry_date": "2024-04-22",
        "code": null,
        "type": "Type Coy",
        "height": null,
        "personal_code_number": null,
        "country_code": null,
        "profession": null,
        "mrz_line_1": "PNSYRSHEHADEH<<AMMAR<<<<<<<<<<<",
        "mrz_line_2": "0148421ABCD12348806013M2404222010<20120024<<24"
    },
    "status_code": 200,
    "success": true,
    "message": "Success",
    "message_code": "success"
}

Possible Error Responses

Authentication Error

Invalid File

OCR Processing Error

{
    "status_code": 401,
    "success": false,
    "message": "Invalid or expired token",
    "message_code": "unauthorized"
}

This error 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 rotation and expiration policies

Use HTTPS for all API communications

Implement proper error handling to avoid exposing sensitive information

User Experience Guidelines

Provide clear instructions for passport image capture (good lighting, no glare)

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

Display a loading indicator during OCR processing

Offer manual data entry as a fallback if OCR fails

Code Samples

cURL

Python

Node.js

Related APIs

OCR ID Card - Extracts information from national ID cards

OCR Driving License - Extracts information from driving licenses

Face Match - Compares passport photo with selfie for identity verification

Document Verification - Verifies the authenticity of passport documents

Compliance and Legal Considerations

When implementing this API, ensure compliance with data protection regulations such as GDPR, CCPA, or other regional privacy laws. Personal data extracted from passports should be handled securely, stored only as long as necessary, and used only for the stated purpose. Users should be informed about how their passport data will be processed and stored. Additionally, some jurisdictions may have specific requirements for handling identity documents and biometric data.

{ "data": { "client_id": "ocr_international_passport_v2_fPxSdoAgvlNptLHmYDPu", "passport_type": "international_passport", "passport_number": "N 0148412345", "country": "SYRIAN ARAB REPUBLIC", "surname": "SHEHADEH", "given_names": "AMMAR", "nationality": "SYRIAN ARAB REPUBLIC", "nationality_code": "SYR", "sex": "M", "date_of_birth": "1988-06-01", "place_of_birth": "DAMASCUS", "issuing_authority": "INTERIOR-DEPARTMENT OF IMMIGRATION AND PASSPORTS", "issue_date": "2021-10-23", "expiry_date": "2024-04-22", "code": null, "type": "Type Coy", "height": null, "personal_code_number": null, "country_code": null, "profession": null, "mrz_line_1": "PNSYRSHEHADEH<<AMMAR<<<<<<<<<<<", "mrz_line_2": "0148421ABCD12348806013M2404222010<20120024<<24" }, "status_code": 200, "success": true, "message": "Success", "message_code": "success" }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

International Passport V2

International Passport V2#

Description#

Use Cases#

Technical Implementation#

Request Headers#

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

International Passport V2

Description

Use Cases

Technical Implementation

Request Headers

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