Basic International Passport Verification
The Basic International Passport Verification API allows users to verify an individual's international passport number and basic personal information, for identity validation.
Base URL
Endpoint
Request Headers
You can use either the API key or Bearer Token for Authorization
Content-Type
application/json
Specifies that the request body is in JSON format.
Authorization
Bearer <token>
API Key for authentication.
x-api-key
API KEY
API Key for authentication
Request Body
The request body should include the individual's passport number and basic identity information for verification.
Example Request
Request Body Schema
idDocumentNumber
string
✅
The individual's international passport number.
dateOfBirth
string
✅
The individual's date of birth in YYYY-MM-DD
format.
firstName
string
✅
The individual's first name.
lastName
string
✅
The individual's last name.
reference
string
✅
Unique reference number for the verification request.
serviceProviderCode
string
✅
Code identifying the service provider.
Responses
Success Response (200 OK)
If the verification is successful, the API returns whether the passport details match the provided information.
Response Schema
apiVersion
string
API version.
success
boolean
Indicates whether the request was successful.
code
string
Response code.
message
string
Description of the response.
requestId
string
Unique ID for tracking the request.
data.isMatch
boolean
Indicates whether the provided passport details match the input.
data.message
string
Additional information about the match result.
Error Responses
400
Bad Request
{ "success": false, "message": "Invalid request.", "code": "400" }
401
Unauthorized
{ "success": false, "message": "Unauthorized access.", "code": "401" }
500
Internal Server Error
{ "success": false, "message": "Server error.", "code": "500" }
Usage Example (cURL)
Last updated