Package com.onfido.model

Class CheckResponse

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

    • Constructor Detail

      • CheckResponse

        public CheckResponse()

    • Method Detail

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

      • getResultsUri

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

      • setResultsUri

        public void setResultsUri​(String resultsUri)

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

      • fromJson

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

      • toJson

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