Package com.onfido.model

Class Document

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

    • Constructor Detail

      • Document

        public Document()

    • Method Detail

      • getSide

        @Nullable
public Document.SideEnum getSide()
        The side of the document, if applicable. The possible values are front and back
        Returns:
        side

      • getIssuingCountry

        @Nullable
public CountryCodes getIssuingCountry()
        The issuing country of the document, a 3-letter ISO code.
        Returns:
        issuingCountry

      • setIssuingCountry

        public void setIssuingCountry​(CountryCodes issuingCountry)

      • applicantId

        public Document applicantId​(UUID applicantId)

      • getApplicantId

        @Nullable
public UUID getApplicantId()
        The ID of the applicant whose document is being uploaded.
        Returns:
        applicantId

      • setApplicantId

        public void setApplicantId​(UUID applicantId)

      • getId

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

      • setId

        public void setId​(UUID id)

      • getCreatedAt

        @Nullable
public OffsetDateTime getCreatedAt()
        The date and time at which the document was uploaded
        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)

      • downloadHref

        public Document downloadHref​(String downloadHref)

      • getDownloadHref

        @Nullable
public String getDownloadHref()
        The uri that can be used to download the document
        Returns:
        downloadHref

      • setDownloadHref

        public void setDownloadHref​(String downloadHref)

      • getFileName

        @Nullable
public String getFileName()
        The name of the uploaded file
        Returns:
        fileName

      • setFileName

        public void setFileName​(String fileName)

      • getFileSize

        @Nullable
public Integer getFileSize()
        The size of the file in bytes
        Returns:
        fileSize

      • setFileSize

        public void setFileSize​(Integer fileSize)

      • putAdditionalProperty

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

      • fromJson

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

      • toJson

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