Package com.onfido.models

Class Document.Request

  • Enclosing class:
    Document
    public static final class Document.Request
extends Object

    • Method Detail

      • toJson

        public String toJson()

      • applicantId

        public Document.Request applicantId​(String applicantId)
        The ID of the associated applicant
        Parameters:
        applicantId - The ID of the associated applicant
        Returns:
        The Document request object.

      • type

        public Document.Request type​(String type)
        The type of document
        Parameters:
        type - The type of document
        Returns:
        The Document request object.

      • side

        public Document.Request side​(String side)
        The side of the document, if applicable. The possible values are front and back
        Parameters:
        side - The side of the document, if applicable. The possible values are front and back
        Returns:
        The Document request object.

      • issuingCountry

        public Document.Request issuingCountry​(String issuingCountry)
        The issuing country of the document, a 3-letter ISO code.
        Parameters:
        issuingCountry - The issuing country of the document, a 3-letter ISO code.
        Returns:
        The Document request object.

      • validateImageQuality

        public Document.Request validateImageQuality​(Boolean validateImageQuality)
        When true the submitted image will undergo an image quality validation
        Parameters:
        validateImageQuality - When true the submitted image will undergo an image quality validation
        Returns:
        The Document request object.

      • location

        public Document.Request location​(Location.Request location)
        The applicant's location
        Parameters:
        location - The applicant's location
        Returns:
        The Document request object.

      • getApplicantId

        public String getApplicantId()
        The ID of the associated applicant
        Returns:
        The ID of the associated applicant

      • getType

        public String getType()
        The type of document
        Returns:
        The type of document

      • getSide

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

      • getIssuingCountry

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

      • getValidateImageQuality

        public Boolean getValidateImageQuality()
        When true the submitted image will undergo an image quality validation
        Returns:
        When true the submitted image will undergo an image quality validation

      • getLocation

        public Location.Request getLocation()
        The applicant's location
        Returns:
        The applicant's location