Class Applicant.Request

  • Enclosing class:
    Applicant

    public static final class Applicant.Request
    extends Object
    • Method Detail

      • toJson

        public String toJson()
      • firstName

        public Applicant.Request firstName​(String firstName)
        The applicant’s first name
        Parameters:
        firstName - The applicant’s first name
        Returns:
        The Applicant request object.
      • lastName

        public Applicant.Request lastName​(String lastName)
        The applicant’s surname
        Parameters:
        lastName - The applicant’s surname
        Returns:
        The Applicant request object.
      • email

        public Applicant.Request email​(String email)
        The applicant’s email address. Required if doing a US check or a standard UK check.
        Parameters:
        email - The applicant’s email address. Required if doing a US check or a standard UK check.
        Returns:
        The Applicant request object.
      • dob

        public Applicant.Request dob​(java.time.LocalDate dob)
        The applicant’s date of birth
        Parameters:
        dob - The applicant’s date of birth
        Returns:
        The Applicant request object.
      • address

        public Applicant.Request address​(Address.Request address)
        The applicants address
        Parameters:
        address - The applicants address
        Returns:
        The Applicant request object.
      • idNumbers

        public Applicant.Request idNumbers​(List<IdNumber.Request> idNumbers)
        The applicants ID numbers
        Parameters:
        idNumbers - The applicants ID numbers
        Returns:
        The Applicant request object.
      • idNumbers

        public Applicant.Request idNumbers​(IdNumber.Request... idNumbers)
        The applicants ID numbers
        Parameters:
        idNumbers - The applicants ID numbers
        Returns:
        The Applicant request object
      • phoneNumber

        public Applicant.Request phoneNumber​(String phoneNumber)
        The applicant’s phone number
        Parameters:
        phoneNumber - The applicant’s phone number
        Returns:
        The Applicant request object.
      • location

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

        public Applicant.Request consents​(List<Consent.Request> consents)
        The applicant’s consents
        Parameters:
        consents - The applicant’s consents
        Returns:
        The Applicant request object.
      • consents

        public Applicant.Request consents​(Consent.Request... consents)
        The applicant’s consents
        Parameters:
        consents - The applicant’s consents
        Returns:
        The Applicant request object
      • getFirstName

        public String getFirstName()
        The applicant’s first name
        Returns:
        The applicant’s first name
      • getLastName

        public String getLastName()
        The applicant’s surname
        Returns:
        The applicant’s surname
      • getEmail

        public String getEmail()
        The applicant’s email address. Required if doing a US check or a standard UK check.
        Returns:
        The applicant’s email address. Required if doing a US check or a standard UK check.
      • getDob

        public java.time.LocalDate getDob()
        The applicant’s date of birth
        Returns:
        The applicant’s date of birth
      • getAddress

        public Address.Request getAddress()
        The applicants address
        Returns:
        The applicants address
      • getIdNumbers

        public IdNumber.Request[] getIdNumbers()
        The applicants ID numbers
        Returns:
        The applicants ID numbers
      • getPhoneNumber

        public String getPhoneNumber()
        The applicant’s phone number
        Returns:
        The applicant’s phone number
      • getLocation

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

        public Consent.Request[] getConsents()
        The applicant’s consents
        Returns:
        The applicant’s consents