Verify Passport

Endpoint Overview

POST /api/v1/passport/passport/verify

Description

This endpoint performs verification checks on a previously uploaded passport document. It extracts and validates key information from the passport, including personal details, document numbers, and MRZ (Machine Readable Zone) data. The verification process helps confirm the authenticity of the passport and extracts structured data for identity verification purposes.

The API supports various upload scenarios: combined front and back images, or individual front and back images. For multiple images, the endpoint should be called separately for each image.

Key Benefits

Automated extraction of passport data eliminates manual data entry errors

Comprehensive verification of passport authenticity and validity

Structured data output for seamless integration with identity verification workflows

Support for different passport image formats (combined or individual pages)

Use Cases

Financial Services

Travel & Hospitality

Government & Public Services

KYC verification during customer onboarding for banking and financial services

Identity verification for high-value transactions and account openings

Regulatory compliance for anti-money laundering (AML) requirements

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 `application/json`

Request Body

Parameter	Type	Required	Description
client_id	String	Yes	Unique identifier for this verification request. This ID helps track the verification process and retrieve results.

Example Request

{
    "client_id": "TTJmMxbZQi"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains all extracted passport information
data.doe	String	Date of expiry in YYYY-MM-DD format
data.dob	String	Date of birth in YYYY-MM-DD format
data.father	String	Father's name as listed in the passport
data.given_name	String	First name of the passport holder
data.mrz_line_1	String	First line of the Machine Readable Zone
data.old_passport_num	String	Previous passport number if available
data.file_num	String	File number associated with the passport
data.client_id	String	The client ID provided in the request
data.place_of_issue	String	Location where the passport was issued
data.spouse	String	Spouse's name if available
data.country_code	String	Three-letter country code (e.g., "IND" for India)
data.address	String	Address of the passport holder
data.surname	String	Last name of the passport holder
data.mrz_line_2	String	Second line of the Machine Readable Zone
data.passport_num	String	Current passport number
data.doi	String	Date of issue in YYYY-MM-DD format
data.old_doi	String	Date of issue of previous passport if available
data.gender	String	Gender of the passport holder (e.g., "MALE", "FEMALE")
data.nationality	String	Nationality of the passport holder
data.place_of_birth	String	Place of birth of the passport holder
data.mother	String	Mother's name as listed in the passport
data.old_place_of_issue	String	Place where previous passport was issued
data.pin	String	PIN code/postal code of the address
status_code	Integer	HTTP status code indicating the result of the operation
message	String	Additional information or error message
success	Boolean	Indicates whether the verification was successful

Example Successful Response

{
    "data": {
        "doe": "2020-09-15",
        "dob": "1990-08-31",
        "father": "KALEEN BHAIYA",
        "given_name": "MUNNA BHAIYA",
        "mrz_line_1": "PPINDBHAIYA<<MUNNA<<<<<<<<<<<<<<<<<<<<<<<<<<",
        "old_passport_num": "F0233736",
        "file_num": "UPHM00597710",
        "client_id": "TTJmMxbZQi",
        "place_of_issue": "MIRZAPUR",
        "spouse": "",
        "country_code": "IND",
        "address": "TRIPATHI HAVELI, MIRZAPUR",
        "surname": "BAGGA",
        "mrz_line_2": "J0933933<1IND9008319M2009155<<<<<<<<<<<<<<04",
        "passport_num": "J0933836",
        "doi": "2010-10-15",
        "old_doi": "2005-10-15",
        "gender": "MALE",
        "nationality": "INDIAN",
        "place_of_birth": " MIRZAPUR",
        "mother": "BEENA TRIPATHI",
        "old_place_of_issue": "MIRZAPUR",
        "pin": "231001"
    },
    "status_code": 200,
    "message": "",
    "success": true
}

Possible Error Responses

Authentication Error

Invalid Request

Document Not Found

{
    "data": null,
    "status_code": 401,
    "message": "Invalid or expired authentication token",
    "success": false
}

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 proper error handling to manage failed verification attempts

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

Implement rate limiting on your end to prevent abuse of the API

User Experience Guidelines

Provide clear instructions to users on how to capture high-quality passport images

Implement a progress indicator during the verification process

Display friendly error messages when verification fails

Allow users to retry document upload if verification is unsuccessful

Code Samples

cURL

Python

Node.js

Related APIs

Passport Upload API: Allows uploading passport images for verification

Passport OCR API: Extracts text from passport images without verification

Document Verification Status API: Checks the status of a verification request

Compliance and Legal Considerations

When implementing passport verification, be aware of data protection regulations such as GDPR, CCPA, or local data privacy laws. Ensure you have proper consent from users before processing their passport data. Store extracted passport information securely and only for the duration necessary for your business purposes. Consider implementing data retention policies that comply with relevant regulations.

{ "data": { "doe": "2020-09-15", "dob": "1990-08-31", "father": "KALEEN BHAIYA", "given_name": "MUNNA BHAIYA", "mrz_line_1": "PPINDBHAIYA<<MUNNA<<<<<<<<<<<<<<<<<<<<<<<<<<", "old_passport_num": "F0233736", "file_num": "UPHM00597710", "client_id": "TTJmMxbZQi", "place_of_issue": "MIRZAPUR", "spouse": "", "country_code": "IND", "address": "TRIPATHI HAVELI, MIRZAPUR", "surname": "BAGGA", "mrz_line_2": "J0933933<1IND9008319M2009155<<<<<<<<<<<<<<04", "passport_num": "J0933836", "doi": "2010-10-15", "old_doi": "2005-10-15", "gender": "MALE", "nationality": "INDIAN", "place_of_birth": " MIRZAPUR", "mother": "BEENA TRIPATHI", "old_place_of_issue": "MIRZAPUR", "pin": "231001" }, "status_code": 200, "message": "", "success": true }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Verify Passport

Verify Passport#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Request Body#

Example Request#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses

Verify Passport

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples