| Attribute | Format | Possible values |
|---|---|---|
documents |
Array of objects |
"documents": [
{
"id": "<DOCUMENT_ID>"
}
]
|
properties |
||
document_type |
String or null |
"passport" | "national_identity_card" | "national_health_insurance_card" | "driving_licence" | "tax_id" | "residence_permit" | "voter_id" | "visa" | "work_permit" | "passport_card" | "municipality_identity_card" | "immigration_status_document" | "indigenous_card" | "proof_of_citizenship" | "private_operators_card" | "service_id_card" | nullNote: This is not an exhaustive list. |
issuing_country |
String or null |
"<ISO_3166_ALPHA-3_COUNTRY_CODE> | null |
issuing_state |
String (will only appear in the response if extracted) | "<SOME_VALUE>" |
issuing_date |
"<YYYY-MM-DD>" (will only appear in response if extracted) |
"<ISO_8601_DATE>" |
gender |
String or null |
"male" | "female" | null |
nationality |
String or null |
"<ISO_3166_ALPHA-3_COUNTRY_CODE> | null |
first_name |
String or NULL |
"<SOME_VALUE>" | NULL for empty fields |
last_name |
String or NULL |
"<SOME_VALUE>" | NULL for empty fields |
spouse_name |
String (will only appear in response if extracted) | "<SOME_VALUE>" |
widow_name |
String (will only appear in response if extracted) | "<SOME_VALUE>" |
alias_name |
String (will only appear in response if extracted) | "<SOME_VALUE>" |
issuing_authority |
String (will only appear in response if extracted) | "<SOME_VALUE>" |
place_of_birth |
String (will only appear in response if extracted) | "<SOME_VALUE>" |
real_id_compliance |
String (will only appear in response if extracted) | "<SOME_VALUE>" |
date_of_birth |
"<YYYY-MM-DD>" (will only appear in response if extracted) |
"<ISO_8601_DATE>" |
date_of_expiry |
"<YYYY_MM-DD>" (will only appear in response if extracted) |
"<ISO_8601_DATE>" |
categorisation |
String (will only appear in response if extracted) | "full" | "provisional" |
mrz_line1 |
String (will only appear in response if extracted) | "<SOME_VALUE>" |
mrz_line2 |
String (will only appear in response if extracted) | "<SOME_VALUE>" |
mrz_line3 |
String (will only appear in response if extracted) | "<SOME_VALUE>" |
document_numbers |
Array of objects, or null |
"[{ "type": "document_number", "value": "<SOME_VALUE>"}, { "type": "personal_number", "value": "<SOME_VALUE>"}, {"type": "<SOME_VALUE>", "value": "<SOME_VALUE>"}]" |
barcode |
Array of objects (will only appear in response if extracted) | "[{ "first_name": "<SOME_VALUE>", "middle_name": "<SOME_VALUE>", "last_name": "<SOME_VALUE>", "document_type": "<SOME_VALUE>", "date_of_expiry": "<ISO_8601_DATE>", "date_of_birth": "<ISO_8601_DATE>", "issuing_date": "<ISO_8601_DATE>", "address_line_1": "<SOME_VALUE>", "address_line_2": "<SOME_VALUE>", "address_line_3": "<SOME_VALUE>", "address_line_4": "<SOME_VALUE>", "address_line_5": "<SOME_VALUE>", "issuing_state": "<SOME_VALUE>", "class": "<SOME_VALUE>", "gender": "<SOME_VALUE>", "issuing_country": "<SOME_VALUE>", "document_number": "<SOME_VALUE>", "real_id_classification": "<SOME_VALUE>"}]" |
nfc |
Object (will only appear in response if extracted, API v3.2 onwards) | "nfc": { "document_type": "<SOME_VALUE>", "issuing_country": "<SOME_VALUE>", "full_name": "<SOME_VALUE>", "document_number": "<SOME_VALUE>", "nationality": "<SOME_VALUE>", "date_of_birth": "<ISO_8601_DATE>", "gender": "<SOME_VALUE>", "date_of_expiry": "<ISO_8601_DATE>", "personal_number": "<SOME_VALUE>", "place_of_birth": "<SOME_VALUE>", "address": "<SOME_VALUE>", "issuing_date": "<ISO_8601_DATE>", "issuing_authority": "<SOME_VALUE>"} |
address |
String (will only appear in response if extracted) | "2345 Anywhere Street, Your City, NY, 12345, United States" |
address_lines |
Object (will only appear in response if extracted) | "address_lines": {
"street_address": "2345 Anywhere Street",
"state": "NY",
"postal_code": "12345",
"country": "United States",
"city": "Your City"
}" |
police_record |
String | "clear" | "consider" |
age_validation |
String | "clear" | "consider" |
minimum_accepted_age |
String | "clear" | "consider" |
data_comparison |
String | "clear" | "consider" |
first_name |
String or null |
"clear" | "consider" | null (Can be null if data_comparison is disabled) |
last_name |
String or null |
"clear" | "consider" | null (Can be null if data_comparison is disabled) |
date_of_expiry |
null |
null |
issuing_country |
null |
null |
document_type |
null |
null |
document_numbers |
null |
null |
gender |
null |
null |
date_of_birth |
String or null |
"clear" | "consider" | null |
compromised_document |
String | "clear" | "consider" |
data_validation |
String | "clear" | "consider" |
document_expiration |
String or null |
"clear" | "consider" | null |
gender |
String or null |
"clear" | "consider" | null |
expiry_date |
String or null |
"clear" | "consider" | null |
mrz |
String or null |
"clear" | "consider" | null |
date_of_birth |
String or null |
"clear" | "consider" | null |
document_numbers |
String or null |
"clear" | "consider" | null |
barcode |
String or null (only returned in API v3.2 onwards) |
"clear" | "consider" | null |
visual_authenticity |
String | "clear" | "consider" |
other |
String or null |
"clear" | "consider" | null |
original_document_present |
String or null |
"clear" | "consider" | null |
fonts |
String or null |
"clear" | "consider" | null |
picture_face_integrity |
String or null |
"clear" | "consider" | null |
security_features |
String or null |
"clear" | "consider" | null |
digital_tampering |
String or null |
"clear" | "consider" | null |
template |
String or null |
"clear" | "consider" | null |
face_detection |
String or null |
"clear" | "consider" | null |
image_integrity |
String | "clear" | "consider" |
colour_picture |
String | "clear" | "consider" |
supported_document |
String | "clear" | "unidentified" |
image_quality |
String | "clear" | "consider" | "unidentified" |
conclusive_document_quality |
String | "clear" | "consider" |
data_consistency |
String | "clear" | "consider" |
date_of_expiry |
String or null |
"clear" | "consider" | null |
document_type |
String or null |
"clear" | "consider" | null |
nationality |
String or null |
"clear" | "consider" | null |
issuing_country |
String or null |
"clear" | "consider" | null |
document_numbers |
String or null |
"clear" | "consider" | null |
gender |
String or null |
"clear" | "consider" | null |
date_of_birth |
String or null |
"clear" | "consider" | null |
first_name |
String or null |
"clear" | "consider"| null |
last_name |
String or null |
"clear" | "consider"| null |
multiple_data_sources_present |
String or null (only returned in API v3.1 onwards) |
"clear" | "consider"| null |
issuing_authority |
String (only returned in API v3.2 onwards) | "clear" | "consider" |
nfc_active_authentication |
String or null (only returned in API v3.2 onwards) |
"clear" | "consider" | null |
nfc_passive_authentication |
String or null (only returned in API v3.2 onwards) |
"clear" | "consider" | null |