Onfido LogoOnfido Logo

Developers

Document report object

Introduction

This guide offers a detailed breakdown and description of the attributes and values of a Document report object.

AttributeFormatPossible values
documentsArray of objects"documents": [ { "id": "\<DOCUMENT_ID\>" } ]
properties
document_typeString or null"accommodation_tenancy_certificate”, "address_certificate”, "adoption_certificate”, "bank_building_society_statement”, "bank_statement”, "benefit_letters”, "birth_certificate”, "cbt”, "certificate_of_naturalisation”, "certificate_of_sponsorship”, "character_reference”, "civil_partnership_certificate”, "council_tax”, "credit_card_statement”, "deed_poll”, "divorce_absolute_decree”, "driving_licence”, "educational_statement”, "electricity_bill”, "exchange_house_statement”, "form_for_affixing_the_visa”, "gas_bill”, "general_letter”, "government_letter”, "home_office_letter”, "identity_document_with_address”, "immigration_status_document”, "indigenous_card”, "insurance_statement”, "internet_bill”, "marriage_certificate”, "mobile_phone_bill”, "mortgage_statement”, "motorcycle_insurance”, "national_identity_card”, "national_insurance_card”, "naturalisation_certificate”, "non_uk_driving_licence”, "p45_p60”, "passport”, "passport_card”, "payslip”, "pension_property_statement_letter”, "phone_bill”, "postal_identity_card”, "professional_identification_card”, "proof_of_citizenship”, "residence_permit”, "right_to_work_share_code_result”, "service_id_card”, "social_security_card”, "statement_fact”, "t4_student_university_term_dates_evidence”, "tax_id”, "uk_biometric_residence_permit”, "uk_driving_licence”, "unknown”, "utility_bill”, "utility_bill_electric”, "utility_bill_gas”, "utility_bill_other”, "visa”, "voter_id”, "water_bill”, "work_permit", null. Note: This list is subject to change and may not be exhaustive.
issuing_countryString or null"<ISO_3166_ALPHA-3_COUNTRY_CODE>, null
issuing_stateString (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>"
genderString or null"male", "female", null
nationalityString or null"<ISO_3166_ALPHA-3_COUNTRY_CODE>, null
first_nameString or NULL"<SOME_VALUE>", NULL for empty fields
last_nameString or NULL"<SOME_VALUE>", NULL for empty fields
spouse_nameString (will only appear in response if extracted)"<SOME_VALUE>"
widow_nameString (will only appear in response if extracted)"<SOME_VALUE>"
alias_nameString (will only appear in response if extracted)"<SOME_VALUE>"
issuing_authorityString (will only appear in response if extracted)"<SOME_VALUE>"
place_of_birthString (will only appear in response if extracted)"<SOME_VALUE>"
real_id_complianceString (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>"
categorisationString (will only appear in response if extracted)"full", "provisional"
mrz_line1String (will only appear in response if extracted)"<SOME_VALUE>"
mrz_line2String (will only appear in response if extracted)"<SOME_VALUE>"
mrz_line3String (will only appear in response if extracted)"<SOME_VALUE>"
document_numbersArray of objects, or null"[{ "type": "document_number", "value": "\<SOME_VALUE\>"}, { "type": "personal_number", "value": "\<SOME_VALUE\>"}, {"type": "\<SOME_VALUE\>", "value": "\<SOME_VALUE\>"}]"
barcodeArray 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\>"}]"
nfcObject (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\>"}
addressString (will only appear in response if extracted)"2345 Anywhere Street, Your City, NY, 12345, United States"
address_linesObject (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_recordString"clear", "consider"
age_validationString"clear", "consider"
minimum_accepted_ageString"clear", "consider"
data_comparisonString"clear", "consider"
first_nameString or null"clear", "consider", null (Can be null if data_comparison is disabled)
last_nameString or null"clear", "consider", null (Can be null if data_comparison is disabled)
date_of_expirynullnull
issuing_countrynullnull
document_typenullnull
document_numbersnullnull
gendernullnull
date_of_birthString or null"clear", "consider", null
compromised_documentString"clear", "consider"
data_validationString"clear", "consider"
document_expirationString or null"clear", "consider", null
genderString or null"clear", "consider", null
expiry_dateString or null"clear", "consider", null
mrzString or null"clear", "consider", null
date_of_birthString or null"clear", "consider", null
document_numbersString or null"clear", "consider", null
barcodeString or null (only returned in API v3.2 onwards)"clear", "consider", null
visual_authenticityString"clear", "consider"
otherString or null"clear", "consider", null
original_document_presentString or null"clear", "consider", null
fontsString or null"clear", "consider", null
picture_face_integrityString or null"clear", "consider", null
security_featuresString or null"clear", "consider", null
digital_tamperingString or null"clear", "consider", null
templateString or null"clear", "consider", null
face_detectionString or null"clear", "consider", null
image_integrityString"clear", "consider"
colour_pictureString"clear", "consider"
supported_documentString"clear", "unidentified"
image_qualityString"clear", "consider", "unidentified"
conclusive_document_qualityString"clear", "consider"
data_consistencyString"clear", "consider"
date_of_expiryString or null"clear", "consider", null
document_typeString or null"clear", "consider", null
nationalityString or null"clear", "consider", null
issuing_countryString or null"clear", "consider", null
document_numbersString or null"clear", "consider", null
genderString or null"clear", "consider", null
date_of_birthString or null"clear", "consider", null
first_nameString or null"clear", "consider", null
last_nameString or null"clear", "consider", null
multiple_data_sources_presentString or null (only returned in API v3.1 onwards)"clear", "consider", null
issuing_authorityString (only returned in API v3.2 onwards)"clear", "consider"
nfc_active_authenticationString or null (only returned in API v3.2 onwards)"clear", "consider", null
nfc_passive_authenticationString or null (only returned in API v3.2 onwards)"clear", "consider", null

Table of contents