| id |
str |
The unique identifier for the check. Read-only. |
[optional] |
| created_at |
datetime |
The date and time when this check was created. Read-only. |
[optional] |
| href |
str |
The uri of this resource. Read-only. |
[optional] |
| status |
str |
The current state of the check in the checking process. Read-only. |
[optional] |
| result |
str |
The overall result of the check, based on the results of the constituent reports. Read-only. |
[optional] |
| download_uri |
str |
A link to a PDF output of the check results. Append `.pdf` to get the pdf file. Read-only. |
[optional] |
| form_uri |
str |
A link to the applicant form, if `applicant_provides_data` is `true`. Read-only. |
[optional] |
| redirect_uri |
str |
For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data. Read-only. |
[optional] |
| results_uri |
str |
A link to the corresponding results page on the Onfido dashboard. |
[optional] |
| report_names |
list[str] |
An array of report names (strings). |
[optional] |
| applicant_id |
str |
The ID of the applicant to do the check on. |
[optional] |
| tags |
list[str] |
Array of tags being assigned to this check. |
[optional] |
| applicant_provides_data |
bool |
Send an applicant form to applicant to complete to proceed with check. Defaults to false. |
[optional] |
| suppress_form_emails |
bool |
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 |
bool |
Defaults to `true`. Write-only. If set to `false`, you will only receive a response when all reports in your check have completed. |
[optional] |
| report_ids |
list[str] |
An array of report ids. |
[optional] |