Passport Scan

This document explains how to enable Passport Scan in the verification flow and Passbase API

Overview

Increase your assurance during the identity verification process with a required Passport scan directly added to your workflow. Use the Passbase dashboard to add this Additional Check to your verification flow.

Enable Passport Scan

Within the customization additional checks page, you can enable the Passport Scan by dragging the Passport Scan tile to the Live Version section. Click the Publish Changes button when complete. Your users will now be prompted to scan the front of their Passport after scanning their Drivers License or National ID Card.

Passport Scan API Response

The Passport data for each Verification is accessible using the below Passbase API endpoints. You can find more information about the endpoints in our API explorer, and you can use one of our server-side libraries to interact with the Passbase API.

// List all identities
https://api.passbase.com/verification/v1/identities
‚Äč
// Get identity for a specific id / key
https://api.passbase.com/verification/v1/identities/{id}

The response of the API will have the following parameters:

Response parameters

Parameter

Description

first_names

First names of the user the Passport belongs to

last_name

Last name of the user the Passport belongs to

document_number

Unique document number of the Passport

document_origin_country

Origin country of the Passport

nationality

Nationality of the user the Passport belongs to

date_of_birth

Date of birth of the user the Passport belongs to

sex

Gender of the user the Passport belongs to

place_of_birth

Place of birth of the user the Passport belongs to

date_of_issue

Date of issue of the Passport

date_of_expiry

Date of expiration of the Passport

authority

Issuing authority of the Passport

application_receipt_number

Application receipt number of the Passport

immigrant_case_number

Immigrant case number of the user the Passport belongs to

mrtd_document_code

Unique mrtd document code of the Passport

raw_mrz_string

Unique raw mrz string of the Passport

mrtd_alien_number

Unique mrtd alien number

mrtd_verified

Boolean representing if the Passport is mrtd verified

mrtd_issuing_country

Mrtd issuing country of the Passport

id_authenticity_factor

Id authenticity score of the Passport

face_match_factor

Face match score of the Passport

{
"id": "a44c2593-e2ae-4ed9-b81b-c1330580338a",
"status": "approved",
"score": 0.86,
"created": 1621017727,
"updated": 1621143649,
"owner": {
"email": "[email protected]",
"first_name": "JOHN",
"last_name": "DOE"
},
"resources": [
{
"id": "cd7f5b2c-6029-4b7a-bd78-ac343f50edf4",
"status": "processed",
"created": 1621017766,
"updated": 1621017769,
"type": "PASSPORT",
"datapoints": {
"authority": "United States Deparment of State",
"id_authenticity_factor": .80,
"date_of_issue": "2011-01-01",
"place_of_birth": "NEW YORK, U.S.A",
"mrtd_verified": true,
"nationality": "us",
"face_match_factor": 0.7,
"mrtd_document_code": "P",
"raw_mrz_string": "P<USADOE<<JOHN<B<<<<<<<<<<<<<<<<<<<<<<<\n0000000001USA8001019F2101010001000000<000000\n",
"country": "US",
"document_origin_country": "US",
"last_name": "DOE",
"first_names": "JOHN B",
"sex": "male",
"mrtd_issuing_country": "USA",
"date_of_expiry": "2021-01-01",
"date_of_birth": "1980-01-01",
"document_number": "000000000"
},
"resource_files": [...
]
},
{
"id": "8f087198-8678-472a-b063-4a6076bcfbec",
"status": "processed",
"created": 1606762035,
"updated": 1606762035,
"type": "DRIVERS_LICENSE",
"datapoints": {
"country": "us",
"face_match_factor": 0.8,
"id_authenticity_factor": 0.94,
"drivers_license_categories": "D",
"sex": "male",
"document_number": "000 000 000",
"date_of_expiry": "2022-01-01",
"date_of_issue": "2013-01-01",
"address": "123 Street NEW YORK, NY 10016",
"last_name": "DOE",
"first_names": "JOHN",
"date_of_birth": "1980-01-01"
},
"resource_files": [...
]
},
],
"watchlist": null,
"metadata": null
}