National ID Card Scan
This document explains how to enable National ID Scan in the verification flow and Passbase API
Increase your assurance during the identity verification process with a required National ID Card scan directly added to your workflow. Use the Passbase dashboard to add this Additional Check to your verification flow.
Within the customization additional checks page, you can enable the National ID Card Scan by dragging the National ID Card Scan tile to the Live Version section. Click the Publish Changes button when complete. Your users will now be prompted to scan the front and back of their National ID Card after scanning their Drivers License or Passport.
The National ID Card 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:
Parameter | Description |
first_names | First names of the user the National ID Card belongs to |
last_name | Last name of the user the National ID Card belongs to |
document_number | The unique document number of the National ID Card |
document_origin_country | Origin country of the National ID Card |
nationality | Nationality of the user the National ID Card belongs to |
date_of_birth | Date of birth of the user the National ID Card belongs to |
sex | Gender of the user the National ID Card belongs to |
place_of_birth | Place of birth of the user the National ID Card belongs to |
date_of_issue | Date of issue of the National ID Card |
date_of_expiry | Date of expiration of the National ID Card |
authority | Issuing authority of the National ID Card |
raw_mrz_string | Unique raw mrz string of the National ID Card |
mrtd_issuing_country | Mrtd issuing country of the National ID Card |
address | Address of the end user the National ID Card belongs to |
city | City of the end user the National ID Card belongs to |
country | Country of the end user the National ID Card belongs to |
street | Street of the end user the National ID Card belongs to |
zip_code | Zip code of the end user the National ID Card belongs to |
personal_id_number | Personal id number of the end user the National ID Card belongs to |
id_authenticity_factor | Id authenticity score of the National ID Card |
face_match_factor | Face match score of the National ID Card |
{
"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": "e7ccd955-4886-4124-97a1-10d0869ce147",
"status": "processed",
"created": 1620400657,
"updated": 1620400659,
"type": "NATIONAL_ID_CARD",
"datapoints": {
"id_authenticity_factor": 0.8,
"mrtd_verified": true,
"nationality": "AMERICAN",
"mrtd_issuing_country": "USA",
"mrtd_document_code": "ID",
"raw_mrz_string": "ILUSAR0ZRSLM000<<<<<<<<<<<<<<<\n0000000M0000000USA<<<<<<<<NY<3\nDOE<<JOHN<<<<<<<<<<<<<<<<<<<\n",
"drivers_license_categories": "D",
"sex": "M",
"document_number": "000000000",
"date_of_expiry": "2023-01-01",
"date_of_issue": "2019-01-01",
"address": "123 Street NEW YORK NY 10016",
"face_match_factor": 0.9,
"last_name": "DOE",
"first_names": "JOHN",
"country": "US",
"document_origin_country": "US",
"date_of_birth": "1980-01-01"
},
"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
}