Get Passport Details by Client ID

Endpoint Overview

GET /api/v1/passport/passport/{client_id}

Description

This endpoint retrieves comprehensive passport details for a specific client using their unique client ID. It provides access to all passport information including personal details, document numbers, issuance information, and verification status. This API is essential for identity verification processes, KYC workflows, and compliance checks that require official passport data.

Key Benefits

Instant access to verified passport information without manual document processing

Comprehensive data retrieval including MRZ (Machine Readable Zone) information

Verification status indicator to confirm document authenticity

Structured response format for easy integration into existing systems

Use Cases

Financial Services

Travel & Immigration

Government Services

Customer onboarding for banking and financial institutions

KYC verification for investment platforms and trading accounts

Identity verification for loan and credit 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	Bearer token for authentication (JWT format)
Content-Type	Yes	Application/json

Path Parameters

Parameter	Type	Required	Description
client_id	String	Yes	Unique identifier of the client whose passport details are being requested

No request body is required for this GET endpoint.

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains all passport details
data.doe	String	Date of expiry of passport (YYYY-MM-DD)
data.dob	String	Date of birth (YYYY-MM-DD)
data.father	String	Father's name as listed in passport
data.given_name	String	Given name of passport holder
data.mrz_line_1	String	First line of Machine Readable Zone
data.old_passport_num	String	Previous passport number if applicable
data.file_num	String	File number associated with the passport
data.client_id	String	Unique identifier for the client
data.place_of_issue	String	Location where passport was issued
data.spouse	String	Spouse's name if applicable
data.country_code	String	Three-letter country code (e.g., IND for India)
data.address	String	Residential address of passport holder
data.surname	String	Surname/family name of passport holder
data.mrz_line_2	String	Second line of Machine Readable Zone
data.passport_num	String	Current passport number
data.doi	String	Date of issue of current passport (YYYY-MM-DD)
data.old_doi	String	Date of issue of previous passport if applicable (YYYY-MM-DD)
data.gender	String	Gender as listed in passport
data.nationality	String	Nationality of passport holder
data.place_of_birth	String	Place of birth as listed in passport
data.mother	String	Mother's name as listed in passport
data.old_place_of_issue	String	Place where previous passport was issued, if applicable
data.pin	String	Postal/ZIP code
data.verified	Boolean	Verification status of the passport
status_code	Integer	HTTP status code of the response
message	String	Additional information or error message
success	Boolean	Indicates if the request 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",
        "verified": true
    },
    "status_code": 200,
    "message": "",
    "success": true
}

Possible Error Responses

Client ID Not Found

Authentication Error

Server Error

{
    "data": null,
    "status_code": 404,
    "message": "No passport found for the provided client ID",
    "success": false
}

This error occurs when the specified client_id does not exist in the system or has no associated passport data.

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

Cache passport data when appropriate to reduce API calls and improve performance

Implement proper loading states while waiting for API responses

Display verification status prominently to indicate document authenticity

Format dates in a user-friendly manner (consider locale-specific formatting)

Code Samples

cURL

Python

Node.js

Related APIs

Passport Verification API - Verifies passport details against government records

Document OCR API - Extracts information from passport images

Identity Verification API - Comprehensive identity verification including passport and other documents

Compliance and Legal Considerations

When handling passport data, ensure compliance with relevant data protection regulations such as GDPR, CCPA, or local data privacy laws. Passport information is considered sensitive personal data and should be handled with appropriate security measures. Ensure you have proper consent mechanisms in place before storing or processing this information, and implement appropriate data retention policies.

{ "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", "verified": true }, "status_code": 200, "message": "", "success": true }

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

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

Get Client Details

Get Passport Details by Client ID#

Description#

Use Cases#

Technical Implementation#

Request Headers#

Path Parameters#

Response Parameters#

Example Successful Response#

Possible Error Responses#

Integration Best Practices#

Code Samples#

Request

Responses