Onfido Request Responses
The Onfido OCR processor is composed of a client side script, automation scripts, automation script libraries, and a client script library. When the applicant's documents are validated, the call is made using the below method. The OCR data is then saved in the entity based on the Settings configurations and the response is returned in JSON format.
NOTE
When the Onfido automation processor is called, the response returned is saved in JSON format in the customer's FintechOS Digital Journey. The parsing of the returned JSON object depends on the implementation team.
When the Onfido automation processor is called, the response returned is saved in JSON format in the customer's FintechOS Digital Journey. The parsing of the returned JSON object depends on the implementation team.
-
getReport: the result contains the report for a related check.
Example
Sample JSON code for Onfido getReport response
Copy
{
"id":"571ddd12-5e9a-43c9-ad87-3c2f434ece9b",
"created_at":"2022-04-27T14:14:34Z",
"name":"document",
"href":"/v3.2/reports/571ddd12-5e9a-43c9-ad87-3c2f434ece9b",
"status":"complete",
"result":"consider",
"sub_result":"suspected",
"breakdown":{
"age_validation":{
"breakdown":{
"minimum_accepted_age":{
"properties":{
},
"result":"clear"
}
},
"result":"clear"
},
"compromised_document":{
"result":"clear"
},
"data_comparison":{
"breakdown":{
"date_of_birth":{
"properties":{
},
"result":null
},
"date_of_expiry":{
"properties":{
},
"result":null
},
"document_numbers":{
"properties":{
},
"result":null
},
"document_type":{
"properties":{
},
"result":null
},
"first_name":{
"properties":{
},
"result":null
},
"gender":{
"properties":{
},
"result":null
},
"issuing_country":{
"properties":{
},
"result":null
},
"last_name":{
"properties":{
},
"result":null
}
},
"result":null
},
"data_consistency":{
"breakdown":{
"date_of_birth":{
"properties":{
},
"result":"clear"
},
"date_of_expiry":{
"properties":{
},
"result":"clear"
},
"document_numbers":{
"properties":{
},
"result":"clear"
},
"document_type":{
"properties":{
},
"result":"clear"
},
"first_name":{
"properties":{
},
"result":"clear"
},
"gender":{
"properties":{
},
"result":"clear"
},
"issuing_country":{
"properties":{
},
"result":"clear"
},
"last_name":{
"properties":{
},
"result":"clear"
},
"multiple_data_sources_present":{
"properties":{
},
"result":null
},
"nationality":{
"properties":{
},
"result":null
}
},
"result":"clear"
},
"data_validation":{
"breakdown":{
"barcode":{
"properties":{
},
"result":null
},
"date_of_birth":{
"properties":{
},
"result":"clear"
},
"document_expiration":{
"properties":{
},
"result":"consider"
},
"document_numbers":{
"properties":{
"document_number":"clear",
"personal_number":"clear"
},
"result":"clear"
},
"expiry_date":{
"properties":{
},
"result":"clear"
},
"gender":{
"properties":{
},
"result":"clear"
},
"mrz":{
"properties":{
},
"result":"consider"
}
},
"result":"consider"
},
"image_integrity":{
"breakdown":{
"colour_picture":{
"properties":{
},
"result":"clear"
},
"conclusive_document_quality":{
"properties":{
"abnormal_document_features":"clear",
"corner_removed":"clear",
"digital_document":"clear",
"missing_back":"clear",
"obscured_data_points":"clear",
"obscured_security_features":"clear",
"punctured_document":"clear",
"watermarks_digital_text_overlay":"clear"
},
"result":"clear"
},
"image_quality":{
"properties":{
},
"result":"clear"
},
"supported_document":{
"properties":{
},
"result":"clear"
}
},
"result":"clear"
},
"issuing_authority":{
"breakdown":{
"nfc_active_authentication":{
"properties":{
},
"result":null
},
"nfc_passive_authentication":{
"properties":{
},
"result":null
}
},
"result":null
},
"police_record":{
"result":null
},
"visual_authenticity":{
"breakdown":{
"digital_tampering":{
"properties":{
},
"result":"clear"
},
"face_detection":{
"properties":{
},
"result":"clear"
},
"fonts":{
"properties":{
},
"result":"consider"
},
"original_document_present":{
"properties":{
"document_on_printed_paper":"clear",
"photo_of_screen":"consider",
"scan":"clear",
"screenshot":"clear"
},
"result":"consider"
},
"other":{
"properties":{
},
"result":"consider"
},
"picture_face_integrity":{
"properties":{
},
"result":"consider"
},
"security_features":{
"properties":{
},
"result":"consider"
},
"template":{
"properties":{
},
"result":"consider"
}
},
"result":"consider"
}
},
"properties":{
"date_of_birth":"1987-07-19",
"date_of_expiry":"2011-07-19",
"document_numbers":[
{
"type":"document_number",
"value":"BV999999"
},
{
"type":"personal_number",
"value":"1000000000000"
}
],
"document_type":"national_identity_card",
"first_name":"SHERLOCK",
"gender":"Male",
"issuing_country":"ROU",
"issuing_date":"2001-12-14",
"last_name":"HOLMES",
"mrz_line1":"IDROMHOLMES<<DO<<<<<<<<<<<<<<",
"mrz_line2":"BV999999<01328707198M110719110801192",
"place_of_birth":"MUN. BRASOV JUD. BRASOV"
},
"documents":[
{
"id":"5590a41e-f6ba-479b-ade6-437a06fe2b2f"
},
{
"id":"043609d6-4350-4e57-8ebe-7cb5b7801af3"
}
],
"check_id":"cd1bc2ff-3b73-48a1-894e-08ad25da1177",
"isSuccess":true
}