Check.Request |
Check.Request.applicantId(String applicantId) |
The ID of the applicant to do the check on.
|
Check.Request |
Check.Request.applicantProvidesData(Boolean applicantProvidesData) |
Send an applicant form to applicant to complete to proceed with check.
|
Check.Request |
Check.Request.asynchronous(Boolean asynchronous) |
Defaults to `true`.
|
Check.Request |
Check.Request.consider(String... consider) |
Triggers a pre-determined 'consider' report result in the sandbox for reports specified in the array.
|
Check.Request |
Check.Request.consider(List<String> consider) |
Triggers a pre-determined 'consider' report result in the sandbox for reports specified in the array.
|
Check.Request |
Check.Request.documentIds(String... documentIds) |
An array of document ids (strings).
|
Check.Request |
Check.Request.documentIds(List<String> documentIds) |
An array of document ids (strings).
|
Check.Request |
Check.Request.privacyNoticesReadConsentGiven(Boolean privacyNoticesReadConsentGiven) |
Indicates that the privacy notices and terms of service have been read and, where specific laws require, that consent has been given for Onfido.
|
Check.Request |
Check.Request.redirectUri(String redirectUri) |
For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
|
Check.Request |
Check.Request.reportNames(String... reportNames) |
An array of report names (strings).
|
Check.Request |
Check.Request.reportNames(List<String> reportNames) |
An array of report names (strings).
|
static Check.Request |
Check.request() |
|
Check.Request |
Check.Request.subResult(String subResult) |
Triggers responses for particular sub-results for sandbox Document reports.
|
Check.Request |
Check.Request.suppressFormEmails(Boolean suppressFormEmails) |
For checks where `applicant_provides_data` is `true`, applicant form will not be automatically sent if `suppress_form_emails` is set to `true`.
|
Check.Request |
Check.Request.tags(String... tags) |
Array of tags being assigned to this check.
|
Check.Request |
Check.Request.tags(List<String> tags) |
Array of tags being assigned to this check.
|
Check.Request |
Check.Request.usDrivingLicence(DrivingLicence.Request usDrivingLicence) |
An object that contains all accepted fields for the Driver's License Data Verification report.
|
Check.Request |
Check.Request.webhookIds(String... webhookIds) |
Array of strings describing which webhooks to trigger for a check.
|
Check.Request |
Check.Request.webhookIds(List<String> webhookIds) |
Array of strings describing which webhooks to trigger for a check.
|