Onfido Reports API
The Reports API from Onfido — 5 operation(s) for reports.
The Reports API from Onfido — 5 operation(s) for reports.
openapi: 3.0.0
info:
contact:
name: Onfido
url: https://public.support.onfido.com
description: "\nCreate trust at onboarding and beyond with a complete, AI-powered digital\nidentity solution built to help you know your customers online. \nAutomation allows you to acquire new customers and reduce costs while\nmeeting global KYC and AML compliance."
license:
name: MIT
title: Onfido Reports API
version: v3.6
servers:
- url: https://api.{region}.onfido.com/v3.6
variables:
region:
default: eu
enum:
- eu
- us
- ca
security:
- Token: []
tags:
- name: Reports
paths:
/repeat_attempts/{report_id}:
get:
description: 'Returns all repeat attempts for a given Document report
'
operationId: list_repeat_attempts
parameters:
- in: path
name: report_id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/repeat_attempts_list'
description: Repeat attempts object
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Retrieve repeat attempts
tags:
- Reports
/reports:
get:
description: 'All the reports belonging to a particular check can be listed from this endpoint.
'
operationId: list_reports
parameters:
- in: query
name: check_id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/Reports_list'
description: List of Reports
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: List reports
tags:
- Reports
/reports/{report_id}:
get:
description: 'A single report can be retrieved using this endpoint with the corresponding unique identifier.
'
operationId: find_report
parameters:
- in: path
name: report_id
required: true
schema:
format: uuid
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/report'
description: Report object
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Retrieve report
tags:
- Reports
/reports/{report_id}/resume:
post:
description: 'Resumes a single paused report.
'
operationId: resume_report
parameters:
- in: path
name: report_id
required: true
schema:
format: uuid
type: string
responses:
'204':
description: No Content
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Resume report
tags:
- Reports
/reports/{report_id}/cancel:
post:
description: 'Cancels single paused reports.
'
operationId: cancel_report
parameters:
- in: path
name: report_id
required: true
schema:
format: uuid
type: string
responses:
'204':
description: No Content
default:
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
description: Unexpected error
summary: Cancel report
tags:
- Reports
components:
schemas:
known_faces_properties_matches_inner:
properties:
applicant_id:
description: The applicant ID of the matched applicant.
format: uuid
type: string
score:
description: A floating point number between 0 and 1 that expresses how similar the two faces are, where 1 is a perfect match.
format: float
type: number
media_id:
description: The corresponding UUID for the media type.
format: uuid
type: string
media_type:
description: The media type (for example live_photos or live_videos).
type: string
suspected:
description: Indicates if match is suspected based on fuzzy name matching feature. Dependent on feature being active for account, otherwise defaults to true.
type: boolean
type: object
device_intelligence_breakdown_breakdown:
properties:
device:
$ref: '#/components/schemas/device_intelligence_breakdown_breakdown_device'
type: object
india_pan_report_allOf_properties_device:
properties:
pan:
description: The applicant's PAN (10 digit alphanumeric number).
type: string
full_name:
description: The applicant's full name.
type: string
type: object
facial_similarity_photo_breakdown_face_comparison_breakdown:
properties:
face_match:
$ref: '#/components/schemas/facial_similarity_photo_breakdown_face_comparison_breakdown_face_match'
type: object
document_with_address_information_report:
allOf:
- $ref: '#/components/schemas/report_shared'
- properties:
breakdown:
$ref: '#/components/schemas/document_breakdown'
properties:
$ref: '#/components/schemas/document_properties'
type: object
document_breakdown_visual_authenticity_breakdown_picture_face_integrity:
description: The pictures of the person identified on the document show signs of tampering or alteration.
example:
result: result
properties: '{}'
properties:
result:
type: string
properties:
type: object
type: object
facial_similarity_photo_fully_auto_report:
allOf:
- $ref: '#/components/schemas/report_shared'
- $ref: '#/components/schemas/facial_similarity_report_shared'
- properties:
breakdown:
$ref: '#/components/schemas/facial_similarity_photo_fully_auto_breakdown'
properties:
$ref: '#/components/schemas/facial_similarity_photo_fully_auto_properties'
type: object
document_breakdown_visual_authenticity_breakdown_face_detection:
description: No face was detected on the document.
example:
result: result
properties: '{}'
properties:
result:
type: string
properties:
type: object
type: object
document_with_driver_verification_report:
allOf:
- $ref: '#/components/schemas/report_shared'
- properties:
breakdown:
$ref: '#/components/schemas/document_breakdown'
properties:
$ref: '#/components/schemas/document_with_driver_verification_report_allOf_properties'
type: object
identity_enhanced_breakdown_date_of_birth_breakdown_voting_register:
description: Date of birth match against voting register.
properties:
result:
type: string
properties:
type: object
type: object
document_breakdown_visual_authenticity:
description: Asserts whether visual, non-textual, elements are correct given the type of document.
example:
result: result
breakdown:
template:
result: result
properties: '{}'
other:
result: result
properties: '{}'
fonts:
result: result
properties: '{}'
digital_tampering:
result: result
properties: '{}'
picture_face_integrity:
result: result
properties: '{}'
face_detection:
result: result
properties: '{}'
original_document_present:
result: result
properties:
scan: scan
document_on_printed_paper: document_on_printed_paper
screenshot: screenshot
photo_of_screen: photo_of_screen
security_features:
result: result
properties: '{}'
properties:
result:
type: string
breakdown:
$ref: '#/components/schemas/document_breakdown_visual_authenticity_breakdown'
type: object
facial_similarity_video_breakdown:
properties:
face_comparison:
$ref: '#/components/schemas/facial_similarity_video_breakdown_face_comparison'
image_integrity:
$ref: '#/components/schemas/facial_similarity_video_breakdown_image_integrity'
visual_authenticity:
$ref: '#/components/schemas/facial_similarity_video_breakdown_visual_authenticity'
type: object
us_driving_licence_breakdown_address_breakdown:
properties:
city:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
line_1:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
line_2:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
state_code:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
zip4:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
zip5:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
type: object
facial_similarity_video_breakdown_image_integrity_breakdown:
properties:
face_detected:
$ref: '#/components/schemas/facial_similarity_video_breakdown_image_integrity_breakdown_face_detected'
source_integrity:
$ref: '#/components/schemas/facial_similarity_video_breakdown_image_integrity_breakdown_source_integrity'
type: object
document_breakdown_visual_authenticity_breakdown:
example:
template:
result: result
properties: '{}'
other:
result: result
properties: '{}'
fonts:
result: result
properties: '{}'
digital_tampering:
result: result
properties: '{}'
picture_face_integrity:
result: result
properties: '{}'
face_detection:
result: result
properties: '{}'
original_document_present:
result: result
properties:
scan: scan
document_on_printed_paper: document_on_printed_paper
screenshot: screenshot
photo_of_screen: photo_of_screen
security_features:
result: result
properties: '{}'
properties:
fonts:
$ref: '#/components/schemas/document_breakdown_visual_authenticity_breakdown_fonts'
picture_face_integrity:
$ref: '#/components/schemas/document_breakdown_visual_authenticity_breakdown_picture_face_integrity'
template:
$ref: '#/components/schemas/document_breakdown_visual_authenticity_breakdown_template'
security_features:
$ref: '#/components/schemas/document_breakdown_visual_authenticity_breakdown_security_features'
original_document_present:
$ref: '#/components/schemas/document_breakdown_visual_authenticity_breakdown_original_document_present'
digital_tampering:
$ref: '#/components/schemas/document_breakdown_visual_authenticity_breakdown_digital_tampering'
other:
$ref: '#/components/schemas/document_breakdown_visual_authenticity_breakdown_other'
face_detection:
$ref: '#/components/schemas/document_breakdown_visual_authenticity_breakdown_face_detection'
type: object
facial_similarity_photo_report:
allOf:
- $ref: '#/components/schemas/report_shared'
- $ref: '#/components/schemas/facial_similarity_report_shared'
- properties:
breakdown:
$ref: '#/components/schemas/facial_similarity_photo_breakdown'
properties:
$ref: '#/components/schemas/facial_similarity_photo_properties'
type: object
watchlist_standard_report:
allOf:
- $ref: '#/components/schemas/report_shared'
- properties:
breakdown:
$ref: '#/components/schemas/watchlist_standard_breakdown'
properties:
$ref: '#/components/schemas/watchlist_standard_properties'
type: object
watchlist_aml_breakdown_politically_exposed_person:
description: Asserts if there are any records found in the proprietary database of Politically Exposed Persons sourced from government lists, websites and other media sources.
properties:
result:
type: string
type: object
document_breakdown_visual_authenticity_breakdown_fonts:
description: Fonts in the document don't match the expected ones.
example:
result: result
properties: '{}'
properties:
result:
type: string
properties:
type: object
type: object
identity_enhanced_breakdown_address_breakdown_credit_agencies_properties:
properties:
number_of_matches:
type: integer
type: object
document_IQ_reasons:
example:
incorrect_side: incorrect_side
glare_on_photo: glare_on_photo
other_photo_issue: other_photo_issue
cut_off_document: cut_off_document
covered_photo: covered_photo
two_documents_uploaded: two_documents_uploaded
blurred_photo: blurred_photo
no_document_in_image: no_document_in_image
damaged_document: damaged_document
dark_photo: dark_photo
properties:
dark_photo:
description: When an image of the document is too dark to be able to see data points.
type: string
glare_on_photo:
description: When there is light reflecting on the document causing glare to obstruct data points.
type: string
blurred_photo:
description: When data points are blurred and no reference can be made elsewhere in the document or if the data points are too blurry and 'they could be something else'.
type: string
covered_photo:
description: When data points have been covered either by the applicant or by another object such as a sticker.
type: string
other_photo_issue:
description: Any other reason not listed, such as when holograms are obscuring data points.
type: string
damaged_document:
description: When a document is damaged and we are unable to make out data points.
type: string
incorrect_side:
description: When the incorrect side of a document has been uploaded, and we have not received the front.
type: string
cut_off_document:
description: When data points are not included in the image due to the document being cut off.
type: string
no_document_in_image:
description: If no document has been uploaded or there is a blank image.
type: string
two_documents_uploaded:
description: When 2 different documents are submitted in the same check.
type: string
type: object
device_intelligence_breakdown_breakdown_device_breakdown:
properties:
application_authenticity:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
device_integrity:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
device_reputation:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
type: object
report_name:
enum:
- document
- document_video
- document_video_with_address_information
- document_with_address_information
- document_with_driving_licence_information
- document_with_driver_verification
- facial_similarity_photo
- facial_similarity_photo_fully_auto
- facial_similarity_video
- facial_similarity_motion
- known_faces
- identity_enhanced
- watchlist_aml
- watchlist_enhanced
- watchlist_standard
- watchlist_peps_only
- watchlist_sanctions_only
- proof_of_address
- us_driving_licence
- device_intelligence
- india_pan
type: string
identity_enhanced_breakdown_address_breakdown:
properties:
credit_agencies:
$ref: '#/components/schemas/identity_enhanced_breakdown_address_breakdown_credit_agencies'
telephone_database:
$ref: '#/components/schemas/identity_enhanced_breakdown_address_breakdown_telephone_database'
voting_register:
$ref: '#/components/schemas/identity_enhanced_breakdown_address_breakdown_voting_register'
type: object
document_breakdown_data_comparison:
description: Asserts whether data on the document is consistent with data provided when creating an applicant through the API.
example:
result: result
breakdown:
document_numbers:
result: result
properties: '{}'
gender:
result: result
properties: '{}'
issuing_country:
result: result
properties: '{}'
date_of_expiry:
result: result
properties: '{}'
date_of_birth:
result: result
properties: '{}'
last_name:
result: result
properties: '{}'
first_name:
result: result
properties: '{}'
document_type:
result: result
properties: '{}'
properties:
result:
type: string
breakdown:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown'
type: object
document_breakdown_compromised_document:
description: Asserts whether the image of the document has been found in our internal database or if it was used in a suspicious way.
example:
result: result
breakdown:
document_database:
result: result
properties: '{}'
repeat_attempts:
result: result
properties: '{}'
properties:
result:
type: string
breakdown:
$ref: '#/components/schemas/document_breakdown_compromised_document_breakdown'
type: object
document_breakdown_data_comparison_breakdown_issuing_country:
example:
result: result
properties: '{}'
properties:
result:
type: string
properties:
type: object
type: object
known_faces_properties:
properties:
matches:
description: Returns any matching applicant IDs as entries inside a matches array under a properties bag.
items:
$ref: '#/components/schemas/known_faces_properties_matches_inner'
type: array
type: object
facial_similarity_photo_fully_auto_breakdown:
properties:
face_comparison:
$ref: '#/components/schemas/facial_similarity_photo_breakdown_face_comparison'
image_integrity:
$ref: '#/components/schemas/facial_similarity_photo_fully_auto_breakdown_image_integrity'
visual_authenticity:
$ref: '#/components/schemas/facial_similarity_photo_breakdown_visual_authenticity'
type: object
document_properties_document_numbers_inner:
example:
type: type
value: value
properties:
value:
type: string
type:
type: string
type: object
document_breakdown_issuing_authority_breakdown:
example:
nfc_active_authentication:
result: result
properties: '{}'
nfc_passive_authentication:
result: result
properties: '{}'
properties:
nfc_active_authentication:
$ref: '#/components/schemas/document_breakdown_issuing_authority_breakdown_nfc_active_authentication'
nfc_passive_authentication:
$ref: '#/components/schemas/document_breakdown_issuing_authority_breakdown_nfc_passive_authentication'
type: object
document_breakdown_image_integrity_breakdown_colour_picture:
description: Asserts whether the image was a colour one.
example:
result: result
properties: '{}'
properties:
result:
type: string
properties:
type: object
type: object
proof_of_address_breakdown_image_integrity_breakdown:
properties:
image_quality:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
type: object
facial_similarity_report_shared:
properties:
live_photos:
description: Array of objects with live photo ids that were used in the Onfido engine.
items:
$ref: '#/components/schemas/facial_similarity_report_media'
type: array
live_videos:
description: Array of objects with live video ids that were used in the Onfido engine.
items:
$ref: '#/components/schemas/facial_similarity_report_media'
type: array
motion_captures:
description: Array of objects with motion capture ids that were used in the Onfido engine.
items:
$ref: '#/components/schemas/facial_similarity_report_media'
type: array
id_photos:
description: Array of objects with id photo ids that were used in the Onfido engine.
items:
$ref: '#/components/schemas/facial_similarity_report_media'
type: array
facial_similarity_video_breakdown_image_integrity:
description: Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
properties:
result:
type: string
breakdown:
$ref: '#/components/schemas/facial_similarity_video_breakdown_image_integrity_breakdown'
readOnly: true
type: object
facial_similarity_motion_properties:
properties:
score:
description: 'A floating point number between 0 and 1. The closer the score is to 0, the more likely
it is to be a spoof (i.e. videos of digital screens, masks or print-outs).
Conversely, the closer it is to 1, the less likely it is to be a spoof.
'
format: float
type: number
type: object
us_driving_licence_breakdown_address:
description: Asserts whether the address data provided matches a real driving license in the DMV driver's license database.
properties:
result:
type: string
breakdown:
$ref: '#/components/schemas/us_driving_licence_breakdown_address_breakdown'
type: object
document_properties_driving_licence_information:
example:
codes: codes
obtainment_date: '2000-01-23T00:00:00.000Z'
expiry_date: '2000-01-23T00:00:00.000Z'
category: category
properties:
category:
type: string
obtainment_date:
format: date
type: string
expiry_date:
format: date
type: string
codes:
type: string
type: object
identity_enhanced_breakdown:
properties:
sources:
$ref: '#/components/schemas/identity_enhanced_breakdown_sources'
address:
$ref: '#/components/schemas/identity_enhanced_breakdown_address'
date_of_birth:
$ref: '#/components/schemas/identity_enhanced_breakdown_date_of_birth'
mortality:
$ref: '#/components/schemas/identity_enhanced_breakdown_mortality'
type: object
identity_enhanced_properties:
properties:
matched_address:
description: Returns address number which has been matched.
type: number
matched_addresses:
description: Returns array of sources which contain matched addresses for the corresponding address number.
items:
$ref: '#/components/schemas/identity_enhanced_properties_matched_addresses_inner'
type: array
type: object
document_breakdown_data_consistency_breakdown:
example:
document_numbers:
result: result
properties: '{}'
gender:
result: result
properties: '{}'
nationality:
result: result
properties: '{}'
date_of_expiry:
result: result
properties: '{}'
issuing_country:
result: result
properties: '{}'
date_of_birth:
result: result
properties: '{}'
last_name:
result: result
properties: '{}'
multiple_data_sources_present:
result: result
properties: '{}'
first_name:
result: result
properties: '{}'
document_type:
result: result
properties: '{}'
properties:
date_of_expiry:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
document_numbers:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
issuing_country:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
document_type:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
date_of_birth:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
gender:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
first_name:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
nationality:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
last_name:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
multiple_data_sources_present:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
type: object
device_intelligence_breakdown_properties_geolocation:
properties:
city:
description: City location of the IP address.
type: string
region:
description: Region location of the IP address.
type: string
country:
allOf:
- $ref: '#/components/schemas/country_codes'
description: Country location of the IP address in a three letter format.
type: string
type: object
watchlist_enhanced_properties_records_inner_attribute_inner:
properties:
attribute_type:
type: string
attribute_value:
type: string
type: object
identity_enhanced_breakdown_address_breakdown_voting_register:
description: Address match against voting register.
properties:
result:
type: string
properties:
type: object
type: object
watchlist_enhanced_properties_records_inner_alias_inner:
properties:
alias_name:
type: string
alias_type:
type: string
type: object
us_driving_licence_breakdown_document:
description: Asserts whether the document data provided matches a real driving license in the DMV driver's license database.
properties:
result:
type: string
breakdown:
$ref: '#/components/schemas/us_driving_licence_breakdown_document_breakdown'
type: object
document_properties_address_lines:
example:
street_address: street_address
country: country
country_code: country_code
city: city
state: state
postal_code: postal_code
properties:
street_address:
type: string
state:
type: string
postal_code:
type: string
country:
type: string
city:
type: string
country_code:
type: string
type: object
facial_similarity_video_breakdown_face_comparison:
description: Asserts whether the face in the document matches the face in the live video.
properties:
result:
type: string
breakdown:
$ref: '#/components/schemas/facial_similarity_photo_breakdown_face_comparison_breakdown'
readOnly: true
type: object
report_status:
description: The current state of the report in the checking process. Read-only.
enum:
- awaiting_data
- awaiting_approval
- cancelled
- complete
- withdrawn
type: string
facial_similarity_photo_breakdown_image_integrity:
description: Asserts whether the quality and integrity of the uploaded files were sufficient to perform a face comparison.
properties:
result:
type: string
breakdown:
$ref: '#/components/schemas/facial_similarity_photo_breakdown_image_integrity_breakdown'
type: object
document_breakdown_data_validation:
description: Asserts whether algorithmically validatable elements are correct.
example:
result: result
breakdown:
document_numbers:
result: result
properties: '{}'
gender:
result: result
properties: '{}'
mrz:
result: result
properties: '{}'
document_expiration:
result: result
properties: '{}'
date_of_birth:
result: result
properties: '{}'
expiry_date:
result: result
properties: '{}'
barcode:
result: result
properties: '{}'
properties:
result:
type: string
breakdown:
$ref: '#/components/schemas/document_breakdown_data_validation_breakdown'
type: object
identity_enhanced_breakdown_date_of_birth_breakdown_credit_agencies:
description: Date of birth match against credit agencies.
properties:
result:
type: string
properties:
type: object
type: object
document_video_with_address_information_report:
allOf:
- $ref: '#/components/schemas/report_shared'
- properties:
breakdown:
$ref: '#/components/schemas/document_breakdown'
properties:
$ref: '#/components/schemas/document_properties'
type: object
us_driving_licence_breakdown:
properties:
document:
$ref: '#/components/schemas/us_driving_licence_breakdown_document'
address:
$ref: '#/components/schemas/us_driving_licence_breakdown_address'
personal:
$ref: '#/components/schemas/us_driving_licence_breakdown_personal'
type: object
document_breakdown_age_validation_breakdown:
example:
minimum_accepted_age:
result: result
properties: '{}'
properties:
minimum_accepted_age:
$ref: '#/components/schemas/document_breakdown_data_comparison_breakdown_issuing_country'
type: object
known_faces_breakdown_image_integrity:
description: Asserts whether the uploaded live photo or live video and the content contained within it were of sufficient quality to perform a face comparison.
properties:
result:
type: string
type: object
document_breakdown_data_consistency:
description: Asserts whether data represented
# --- truncated at 32 KB (157 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/onfido/refs/heads/main/openapi/onfido-reports-api-openapi.yml