Package com.onfido.model

Class CheckRequest

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

    • Constructor Detail

      • CheckRequest

        public CheckRequest()

    • Method Detail

      • getReportNames

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

      • setReportNames

        public void setReportNames​(List<ReportName> reportNames)

      • addDocumentIdsItem

        public CheckRequest 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)

      • applicantProvidesData

        public CheckRequest 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)

      • 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 CheckRequest 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 CheckRequest 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 CheckRequest

      • fromJson

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

      • toJson

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