Skip to main content
POST
Passport

Authorizations

Authorization
string
header
required

Use your API token as a Bearer token in the Authorization header.

Headers

Authorization
string
required
Example:

"Bearer {your_api_token}"

Accept
string
default:application/json
Content-Type
string
default:application/json

Body

application/json
familyName
string
required

Family name as shown on the passport.

givenName
string
required

Given name(s) as shown on the passport.

dob
string
required

Date of birth in DD-MM-YYYY format.

Example:

"15-03-1990"

gender
string
required

Gender as shown on the passport (M or F).

Example:

"M"

travelDocumentNumber
string
required

Passport number.

metadata
object

Optional key-value pairs echoed back in the response.

Response

Request processed. Check data.isValid and verificationStatus to determine the outcome.

success
boolean
required
message
string
required
data
object
required
verificationStatus
enum<string>
required
Available options:
VERIFIED,
REJECTED
verificationStatusCode
integer
required

3 = Verified, 1 = Rejected.

transactionId
string<uuid>
required
verificationType
string
required
Example:

"australia_passport"

createdAt
string
required
metadata
object | null