Package com.onfido.models

Class Check.Request

  • Enclosing class:
    Check
    public static final class Check.Request
extends Object

    • Method Detail

      • toJson

        public String toJson()

      • redirectUri

        public Check.Request redirectUri​(String redirectUri)
        For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
        Parameters:
        redirectUri - For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
        Returns:
        The Check request object.

      • reportNames

        public Check.Request reportNames​(List<String> reportNames)
        An array of report names (strings).
        Parameters:
        reportNames - An array of report names (strings).
        Returns:
        The Check request object.

      • reportNames

        public Check.Request reportNames​(String... reportNames)
        An array of report names (strings).
        Parameters:
        reportNames - An array of report names (strings).
        Returns:
        The Check request object

      • documentIds

        public Check.Request documentIds​(List<String> documentIds)
        An array of document ids (strings).
        Parameters:
        documentIds - An array of document ids (strings).
        Returns:
        The Check request object.

      • documentIds

        public Check.Request documentIds​(String... documentIds)
        An array of document ids (strings).
        Parameters:
        documentIds - An array of document ids (strings).
        Returns:
        The Check request object

      • tags

        public Check.Request tags​(List<String> tags)
        Array of tags being assigned to this check.
        Parameters:
        tags - Array of tags being assigned to this check.
        Returns:
        The Check request object.

      • tags

        public Check.Request tags​(String... tags)
        Array of tags being assigned to this check.
        Parameters:
        tags - Array of tags being assigned to this check.
        Returns:
        The Check request object

      • applicantProvidesData

        public Check.Request applicantProvidesData​(Boolean applicantProvidesData)
        Send an applicant form to applicant to complete to proceed with check. Defaults to false.
        Parameters:
        applicantProvidesData - Send an applicant form to applicant to complete to proceed with check. Defaults to false.
        Returns:
        The Check request object.

      • suppressFormEmails

        public 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`. 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.
        Parameters:
        suppressFormEmails - 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.
        Returns:
        The Check request object.

      • asynchronous

        public Check.Request asynchronous​(Boolean asynchronous)
        Defaults to `true`. Write-only. If set to `false`, you will only receive a response when all reports in your check have completed.
        Parameters:
        asynchronous - Defaults to `true`. Write-only. If set to `false`, you will only receive a response when all reports in your check have completed.
        Returns:
        The Check request object.

      • applicantId

        public Check.Request applicantId​(String applicantId)
        The ID of the applicant to do the check on.
        Parameters:
        applicantId - The ID of the applicant to do the check on.
        Returns:
        The Check request object.

      • privacyNoticesReadConsentGiven

        public 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.
        Parameters:
        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.
        Returns:
        The Check request object.

      • webhookIds

        public Check.Request webhookIds​(List<String> webhookIds)
        Array of strings describing which webhooks to trigger for a check.
        Parameters:
        webhookIds - Array of strings describing which webhooks to trigger for a check.
        Returns:
        The Check request object.

      • webhookIds

        public Check.Request webhookIds​(String... webhookIds)
        Array of strings describing which webhooks to trigger for a check.
        Parameters:
        webhookIds - Array of strings describing which webhooks to trigger for a check.
        Returns:
        The Check request object

      • subResult

        public Check.Request subResult​(String subResult)
        Triggers responses for particular sub-results for sandbox Document reports.
        Parameters:
        subResult - Triggers responses for particular sub-results for sandbox Document reports.
        Returns:
        The Check request object.

      • consider

        public Check.Request consider​(List<String> consider)
        Triggers a pre-determined 'consider' report result in the sandbox for reports specified in the array.
        Parameters:
        consider - Triggers a pre-determined 'consider' report result in the sandbox for reports specified in the array.
        Returns:
        The Check request object.

      • consider

        public Check.Request consider​(String... consider)
        Triggers a pre-determined 'consider' report result in the sandbox for reports specified in the array.
        Parameters:
        consider - Triggers a pre-determined 'consider' report result in the sandbox for reports specified in the array.
        Returns:
        The Check request object

      • usDrivingLicence

        public Check.Request usDrivingLicence​(DrivingLicence.Request usDrivingLicence)
        An object that contains all accepted fields for the Driver's License Data Verification report.
        Parameters:
        usDrivingLicence - An object that contains all accepted fields for the Driver's License Data Verification report.
        Returns:
        The Check request object.

      • getRedirectUri

        public String getRedirectUri()
        For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.
        Returns:
        For checks where `applicant_provides_data` is `true`, redirect to this URI when the applicant has submitted their data.

      • getReportNames

        public String[] getReportNames()
        An array of report names (strings).
        Returns:
        An array of report names (strings).

      • getDocumentIds

        public String[] getDocumentIds()
        An array of document ids (strings).
        Returns:
        An array of document ids (strings).

      • getTags

        public String[] getTags()
        Array of tags being assigned to this check.
        Returns:
        Array of tags being assigned to this check.

      • getApplicantProvidesData

        public Boolean getApplicantProvidesData()
        Send an applicant form to applicant to complete to proceed with check. Defaults to false.
        Returns:
        Send an applicant form to applicant to complete to proceed with check. Defaults to false.

      • getSuppressFormEmails

        public Boolean getSuppressFormEmails()
        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.
        Returns:
        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.

      • getAsynchronous

        public Boolean getAsynchronous()
        Defaults to `true`. Write-only. If set to `false`, you will only receive a response when all reports in your check have completed.
        Returns:
        Defaults to `true`. Write-only. If set to `false`, you will only receive a response when all reports in your check have completed.

      • getApplicantId

        public String getApplicantId()
        The ID of the applicant to do the check on.
        Returns:
        The ID of the applicant to do the check on.

      • getPrivacyNoticesReadConsentGiven

        public Boolean getPrivacyNoticesReadConsentGiven()
        Indicates that the privacy notices and terms of service have been read and, where specific laws require, that consent has been given for Onfido.
        Returns:
        Indicates that the privacy notices and terms of service have been read and, where specific laws require, that consent has been given for Onfido.

      • getWebhookIds

        public String[] getWebhookIds()
        Array of strings describing which webhooks to trigger for a check.
        Returns:
        Array of strings describing which webhooks to trigger for a check.

      • getSubResult

        public String getSubResult()
        Triggers responses for particular sub-results for sandbox Document reports.
        Returns:
        Triggers responses for particular sub-results for sandbox Document reports.

      • getConsider

        public String[] getConsider()
        Triggers a pre-determined 'consider' report result in the sandbox for reports specified in the array.
        Returns:
        Triggers a pre-determined 'consider' report result in the sandbox for reports specified in the array.

      • getUsDrivingLicence

        public DrivingLicence.Request getUsDrivingLicence()
        An object that contains all accepted fields for the Driver's License Data Verification report.
        Returns:
        An object that contains all accepted fields for the Driver's License Data Verification report.