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

https://acs-uat-verifications.amala.cloud/
https://acs-prod-verifications.amala.cloud/

Endpoint

POST verification/api/v1/idv/basic/passport

Request Headers

You can use either the API key or Bearer Token for Authorization

Header
Type
Description

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

{
  "idDocumentNumber": "A12345678",
  "dateOfBirth": "1990-01-15",
  "firstName": "John",
  "lastName": "Doe",
  "reference": "PASSPORT_REF_12345",
  "serviceProviderCode": "SPC002"
}

Request Body Schema

Field
Type
Required
Description

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.

 {
  "apiVersion": "1.0",
  "success": true,
  "code": "00",
  "message": "Verification successful",
  "requestId": "REQ-987654321",
  "data": {
    "isMatch": true,
    "message": "The passport details match the provided information."
  }
}

Response Schema

Field
Type
Description

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

Status Code
Description
Example Response

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)

curl -X POST "https://acs-uat-verifications.amala.cloud/verification/api/v1/idv/basic/passport" \
     -H "Authorization: Bearer YOUR_API_KEY" \
     -H "Content-Type: application/json" \
     -d '{
           "idDocumentNumber": "A12345678",
           "dateOfBirth": "1990-01-15",
           "firstName": "John",
           "lastName": "Doe",
           "reference": "PASSPORT_REF_12345",
           "serviceProviderCode": "SPC002"
         }'

Last updated