Package com.onfido.models

Class DrivingLicence.Request

    • Method Detail

      • toJson

        public String toJson()

      • idNumber

        public DrivingLicence.Request idNumber​(String idNumber)
        Driving licence ID number
        Parameters:
        idNumber - Driving licence ID number
        Returns:
        The DrivingLicence request object.

      • stateCode

        public DrivingLicence.Request stateCode​(String stateCode)
        Two letter code of issuing state (state-issued driving licenses only)
        Parameters:
        stateCode - Two letter code of issuing state (state-issued driving licenses only)
        Returns:
        The DrivingLicence request object.

      • addressLine1

        public DrivingLicence.Request addressLine1​(String addressLine1)
        Line 1 of the address
        Parameters:
        addressLine1 - Line 1 of the address
        Returns:
        The DrivingLicence request object.

      • addressLine2

        public DrivingLicence.Request addressLine2​(String addressLine2)
        Line 2 of the address
        Parameters:
        addressLine2 - Line 2 of the address
        Returns:
        The DrivingLicence request object.

      • city

        public DrivingLicence.Request city​(String city)
        The city of the owner's address
        Parameters:
        city - The city of the owner's address
        Returns:
        The DrivingLicence request object.

      • dateOfBirth

        public DrivingLicence.Request dateOfBirth​(java.time.LocalDate dateOfBirth)
        Date of birth in yyyy-mm-dd format
        Parameters:
        dateOfBirth - Date of birth in yyyy-mm-dd format
        Returns:
        The DrivingLicence request object.

      • documentCategory

        public DrivingLicence.Request documentCategory​(String documentCategory)
        Document category. One of {"driver license", "driver permit", "id card"}
        Parameters:
        documentCategory - Document category. One of {"driver license", "driver permit", "id card"}
        Returns:
        The DrivingLicence request object.

      • expirationDate

        public DrivingLicence.Request expirationDate​(java.time.LocalDate expirationDate)
        Expiration date of the driving licence in yyyy-mm-dd format
        Parameters:
        expirationDate - Expiration date of the driving licence in yyyy-mm-dd format
        Returns:
        The DrivingLicence request object.

      • eyeColorCode

        public DrivingLicence.Request eyeColorCode​(String eyeColorCode)
        Eye color code. One of {"BLK", "BLU", "BRO", "DIC", "GRY", "GRN", "HAZ", "MAR", "PNK"}
        Parameters:
        eyeColorCode - Eye color code. One of {"BLK", "BLU", "BRO", "DIC", "GRY", "GRN", "HAZ", "MAR", "PNK"}
        Returns:
        The DrivingLicence request object.

      • firstName

        public DrivingLicence.Request firstName​(String firstName)
        The owner’s first name
        Parameters:
        firstName - The owner’s first name
        Returns:
        The DrivingLicence request object.

      • issueDate

        public DrivingLicence.Request issueDate​(java.time.LocalDate issueDate)
        Issue date in yyyy-mm-dd format
        Parameters:
        issueDate - Issue date in yyyy-mm-dd format
        Returns:
        The DrivingLicence request object.

      • lastName

        public DrivingLicence.Request lastName​(String lastName)
        The owner’s surname
        Parameters:
        lastName - The owner’s surname
        Returns:
        The DrivingLicence request object.

      • middleName

        public DrivingLicence.Request middleName​(String middleName)
        The owner’s middle name
        Parameters:
        middleName - The owner’s middle name
        Returns:
        The DrivingLicence request object.

      • nameSuffix

        public DrivingLicence.Request nameSuffix​(String nameSuffix)
        The owner’s name suffix
        Parameters:
        nameSuffix - The owner’s name suffix
        Returns:
        The DrivingLicence request object.

      • postalCode

        public DrivingLicence.Request postalCode​(String postalCode)
        The postcode or ZIP of the owner’s address
        Parameters:
        postalCode - The postcode or ZIP of the owner’s address
        Returns:
        The DrivingLicence request object.

      • state

        public DrivingLicence.Request state​(String state)
        The state of the owner's address. US states must use the USPS abbreviation, e.g. AK, CA, or TX.
        Parameters:
        state - The state of the owner's address. US states must use the USPS abbreviation, e.g. AK, CA, or TX.
        Returns:
        The DrivingLicence request object.

      • weightMeasure

        public DrivingLicence.Request weightMeasure​(Integer weightMeasure)
        Weight in pounds
        Parameters:
        weightMeasure - Weight in pounds
        Returns:
        The DrivingLicence request object.

      • getIdNumber

        public String getIdNumber()
        Driving licence ID number
        Returns:
        Driving licence ID number

      • getStateCode

        public String getStateCode()
        Two letter code of issuing state (state-issued driving licenses only)
        Returns:
        Two letter code of issuing state (state-issued driving licenses only)

      • getAddressLine1

        public String getAddressLine1()
        Line 1 of the address
        Returns:
        Line 1 of the address

      • getAddressLine2

        public String getAddressLine2()
        Line 2 of the address
        Returns:
        Line 2 of the address

      • getCity

        public String getCity()
        The city of the owner's address
        Returns:
        The city of the owner's address

      • getDateOfBirth

        public java.time.LocalDate getDateOfBirth()
        Date of birth in yyyy-mm-dd format
        Returns:
        Date of birth in yyyy-mm-dd format

      • getDocumentCategory

        public String getDocumentCategory()
        Document category. One of {"driver license", "driver permit", "id card"}
        Returns:
        Document category. One of {"driver license", "driver permit", "id card"}

      • getExpirationDate

        public java.time.LocalDate getExpirationDate()
        Expiration date of the driving licence in yyyy-mm-dd format
        Returns:
        Expiration date of the driving licence in yyyy-mm-dd format

      • getEyeColorCode

        public String getEyeColorCode()
        Eye color code. One of {"BLK", "BLU", "BRO", "DIC", "GRY", "GRN", "HAZ", "MAR", "PNK"}
        Returns:
        Eye color code. One of {"BLK", "BLU", "BRO", "DIC", "GRY", "GRN", "HAZ", "MAR", "PNK"}

      • getFirstName

        public String getFirstName()
        The owner’s first name
        Returns:
        The owner’s first name

      • getIssueDate

        public java.time.LocalDate getIssueDate()
        Issue date in yyyy-mm-dd format
        Returns:
        Issue date in yyyy-mm-dd format

      • getLastName

        public String getLastName()
        The owner’s surname
        Returns:
        The owner’s surname

      • getMiddleName

        public String getMiddleName()
        The owner’s middle name
        Returns:
        The owner’s middle name

      • getNameSuffix

        public String getNameSuffix()
        The owner’s name suffix
        Returns:
        The owner’s name suffix

      • getPostalCode

        public String getPostalCode()
        The postcode or ZIP of the owner’s address
        Returns:
        The postcode or ZIP of the owner’s address

      • getState

        public String getState()
        The state of the owner's address. US states must use the USPS abbreviation, e.g. AK, CA, or TX.
        Returns:
        The state of the owner's address. US states must use the USPS abbreviation, e.g. AK, CA, or TX.

      • getWeightMeasure

        public Integer getWeightMeasure()
        Weight in pounds
        Returns:
        Weight in pounds