Check.md

Onfido.Check

Properties

Name	Type	Description	Notes
id	String	The unique identifier for the check. Read-only.	[optional]
created_at	Date	The date and time when this check was created. Read-only.	[optional]
href	String	The uri of this resource. Read-only.	[optional]
status	String	The current state of the check in the checking process. Read-only.	[optional]
result	String	The overall result of the check, based on the results of the constituent reports. Read-only.	[optional]
download_uri	String	A link to a PDF output of the check results. Append `.pdf` to get the pdf file. Read-only.	[optional]
form_uri	String	A link to the applicant form, if the check is of type `standard`. Read-only.	[optional]
redirect_uri	String	For `standard` checks, redirect to this URI when the applicant has submitted their data. Read-only.	[optional]
results_uri	String	A link to the corresponding results page on the Onfido dashboard.	[optional]
type	String	The type of the check, `standard` or `express`.
report_type_groups	[String]	Array containing ids of the Report type groups being requested for. Write-only.	[optional]
tags	[String]	Array of tags being assigned to this check.	[optional]
suppress_form_emails	Boolean	For standard checks, applicant form will not be automatically sent if this is set to true. You can manually send the form at any time after the check has been created, using the link found in the form_uri attribute of the check object. Write-only. Defaults to false.	[optional]
charge_applicant_for_check	Boolean	For standard checks, applicants will be presented with a mandatory payment screen before they can submit the applicant form, if this is set to true. In this case, your account will not be charged. Write-only. Defaults to false.	[optional]
brand_id	String	ID of the brand under which the check should be conducted. Write-only.	[optional]
asynchronous	Boolean	If this is set to true, we will queue checks for processing and return a response immediately. You can configure webhooks to notify you when the report is complete. Write-only. Defaults to false.	[optional]
reports	[Report]	An array of reports.	[optional]