Skip to main content
POST
Passport verification

Authorizations

Authorization
string
header
required

Your API key, sent as Authorization: Bearer <your-key>.

Body

application/json

The passport application to verify, and the name to hold it to.

file_number
string
required

File number of the passport application, in letters and digits alone, as printed on its receipt, like KA1061234567812

Pattern: ^[A-Z]{2}[A-Z0-9]{8,18}$
name
string
required

The applicant's full name

Required string length: 2 - 200
date_of_birth
string<date>
required

The applicant's date of birth. It cannot be after today

Response

Successful Response

The name the registry holds for a passport application, and whether the claimed one matched.

details is null when the registry holds no application under the file number and date of birth. That is a finding about today: the same request made later asks the registry again, and can find one.

reasons
Reason · object[]

Why the check did not pass, worst first, each a stable code with the text for it. Empty when it passed

details
PassportVerification · object | null

The application's name as the registry holds it, and whether it matched