Package com.onfido.model

Class Check

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

    • Constructor Detail

      • Check

        public Check()

    • Method Detail

      • addWebhookIdsItem

        public Check addWebhookIdsItem​(String webhookIdsItem)

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

      • applicantId

        public Check applicantId​(UUID applicantId)

      • 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 Check 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)

      • addTagsItem

        public Check addTagsItem​(String tagsItem)

      • getTags

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

      • setTags

        public void setTags​(List<String> tags)

      • redirectUri

        public Check redirectUri​(String redirectUri)

      • 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 Check privacyNoticesReadConsentGiven​(Boolean privacyNoticesReadConsentGiven)

      • getPrivacyNoticesReadConsentGiven

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

      • setPrivacyNoticesReadConsentGiven

        public void setPrivacyNoticesReadConsentGiven​(Boolean privacyNoticesReadConsentGiven)

      • getId

        @Nonnull
public UUID getId()
        The unique identifier for the check.
        Returns:
        id

      • setId

        public void setId​(UUID id)

      • getCreatedAt

        @Nullable
public OffsetDateTime getCreatedAt()
        The date and time when this check was created.
        Returns:
        createdAt

      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)

      • getHref

        @Nullable
public String getHref()
        The uri of this resource.
        Returns:
        href

      • setHref

        public void setHref​(String href)

      • setStatus

        public void setStatus​(CheckStatus status)

      • getResult

        @Nullable
public Check.ResultEnum getResult()
        The overall result of the check, based on the results of the constituent reports.
        Returns:
        result

      • getFormUri

        @Nullable
public String getFormUri()
        A link to the applicant form, if `applicant_provides_data` is `true`.
        Returns:
        formUri

      • setFormUri

        public void setFormUri​(String formUri)

      • resultsUri

        public Check resultsUri​(String resultsUri)

      • getResultsUri

        @Nullable
public String getResultsUri()
        A link to the corresponding results page on the Onfido dashboard.
        Returns:
        resultsUri

      • setResultsUri

        public void setResultsUri​(String resultsUri)

      • addReportIdsItem

        public Check addReportIdsItem​(UUID reportIdsItem)

      • getReportIds

        @Nullable
public List<UUID> getReportIds()
        An array of report ids.
        Returns:
        reportIds

      • setReportIds

        public void setReportIds​(List<UUID> reportIds)

      • getSandbox

        @Nullable
public Boolean getSandbox()
        Indicates whether the object was created in the sandbox or not.
        Returns:
        sandbox

      • setSandbox

        public void setSandbox​(Boolean sandbox)

      • setPaused

        public void setPaused​(Boolean paused)

      • getVersion

        @Nullable
public String getVersion()
        Get version
        Returns:
        version

      • setVersion

        public void setVersion​(String version)

      • putAdditionalProperty

        public Check 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 Check 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 Check

      • fromJson

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

      • toJson

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