Check.md

Check

Properties

Name	Type	Description	Notes
id	String	The unique identifier for the check. Read-only.	[optional]
createdAt	OffsetDateTime	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]
downloadUri	String	A link to a PDF output of the check results. Append `.pdf` to get the pdf file. Read-only.	[optional]
formUri	String	A link to the applicant form, if `applicant_provides_data` is `true`. Read-only.	[optional]
redirectUri	String	For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data. Read-only.	[optional]
resultsUri	String	A link to the corresponding results page on the Onfido dashboard.	[optional]
reportNames	List<String>	An array of report names (strings).	[optional]
applicantId	String	The ID of the applicant to do the check on.	[optional]
tags	List<String>	Array of tags being assigned to this check.	[optional]
applicantProvidesData	Boolean	Send an applicant form to applicant to complete to proceed with check. Defaults to false.	[optional]
suppressFormEmails	Boolean	For checks where `applicant_provides_data` is `true`, applicant form will not be automatically sent if `suppress_form_emails` 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]
asynchronous	Boolean	Defaults to `true`. Write-only. If set to `false`, you will only receive a response when all reports in your check have completed.	[optional]
reportIds	List<String>	An array of report ids.	[optional]