Onfido Reports API
The Reports API from Onfido — 5 operation(s) for reports.
Onfido Reports API is one of 45 APIs that Onfido publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Reports. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an AsyncAPI specification.
This API exposes 5 operations across 5 paths, and defines 198 schemas. It is described by OpenAPI 3.0.0, at version v3.6.
Requests are made against a single base URL, https://api.{region}.onfido.com/v3.6.
5 operations
5 paths
198 schemas
3 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Onfido Reports API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (Token).
By default, every request must be authenticated.
Paths & Operations 5
Across 5 paths, the API surfaces 5 operations — 3 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Reports 5
GET
/repeat_attempts/{report_id}
Retrieve repeat attempts
GET
/reports
List reports
GET
/reports/{report_id}
Retrieve report
POST
/reports/{report_id}/resume
Resume report
POST
/reports/{report_id}/cancel
Cancel report
Schemas 198
The contract defines 198 schemas that model the data the API accepts and returns. The most detailed are document_properties (45 properties), document_properties_extracted_data (21 properties), document_properties_barcode_inner (18 properties), device_intelligence_breakdown_properties_device (14 properties). Each schema is shown below with its type and property counts.
known_faces_properties_matches_inner
object
5 properties
device_intelligence_breakdown_breakdown
object
1 property
india_pan_report_allOf_properties_device
object
2 properties
facial_similarity_photo_breakdown_face_comparison_breakdown
object
1 property
document_with_address_information_report
document_breakdown_visual_authenticity_breakdown_picture_face_integrity
object
The pictures of the person identified on the document show signs of tampering or alteration.
2 properties
facial_similarity_photo_fully_auto_report
document_breakdown_visual_authenticity_breakdown_face_detection
object
No face was detected on the document.
2 properties
document_with_driver_verification_report
identity_enhanced_breakdown_date_of_birth_breakdown_voting_register
object
Date of birth match against voting register.
2 properties
document_breakdown_visual_authenticity
object
Asserts whether visual, non-textual, elements are correct given the type of document.
2 properties
facial_similarity_video_breakdown
object
3 properties
us_driving_licence_breakdown_address_breakdown
object
6 properties
facial_similarity_video_breakdown_image_integrity_breakdown
object
2 properties
document_breakdown_visual_authenticity_breakdown
object
8 properties
facial_similarity_photo_report
watchlist_standard_report
watchlist_aml_breakdown_politically_exposed_person
object
Asserts if there are any records found in the proprietary database of Politically Exposed Persons sourced from government lists, websites and other media sourc…
1 property
document_breakdown_visual_authenticity_breakdown_fonts
object
Fonts in the document don't match the expected ones.
2 properties
identity_enhanced_breakdown_address_breakdown_credit_agencies_properties
object
1 property
document_IQ_reasons
object
10 properties
device_intelligence_breakdown_breakdown_device_breakdown
object
3 properties
report_name
string
identity_enhanced_breakdown_address_breakdown
object
3 properties
document_breakdown_data_comparison
object
Asserts whether data on the document is consistent with data provided when creating an applicant through the API.
2 properties
document_breakdown_compromised_document
object
Asserts whether the image of the document has been found in our internal database or if it was used in a suspicious way.
2 properties
document_breakdown_data_comparison_breakdown_issuing_country
object
2 properties
known_faces_properties
object
1 property
facial_similarity_photo_fully_auto_breakdown
object
3 properties
document_properties_document_numbers_inner
object
2 properties
document_breakdown_issuing_authority_breakdown
object
2 properties
document_breakdown_image_integrity_breakdown_colour_picture
object
Asserts whether the image was a colour one.
2 properties
proof_of_address_breakdown_image_integrity_breakdown
object
1 property
facial_similarity_report_shared
object
4 properties
facial_similarity_video_breakdown_image_integrity
object
Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
2 properties
facial_similarity_motion_properties
object
1 property
us_driving_licence_breakdown_address
object
Asserts whether the address data provided matches a real driving license in the DMV driver's license database.
2 properties
document_properties_driving_licence_information
object
4 properties
identity_enhanced_breakdown
object
4 properties
identity_enhanced_properties
object
2 properties
document_breakdown_data_consistency_breakdown
object
10 properties
device_intelligence_breakdown_properties_geolocation
object
3 properties
watchlist_enhanced_properties_records_inner_attribute_inner
object
2 properties
identity_enhanced_breakdown_address_breakdown_voting_register
object
Address match against voting register.
2 properties
watchlist_enhanced_properties_records_inner_alias_inner
object
2 properties
us_driving_licence_breakdown_document
object
Asserts whether the document data provided matches a real driving license in the DMV driver's license database.
2 properties
document_properties_address_lines
object
6 properties
facial_similarity_video_breakdown_face_comparison
object
Asserts whether the face in the document matches the face in the live video.
2 properties
report_status
string
The current state of the report in the checking process. Read-only.
facial_similarity_photo_breakdown_image_integrity
object
Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
2 properties
document_breakdown_data_validation
object
Asserts whether algorithmically validatable elements are correct.
2 properties
identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies
object
Date of birth match against credit agencies.
2 properties
document_video_with_address_information_report
us_driving_licence_breakdown
object
3 properties
document_breakdown_age_validation_breakdown
object
1 property
known_faces_breakdown_image_integrity
object
Asserts whether the uploaded live photo or live video and the content contained within it were of sufficient quality to perform a face comparison.
1 property
document_breakdown_data_consistency
object
Asserts whether data represented in multiple places on the document is consistent.
2 properties
identity_enhanced_breakdown_date_of_birth
object
Asserts if the applicant's date of birth matches any sources.
2 properties
document_breakdown_visual_authenticity_breakdown_security_features
object
Security features expected on the document are missing or wrong.
2 properties
identity_enhanced_breakdown_address
object
Asserts if the applicant's address matches any sources.
2 properties
report_sub_result
string
The subresult of the report. It gives a more detailed result for document reports only, and will be null otherwise. Read-only.
facial_similarity_video_breakdown_visual_authenticity_breakdown
object
2 properties
identity_enhanced_breakdown_address_breakdown_credit_agencies
object
The number of address matches against credit agencies.
2 properties
known_faces_breakdown_previously_seen_faces
object
Asserts whether the applicant's most recent facial media (live photo or live video) matches any other live photos or live videos already in your Onfido account…
1 property
identity_enhanced_breakdown_date_of_birth_breakdown
object
2 properties
watchlist_enhanced_properties_records_inner_address_inner
object
6 properties
watchlist_aml_breakdown_sanction
object
Asserts if there are any records found in Government and International Organisations Sanctions Lists.
1 property
india_pan_report_allOf_breakdown
object
1 property
proof_of_address_breakdown_document_classification_breakdown
object
1 property
country_codes
string
facial_similarity_video_breakdown_visual_authenticity_breakdown_spoofing_detection
object
Asserts whether the live video is not a spoof (such as videos of digital screens).
2 properties
document_properties
object
45 properties
facial_similarity_photo_breakdown_image_integrity_breakdown_source_integrity
object
Asserts whether the live photo is trustworthy - i.e. not digitally tampered, from a fake webcam, or from other dubious sources.
2 properties
facial_similarity_photo_properties
object
1 property
report_result
string
The result of the report. Read-only.
document_ODP_reasons
object
4 properties
identity_enhanced_breakdown_mortality
object
Asserts if the applicant's details match any death records.
1 property
facial_similarity_video_report
facial_similarity_motion_breakdown_face_comparison
object
Asserts whether the face in the document matches the face in the motion capture.
2 properties
document_breakdown_visual_authenticity_breakdown_digital_tampering
object
Indication of digital tampering in the image.
2 properties
facial_similarity_report_media
object
1 property
1 required
facial_similarity_photo_breakdown
object
3 properties
facial_similarity_photo_fully_auto_breakdown_image_integrity
object
Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
2 properties
document_breakdown_data_comparison_breakdown
object
8 properties
facial_similarity_video_breakdown_visual_authenticity
object
Asserts whether the person in the live video is real (not a spoof) and live.
2 properties
facial_similarity_video_properties
object
1 property
watchlist_enhanced_properties_records_inner_source_inner
object
4 properties
us_driving_licence_breakdown_personal_breakdown
object
13 properties
us_driving_licence_breakdown_personal
object
Asserts whether the personal data provided matches a real driving license in the DMV driver's license database.
2 properties
ErrorProperties
object
3 properties
document_breakdown_visual_authenticity_breakdown_other
object
This sub-breakdown is returned for backward compatibility reasons. Its value will be consider when at least one of the other breakdowns is consider, and clear…
2 properties
document_breakdown_issuing_authority
object
Asserts whether data on the document matches the issuing authority data.
2 properties
document_breakdown_issuing_authority_breakdown_nfc_passive_authentication
object
Asserts whether the document NFC chip data was tampered.
2 properties
identity_enhanced_properties_matched_addresses_inner
object
2 properties
identity_enhanced_breakdown_sources_breakdown_total_sources_properties
object
1 property
facial_similarity_motion_breakdown_image_integrity_breakdown
object
2 properties
watchlist_aml_breakdown_adverse_media
object
Asserts if there are any records found of negative events reported by publicly and generally available media sources.
1 property
Reports_list
object
1 property
1 required
photo_auto_reasons
object
5 properties
report_document
object
1 property
1 required
watchlist_aml_breakdown
object
4 properties
device_intelligence_breakdown
object
2 properties
document_breakdown_police_record
object
Asserts whether the document had been identified as lost, stolen or otherwise compromised.
1 property
facial_similarity_motion_breakdown_image_integrity_breakdown_face_detected
object
Asserts a single face of good enough quality has been found in both the document image and in the motion capture.
2 properties
document_properties_extracted_data
object
21 properties
document_with_driver_verification_report_allOf_properties
facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown
object
2 properties
known_faces_report
watchlist_peps_only_report
proof_of_address_breakdown_data_comparison_breakdown
object
3 properties
watchlist_enhanced_properties_records_inner_event_inner
object
5 properties
facial_similarity_photo_breakdown_visual_authenticity
object
Asserts whether the person in the live photo is real and not a spoof.
2 properties
facial_similarity_motion_report
facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection
object
Contains a score value under the properties bag.
2 properties
facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity
object
Asserts whether the live video is trustworthy - e.g. not from a fake webcam.
2 properties
repeat_attempts_list_repeat_attempts_inner
object
7 properties
facial_similarity_photo_breakdown_face_comparison
object
Asserts whether the face in the document matches the face in the live photo.
2 properties
photo_reasons
object
5 properties
video_reasons
object
4 properties
document_breakdown_image_integrity_breakdown
object
4 properties
facial_similarity_photo_fully_auto_properties
object
1 property
identity_enhanced_breakdown_sources_breakdown_total_sources
object
The number of sources which produced a match to applicant details.
2 properties
document_with_driving_licence_information_report
document_breakdown
object
9 properties
proof_of_address_report
watchlist_standard_breakdown
object
3 properties
document_with_driver_verification_report_allOf_properties_allOf_vehicle_class_details_inner
object
4 properties
facial_similarity_photo_breakdown_face_comparison_breakdown_face_match_properties
object
2 properties
document_breakdown_data_validation_breakdown_document_expiration
object
If this is flagged, the document has expired.
2 properties
identity_enhanced_breakdown_sources
object
Asserts if any sources that an applicant's details have been verified against have produced a match.
2 properties
document_breakdown_compromised_document_breakdown
object
2 properties
device_intelligence_breakdown_properties
object
3 properties
device_intelligence_breakdown_properties_device
object
14 properties
watchlist_enhanced_properties_records_inner_associate_inner
object
3 properties
proof_of_address_breakdown_image_integrity
object
Asserts whether the quality of the uploaded document was sufficient to verify the address.
2 properties
known_faces_breakdown
object
2 properties
watchlist_aml_breakdown_legal_and_regulatory_warnings
object
Asserts if there are any records found in Law-Enforcement and Regulatory bodies Monitored Lists (including Terrorism, Money Laundering and Most Wanted lists).
1 property
facial_similarity_video_breakdown_visual_authenticity_breakdown_liveness_detected
object
Asserts whether the numbers and head movements were correctly executed.
2 properties
facial_similarity_photo_breakdown_image_integrity_breakdown
object
2 properties
proof_of_address_breakdown
object
3 properties
document_properties_document_classification
object
3 properties
india_pan_report_allOf_properties
object
1 property
watchlist_enhanced_report
facial_similarity_motion_breakdown_visual_authenticity_breakdown
object
2 properties
watchlist_enhanced_properties
object
1 property
document_breakdown_image_integrity
object
Asserts if the document is of sufficient quality to verify.
2 properties
india_pan_report
watchlist_enhanced_breakdown
object
4 properties
identity_enhanced_breakdown_address_breakdown_telephone_database
object
Address match against telephone database.
2 properties
document_with_driver_verification_report_allOf_properties_allOf_passenger_vehicle
object
Normalised data for passenger cars
3 properties
document_video_report
facial_similarity_photo_breakdown_image_integrity_breakdown_face_detected
object
Asserts a single face of good enough quality has been found in both the document image and the live photo.
2 properties
facial_similarity_motion_breakdown
object
3 properties
document_breakdown_visual_authenticity_breakdown_template
object
The document doesn't match the expected template for the document type and country it is from.
2 properties
document_breakdown_issuing_authority_breakdown_nfc_active_authentication
object
Asserts whether the document NFC chip is original or cloned.
2 properties
us_driving_licence_breakdown_document_breakdown
object
4 properties
identity_enhanced_report
identity_enhanced_breakdown_sources_breakdown
object
1 property
india_pan_report_allOf_breakdown_device
object
1 property
proof_of_address_breakdown_data_comparison
object
Asserts whether the first name, last name and address provided by the applicant match those on the PoA document.
2 properties
document_properties_barcode_inner
object
18 properties
document_breakdown_data_validation_breakdown
object
7 properties
report
facial_similarity_motion_breakdown_visual_authenticity_breakdown_spoofing_detection
object
Asserts whether the motion capture is not a spoof (such as videos of digital screens).
2 properties
watchlist_aml_properties
object
1 property
document_breakdown_age_validation
object
Asserts whether the age calculated from the document's date of birth data point is greater than or equal to the minimum accepted age.
2 properties
watchlist_sanctions_only_report
device_intelligence_breakdown_breakdown_device
object
Asserts whether the device used to upload the media is trustworthy, i.e. it is a real, physical device.
1 property
device_intelligence_breakdown_properties_ip
object
1 property
document_breakdown_data_validation_breakdown_expiry_date
object
If this is flagged, the expiration date has the incorrect format.
2 properties
us_driving_licence_report
report_shared
object
9 properties
2 required
facial_similarity_motion_breakdown_image_integrity_breakdown_source_integrity
object
Asserts whether the motion capture is trustworthy - e.g. not from a fake webcam.
2 properties
india_pan_report_allOf_breakdown_device_breakdown
object
2 properties
watchlist_aml_report
document_breakdown_image_integrity_breakdown_image_quality
object
Asserts whether the quality of the image was sufficient for processing.
2 properties
facial_similarity_photo_fully_auto_breakdown_image_integrity_breakdown_source_integrity
object
Asserts whether the live photo is trustworthy - i.e. not digitally tampered, from a fake webcam, or from other dubious sources.
2 properties
watchlist_standard_properties
object
1 property
watchlist_enhanced_properties_records_inner
object
9 properties
repeat_attempts_list
object
5 properties
1 required
document_breakdown_image_integrity_breakdown_conclusive_document_quality
object
Asserts if the document was of enough quality to be able to perform a fraud inspection.
2 properties
facial_similarity_photo_breakdown_visual_authenticity_breakdown
object
1 property
device_intelligence_report
document_breakdown_visual_authenticity_breakdown_original_document_present
object
The document was not present when the photo was taken.
2 properties
document_properties_nfc
object
13 properties
india_pan_report_allOf_breakdown_device_breakdown_pan_valid
object
1 property
facial_similarity_video_breakdown_image_integrity_breakdown_face_detected
object
Asserts a single face of good enough quality has been found in both the document image and the live video.
2 properties
document_breakdown_image_integrity_breakdown_supported_document
object
Asserts whether the submitted document is supported.
2 properties
facial_similarity_photo_breakdown_face_comparison_breakdown_face_match
object
Contains a score value under the properties bag.
2 properties
Error
object
1 property
facial_similarity_photo_breakdown_visual_authenticity_breakdown_spoofing_detection_properties
object
1 property
facial_similarity_motion_breakdown_visual_authenticity
object
Asserts whether the person in the motion capture is real (not a spoof) and live.
2 properties
facial_similarity_motion_breakdown_image_integrity
object
Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
2 properties
watchlist_enhanced_properties_records_inner_event_inner_source
object
4 properties
proof_of_address_properties
object
8 properties
document_report
proof_of_address_breakdown_document_classification
object
Asserts whether the document is of a valid type as PoA.
2 properties
document_CDQ_reasons
object
8 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Onfido 12
Other APIs Onfido publishes across the network.
Onfido Addresses API
Onfido Applicants API
Onfido Attempts API
Onfido Cancel API
Onfido Capture API
Onfido Captures API
Onfido Checks API
Onfido Complete API
Onfido Documents API
Onfido Download API
Onfido Downloads API
Onfido Electronic API
#Reports
Where this information came from
This is an independent, third-party profile of Onfido Reports API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.