Package com.yoti.api.client

Class HumanProfile

java.lang.Object
com.yoti.api.client.Profile
com.yoti.api.client.HumanProfile
public class HumanProfile extends Profile

  • Field Details

  • Constructor Details

    • HumanProfile

      public HumanProfile(List<Attribute<?>> attributeList)
      Create a new Human profile based on a list of attributes
      Parameters:
      attributeList - list containing the attributes for this profile

  • Method Details

    • getFamilyName

      public Attribute<String> getFamilyName()
      Corresponds to primary name in passport, and surname in English.
      Returns:
      the family name

    • getGivenNames

      public Attribute<String> getGivenNames()
      Corresponds to secondary names in passport, and first/middle names in English.
      Returns:
      the given names

    • getFullName

      public Attribute<String> getFullName()
      The full name attribute.
      Returns:
      the full name

    • getDateOfBirth

      public Attribute<Date> getDateOfBirth()
      Date of birth
      Returns:
      Date of birth

    • getAgeVerifications

      public List<AgeVerification> getAgeVerifications()
      Finds all the 'Age Over' and 'Age Under' derived attributes returned with the profile, and returns them wrapped in AgeVerification objects
      Returns:
      A list of all the AgeVerification objects returned for this profile

    • findAgeOverVerification

      public AgeVerification findAgeOverVerification(int age)
      Searches for an AgeVerification corresponding to an 'Age Over' check for the given age
      Parameters:
      age - the age the search over
      Returns:
      age_over AgeVerification for the given age, or null if no match was found

    • findAgeUnderVerification

      public AgeVerification findAgeUnderVerification(int age)
      Searches for an AgeVerification corresponding to an 'Age Under' check for the given age
      Parameters:
      age - the age to search under
      Returns:
      age_under AgeVerification for the given age, or null if no match was found

    • getGender

      public Attribute<String> getGender()
      Corresponds to the gender in the passport; will be one of the strings "MALE", "FEMALE", "TRANSGENDER" or "OTHER".
      Returns:
      the gender

    • getPostalAddress

      public Attribute<String> getPostalAddress()
      The user's postal address as a String
      Returns:
      the postal address

    • getStructuredPostalAddress

      public Attribute<Map<?,?>> getStructuredPostalAddress()
      The user's structured postal address as a Json
      Returns:
      the postal address

    • getNationality

      public Attribute<String> getNationality()
      Corresponds to the nationality in the passport.
      Returns:
      the nationality

    • getPhoneNumber

      public Attribute<String> getPhoneNumber()
      The user's phone number, as verified at registration time. This will be a number with + for international prefix and no spaces, e.g. "+447777123456".
      Returns:
      the phone number

    • getSelfie

      public Attribute<Image> getSelfie()
      Photograph of user, encoded as a JPEG image.
      Returns:
      the selfie

    • getEmailAddress

      public Attribute<String> getEmailAddress()
      The user's verified email address.
      Returns:
      the email address

    • getDocumentDetails

      public Attribute<DocumentDetails> getDocumentDetails()
      Document details
      Returns:
      the document details

    • getDocumentImages

      public Attribute<List<Image>> getDocumentImages()
      Document images
      Returns:
      images of the document

    • getIdentityProfileReport

      public Attribute<Map<String,Object>> getIdentityProfileReport()
      JSON object containing identity assertion and the verification report. This will be null if not provided by Yoti.
      Returns:
      the identity profile report