Create Client

Endpoint Overview

POST /api/v1/passport/passport/create

Description

This endpoint generates a unique client ID that serves as a resource identifier for subsequent passport verification operations. The client ID is essential for uploading passport data and initiating verification checks in the Surepass identity verification system.

Key Benefits

Obtain a unique identifier for tracking verification requests throughout their lifecycle

Establish the foundation for a secure passport verification process

Enable seamless integration with Surepass's passport verification services

Maintain data integrity by isolating each verification request

Use Cases

Financial Services

Travel & Immigration

Government Services

Customer onboarding for banking and financial institutions requiring passport verification

KYC compliance processes for investment platforms and fintech 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. Format: `Bearer {your_jwt_token}`
Content-Type	Yes	Must be set to `application/json`

Request Body

Parameter	Type	Required	Description
tag	String	Yes	Tag

Example Request

{
    "tag": "General"
}

Process Response

Response Parameters

Parameter	Type	Description
data	Object	Contains the response data
data.client_id	String	Unique identifier for the passport verification request
status_code	Integer	HTTP status code of the response
message	String	Additional information about the response (if any)
success	Boolean	Indicates whether the request was successful

Example Successful Response

{
    "data": {
        "client_id": "takdTqhCxo"
    },
    "status_code": 201,
    "message": "",
    "success": true
}

Possible Error Responses

Authentication Error

Server Error

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

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

Integration Best Practices

Security Recommendations

Store client IDs securely and treat them as sensitive information

Implement proper error handling to avoid exposing system details in production

Rotate JWT tokens regularly and don't hardcode them in your application

Use HTTPS for all API communications to ensure data in transit is encrypted

User Experience Guidelines

Generate the client ID early in your verification flow before requesting user passport data

Implement proper loading states while waiting for the API response

Store the client ID in your session or database to maintain verification context

Include clear error messages for end-users when verification initialization fails

Code Samples

cURL

Python

Node.js

Related APIs

Passport Upload API: Allows uploading passport images using the client ID

Passport Verification API: Initiates verification checks on the uploaded passport data

Passport Verification Status API: Retrieves the status and results of verification checks

Compliance and Legal Considerations

When implementing passport verification, ensure compliance with data protection regulations such as GDPR, CCPA, or local data privacy laws. Passport data is considered sensitive personal information and should be handled with appropriate security measures. Ensure you have proper user consent before initiating verification processes.

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/create' \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data-raw '{ "tag": "General" }'

Create Client

Create Client#

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

Create Client

Description

Use Cases

Technical Implementation

Request Headers

Request Body

Example Request

Response Parameters

Example Successful Response

Possible Error Responses

Integration Best Practices

Code Samples