Passport Details

Endpoint Overview

POST /api/v1/passport/passport/passport-details

Description

This API endpoint allows you to retrieve detailed passport information from the official passport database using a file number and date of birth. It provides verified passport details including the passport number, full name of the passport holder, and date of application, enabling secure identity verification based on official government records.

Key Benefits

Verify passport authenticity using official government database records

Reduce identity fraud by cross-checking submitted passport details

Streamline KYC processes with reliable passport verification

Eliminate manual verification steps and reduce processing time

Use Cases

Financial Services

Travel & Hospitality

Digital Services

Customer onboarding for banking and financial institutions

Identity verification for high-value transactions

Compliance with KYC regulations for new account openings

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
Content-Type	Yes	application/json

Request Body

Parameter	Type	Required	Description
file_number	String	Yes	File Number as provided in the passport application
dob	String	Yes	Date of Birth in YYYY-MM-DD format

Example Request

{
    "file_number": "DL1061291XXXXXX",
    "dob": "1990-01-01"
}

Process Response

Response Parameters

Parameter	Type	Description
status_code	Integer	HTTP status code of the response
data	Object	Container for passport details
data.file_number	String	File Number as provided in the request
data.dob	String	Date of Birth in YYYY-MM-DD format
data.full_name	String	Full name of the passport holder as per passport database
data.passport_number	String	Passport number as per passport database
data.date_of_application	String	Date of passport application in YYYY-MM-DD format
data.client_id	String	Unique client identifier
message_code	String	Status message code
success	Boolean	Indicates if the request was successful
message	String	Additional message information (null if successful)

Example Successful Response

{
    "status_code": 200,
    "data": {
        "date_of_application": "2017-07-24",
        "file_number": "DL1061291XXXXXX",
        "client_id": "passport_rfqevMkcqenNPushfhfM",
        "full_name": "MUNNA BHAIYA",
        "passport_number": "S2420000",
        "dob": "1990-01-01"
    },
    "message_code": "success",
    "success": true,
    "message": null
}

Possible Error Responses

Invalid Credentials

Invalid Parameters

Record Not Found

{
    "status_code": 401,
    "data": null,
    "message_code": "unauthorized",
    "success": false,
    "message": "Invalid credentials provided"
}

This error occurs when the JWT token is invalid, expired, or not provided.

Integration Best Practices

Security Recommendations

Store API credentials 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

Implement request throttling to prevent brute force attacks

User Experience Guidelines

Provide clear error messages to users when verification fails

Implement a retry mechanism with guidance on correct information format

Consider caching verified passport details (in compliance with regulations)

Display a loading indicator during API calls to improve perceived performance

Code Samples

cURL

Python

Node.js

Related APIs

Passport OCR Verification: Extract and verify information from passport images

Passport eKYC: Complete electronic Know Your Customer verification using passport

Document Verification: Verify multiple identity documents including passport

Compliance and Legal Considerations

This API accesses official passport records and must be used in compliance with data protection regulations. Ensure you have proper consent from users before verifying their passport details. Usage of this API may be subject to audit by regulatory authorities. Store verification results securely and in accordance with applicable data retention policies.

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

curl --location --request POST 'https://kyc-api.surepass.app/api/v1/passport/passport/passport-details' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "id_number": "{{file_number}}", "dob": "{{dob}}" }'

{ "status_code": 200, "data": { "date_of_application": "2017-07-24", "file_number": "DL1061291XXXXXX", "client_id": "passport_rfqevMkcqenNPushfhfM", "full_name": "MUNNA BHAIYA", "passport_number": "S2420000", "dob": "1990-01-01" }, "message_code": "success", "success": true, "message": null }

Passport Details

Passport Details#

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

Passport Details

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples