Package com.onfido.model

Class Applicant

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

    • Constructor Detail

      • Applicant

        public Applicant()

    • Method Detail

      • getEmail

        @Nullable
public String getEmail()
        The applicant's email address. Required if doing a US check, or a UK check for which `applicant_provides_data` is `true`.
        Returns:
        email

      • setEmail

        public void setEmail​(String email)

      • setDob

        public void setDob​(LocalDate dob)

      • setIdNumbers

        public void setIdNumbers​(List<IdNumber> idNumbers)

      • getPhoneNumber

        @Nullable
public String getPhoneNumber()
        The applicant's phone number
        Returns:
        phoneNumber

      • setPhoneNumber

        public void setPhoneNumber​(String phoneNumber)

      • getFirstName

        @Nullable
public String getFirstName()
        The applicant's first name
        Returns:
        firstName

      • setFirstName

        public void setFirstName​(String firstName)

      • getLastName

        @Nullable
public String getLastName()
        The applicant's surname
        Returns:
        lastName

      • setLastName

        public void setLastName​(String lastName)

      • getId

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

      • setId

        public void setId​(UUID id)

      • getCreatedAt

        @Nullable
public OffsetDateTime getCreatedAt()
        The date and time when this applicant was created.
        Returns:
        createdAt

      • setCreatedAt

        public void setCreatedAt​(OffsetDateTime createdAt)

      • getDeleteAt

        @Nullable
public OffsetDateTime getDeleteAt()
        The date and time when this applicant is scheduled to be deleted.
        Returns:
        deleteAt

      • getHref

        @Nullable
public String getHref()
        The uri of this resource.
        Returns:
        href

      • setHref

        public void setHref​(String href)

      • getSandbox

        @Nullable
public Boolean getSandbox()
        Get sandbox
        Returns:
        sandbox

      • setSandbox

        public void setSandbox​(Boolean sandbox)

      • getAddress

        @Nullable
public Address getAddress()
        Get address
        Returns:
        address

      • setAddress

        public void setAddress​(Address address)

      • getLocation

        @Nullable
public Location getLocation()
        Get location
        Returns:
        location

      • setLocation

        public void setLocation​(Location location)

      • putAdditionalProperty

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

      • fromJson

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

      • toJson

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