Search…
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.
1
// List all identities
2
https://api.passbase.com/verification/v1/identities
3
4
// Get identity for a specific id / key
5
https://api.passbase.com/verification/v1/identities/{id}
Copied!
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
1
{
2
"id": "a44c2593-e2ae-4ed9-b81b-c1330580338a",
3
"status": "approved",
4
"score": 0.86,
5
"created": 1621017727,
6
"updated": 1621143649,
7
"owner": {
8
"email": "[email protected]",
9
"first_name": "JOHN",
10
"last_name": "DOE"
11
},
12
"resources": [
13
{
14
"id": "cd7f5b2c-6029-4b7a-bd78-ac343f50edf4",
15
"status": "processed",
16
"created": 1621017766,
17
"updated": 1621017769,
18
"type": "PASSPORT",
19
"datapoints": {
20
"authority": "United States Deparment of State",
21
"id_authenticity_factor": .80,
22
"date_of_issue": "2011-01-01",
23
"place_of_birth": "NEW YORK, U.S.A",
24
"mrtd_verified": true,
25
"nationality": "us",
26
"face_match_factor": 0.7,
27
"mrtd_document_code": "P",
28
"raw_mrz_string": "P<USADOE<<JOHN<B<<<<<<<<<<<<<<<<<<<<<<<\n0000000001USA8001019F2101010001000000<000000\n",
29
"country": "US",
30
"document_origin_country": "US",
31
"last_name": "DOE",
32
"first_names": "JOHN B",
33
"sex": "male",
34
"mrtd_issuing_country": "USA",
35
"date_of_expiry": "2021-01-01",
36
"date_of_birth": "1980-01-01",
37
"document_number": "000000000"
38
},
39
"resource_files": [...
40
]
41
},
42
{
43
"id": "8f087198-8678-472a-b063-4a6076bcfbec",
44
"status": "processed",
45
"created": 1606762035,
46
"updated": 1606762035,
47
"type": "DRIVERS_LICENSE",
48
"datapoints": {
49
"country": "us",
50
"face_match_factor": 0.8,
51
"id_authenticity_factor": 0.94,
52
"drivers_license_categories": "D",
53
"sex": "male",
54
"document_number": "000 000 000",
55
"date_of_expiry": "2022-01-01",
56
"date_of_issue": "2013-01-01",
57
"address": "123 Street NEW YORK, NY 10016",
58
"last_name": "DOE",
59
"first_names": "JOHN",
60
"date_of_birth": "1980-01-01"
61
},
62
"resource_files": [...
63
]
64
},
65
],
66
"watchlist": null,
67
"metadata": null
68
}
Copied!
Last modified 5mo ago