Passport

Identity & KYC

Verifies a passport using the application file number and date of birth and returns passport number, holder name and application/dispatch dates.

Endpoint

POST https://app.emver.io/api/sandbox/v1/passport

Authorization: Bearer YOUR_API_KEY

Content-Type: application/json

Accept: application/json

Request parameters

Field	Type	Description
`passport_file_number` required	string	Passport File Number Passport application file number
`passport_dob` required	string	Date of Birth Date of birth as on the passport (DD/MM/YYYY)

Example request

cURL

curl -X POST https://app.emver.io/api/sandbox/v1/passport \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -d '{
    "passport_file_number": "string",
    "passport_dob": "YYYY-MM-DD"
}'

import requests

response = requests.post(
    "https://app.emver.io/api/sandbox/v1/passport",
    headers={
        "Authorization": "Bearer YOUR_API_KEY",
        "Accept": "application/json",
    },
    json={
        "passport_file_number": "string",
        "passport_dob": "YYYY-MM-DD"
    },
    timeout=60,
)
response.raise_for_status()
data = response.json()

const response = await fetch("https://app.emver.io/api/sandbox/v1/passport", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
    "Accept": "application/json",
  },
  body: JSON.stringify({
      "passport_file_number": "string",
      "passport_dob": "YYYY-MM-DD"
  }),
});

const data = await response.json();

$response = Http::withToken('YOUR_API_KEY')
    ->acceptJson()
    ->post('https://app.emver.io/api/sandbox/v1/passport', {
        "passport_file_number": "string",
        "passport_dob": "YYYY-MM-DD"
    });

$data = $response->json();

Replace YOUR_API_KEY and the placeholder values. Use the switch above to see production URLs.

Response

Structure · 200

{
  "status": INTEGER,
  "message": STRING
}

Example · 200

{
  "status": 200,
  "message": "string"
}

Error · 4xx / 5xx

{
  "status": INTEGER,
  "message": STRING
}

See Errors & status codes for what each status means and which calls are billed.

About this API

Passport

Verifies a passport using the application file number and date of birth and returns passport number, holder name and application/dispatch dates.

Endpoint

POST /api/v1/passport
Content-Type: application/json

Request parameters

Field	Required	Description
`passport_file_number`	Yes	Passport File Number - Passport application file number. Example: `BO1234567890123`
`passport_dob`	Yes	Date of Birth - Date of birth as on the passport (DD/MM/YYYY). Example: `DD/MM/YYYY`

Sample request

{
  "passport_file_number": "BO1234567890123",
  "passport_dob": "DD/MM/YYYY"
}

Sample success response

{
  "status": 200,
  "message": "Verification successful",
  "data": {
    "file_number": "...",
    "dob": "...",
    "passport_number": "...",
    "given_name": "...",
    "surname": "...",
    "application_type": "...",
    "application_date": "...",
    "date_of_dispatch": "..."
  }
}

Sample error response

{
  "status": 404,
  "message": "No record found for the given input"
}

Response status codes

The status field in the response body indicates the verification outcome.

status	Meaning
`200`	Verification successful
`202`	Accepted - application under review
`400`	Invalid input / verification failed
`404`	No record found
`409`	Conflict - multiple or rejected records
`422`	Invalid or missing input parameters
`500`	Source unavailable - retry later