Passport
A passport is a travel document issued by a country's government that verifies the identity and nationality of the holder for the purpose of international travel.
The form_type
parameter PASSPORT
for the Upload PDF endpoint is required for this form type.
Do not confuse this form type with PASSPORT_CARD
; the two documents are similar but not identical.
Learn more about how we process passports here.
Configuration-driven output
All fields below are optionally captured, depending on your order form. To adjust fields captured, please speak with your Ocrolus Account Manager.
JSON attribute | Data type | Description |
---|---|---|
passport-General:firstName | Text | First name of the individual who owns the passport |
passport-General:middleName | Text | Middle name of the individual who owns the passport |
passport-General:lastName | Text | Last name of the individual who owns the passport |
passport-General:suffix | Text | Default is_empty = TRUE , Suffix of the individual who owns the passport |
passport-General:issuingCountry | UNITED STATES OTHER | Country who issued the Passport to the individual |
passport-General:dateOfBirth | Date | Date of birth of the individual who owns the passport |
passport-General:issueDate | Date | Issuing date of the passport |
passport-General:expirationDate | Date | Expiration date of the passport |
Sample form
The below Ocrolus sample PDF (input) matches the below sample JSON result (output).
Sample JSON result
{
"status": 200,
"response": {
"pk": 30476722,
"uuid": "a75a386b-88e8-4ba1-9ff7-70459b7de09b",
"forms": [
{
"pk": 30029265,
"uuid": "88b9c997-39d5-4c66-aa89-db3145042a90",
"form_type": "PASSPORT",
"form_config_pk": 18852,
"tables": [],
"raw_fields": {
"passport-General:suffix": {
"value": "",
"is_empty": true,
"alias_used": null,
"source_filename": "Passport Sample 1.pdf"
},
"passport-General:lastName": {
"value": "DONALD",
"is_empty": false,
"alias_used": null,
"source_filename": "Passport Sample 1.pdf"
},
"passport-General:firstName": {
"value": "SMALLING",
"is_empty": false,
"alias_used": null,
"source_filename": "Passport Sample 1.pdf"
},
"passport-General:issueDate": {
"value": "04/22/2010",
"is_empty": false,
"alias_used": null,
"source_filename": "Passport Sample 1.pdf"
},
"passport-General:middleName": {
"value": "",
"is_empty": true,
"alias_used": null,
"source_filename": "Passport Sample 1.pdf"
},
"passport-General:dateOfBirth": {
"value": "10/30/1970",
"is_empty": false,
"alias_used": null,
"source_filename": "Passport Sample 1.pdf"
},
"passport-General:expirationDate": {
"value": "04/21/2020",
"is_empty": false,
"alias_used": null,
"source_filename": "Passport Sample 1.pdf"
},
"passport-General:issuingCountry": {
"value": "UNITED STATES",
"is_empty": false,
"alias_used": null,
"source_filename": "Passport Sample 1.pdf"
}
}
}
]
},
"message": "OK"
}
Updated 9 months ago