Class IdCardV1Document

  • Direct Known Subclasses:
    IdCardV1Page

    public class IdCardV1Document
    extends Prediction
    Carte Nationale d'Identité API version 1.1 document data.
    • Field Detail

      • authority

        protected StringField authority
        The name of the issuing authority.
      • birthDate

        protected DateField birthDate
        The date of birth of the card holder.
      • birthPlace

        protected StringField birthPlace
        The place of birth of the card holder.
      • expiryDate

        protected DateField expiryDate
        The expiry date of the identification card.
      • gender

        protected StringField gender
        The gender of the card holder.
      • givenNames

        protected List<StringField> givenNames
        The given name(s) of the card holder.
      • idNumber

        protected StringField idNumber
        The identification card number.
      • mrz1

        protected StringField mrz1
        Machine Readable Zone, first line
      • mrz2

        protected StringField mrz2
        Machine Readable Zone, second line
      • surname

        protected StringField surname
        The surname of the card holder.
    • Constructor Detail

      • IdCardV1Document

        public IdCardV1Document()
    • Method Detail

      • isEmpty

        public boolean isEmpty()
        Description copied from class: Prediction
        Returns true if there are no predictions values. Accessing prediction values when this is true may result in a NullPointerException
        Specified by:
        isEmpty in class Prediction
      • getAuthority

        public StringField getAuthority()
        The name of the issuing authority.
      • getBirthDate

        public DateField getBirthDate()
        The date of birth of the card holder.
      • getBirthPlace

        public StringField getBirthPlace()
        The place of birth of the card holder.
      • getExpiryDate

        public DateField getExpiryDate()
        The expiry date of the identification card.
      • getGender

        public StringField getGender()
        The gender of the card holder.
      • getGivenNames

        public List<StringField> getGivenNames()
        The given name(s) of the card holder.
      • getIdNumber

        public StringField getIdNumber()
        The identification card number.
      • getMrz1

        public StringField getMrz1()
        Machine Readable Zone, first line
      • getMrz2

        public StringField getMrz2()
        Machine Readable Zone, second line
      • getSurname

        public StringField getSurname()
        The surname of the card holder.
      • canEqual

        protected boolean canEqual​(Object other)
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object