Package com.onfido.model

Class CheckBuilder

  • @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           comments="Generator version: 7.9.0")
public class CheckBuilder
extends Object
    CheckBuilder

    • Constructor Detail

      • CheckBuilder

        public CheckBuilder()

    • Method Detail

      • getWebhookIds

        @Nullable
public List<String> getWebhookIds()
        An array of webhook ids describing which webhooks to trigger for this check.
        Returns:
        webhookIds

      • setWebhookIds

        public void setWebhookIds​(List<String> webhookIds)

      • getApplicantId

        @Nonnull
public UUID getApplicantId()
        The ID of the applicant to do the check on.
        Returns:
        applicantId

      • setApplicantId

        public void setApplicantId​(UUID applicantId)

      • applicantProvidesData

        public CheckBuilder applicantProvidesData​(Boolean applicantProvidesData)

      • getApplicantProvidesData

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

      • setApplicantProvidesData

        public void setApplicantProvidesData​(Boolean applicantProvidesData)

      • getTags

        @Nullable
public List<String> getTags()
        Array of tags being assigned to this check.
        Returns:
        tags

      • setTags

        public void setTags​(List<String> tags)

      • getRedirectUri

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

      • setRedirectUri

        public void setRedirectUri​(String redirectUri)

      • privacyNoticesReadConsentGiven

        public CheckBuilder privacyNoticesReadConsentGiven​(Boolean privacyNoticesReadConsentGiven)

      • getPrivacyNoticesReadConsentGiven

        @Nullable
public Boolean getPrivacyNoticesReadConsentGiven()
        Get privacyNoticesReadConsentGiven
        Returns:
        privacyNoticesReadConsentGiven

      • setPrivacyNoticesReadConsentGiven

        public void setPrivacyNoticesReadConsentGiven​(Boolean privacyNoticesReadConsentGiven)

      • getReportNames

        @Nonnull
public List<ReportName> getReportNames()
        An array of report names (strings).
        Returns:
        reportNames

      • setReportNames

        public void setReportNames​(List<ReportName> reportNames)

      • addDocumentIdsItem

        public CheckBuilder addDocumentIdsItem​(UUID documentIdsItem)

      • getDocumentIds

        @Nullable
public List<UUID> getDocumentIds()
        Optional. An array of document ids, for use with Document reports only. If omitted, the Document report will use the most recently uploaded document by default.
        Returns:
        documentIds

      • setDocumentIds

        public void setDocumentIds​(List<UUID> documentIds)

      • getAsynchronous

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

      • setAsynchronous

        public void setAsynchronous​(Boolean asynchronous)

      • getSuppressFormEmails

        @Nullable
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:
        suppressFormEmails

      • setSuppressFormEmails

        public void setSuppressFormEmails​(Boolean suppressFormEmails)

      • getSubResult

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

      • setSubResult

        public void setSubResult​(String subResult)

      • getConsider

        @Nullable
public List<ReportName> getConsider()
        Array of names of particular reports to return consider as their results. This is a feature available in sandbox testing
        Returns:
        consider

      • setConsider

        public void setConsider​(List<ReportName> consider)

      • putAdditionalProperty

        public CheckBuilder putAdditionalProperty​(String key,
                                          Object value)
        Set the additional (undeclared) property with the specified name and value. If the property does not already exist, create it otherwise replace it.
        Parameters:
        key - name of the property
        value - value of the property
        Returns:
        the CheckBuilder instance itself

      • getAdditionalProperties

        public Map<String,​Object> getAdditionalProperties()
        Return the additional (undeclared) property.
        Returns:
        a map of objects

      • getAdditionalProperty

        public Object getAdditionalProperty​(String key)
        Return the additional (undeclared) property with the specified name.
        Parameters:
        key - name of the property
        Returns:
        an object

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object

      • validateJsonElement

        public static void validateJsonElement​(com.google.gson.JsonElement jsonElement)
                                throws IOException
        Validates the JSON Element and throws an exception if issues found
        Parameters:
        jsonElement - JSON Element
        Throws:
        IOException - if the JSON Element is invalid with respect to CheckBuilder

      • fromJson

        public static CheckBuilder fromJson​(String jsonString)
                             throws IOException
        Create an instance of CheckBuilder given an JSON string
        Parameters:
        jsonString - JSON string
        Returns:
        An instance of CheckBuilder
        Throws:
        IOException - if the JSON string is invalid with respect to CheckBuilder

      • toJson

        public String toJson()
        Convert an instance of CheckBuilder to an JSON string
        Returns:
        JSON string