Constructor Detail

• IncodeWelcome.OCRData

  IncodeWelcome.OCRData(String birthDate, String fullName, String firstName, String givenNameMrz, String middleName, String lastName, String lastNameMrz, String address, String gender, int registrationDate, int issueDate, int expirationDate, String claveDeElector, String curp, String numeroEmisionCredencial, String cic, String ocr, String issuingCountry, int notExtracted, List<String> notExtractedDetails, Map<String, Object> extendedOcrJsonData)

• IncodeWelcome.OCRData

  IncodeWelcome.OCRData(ResponseOCRData response)

Method Detail

• getBirthDate

  @Nullable() String getBirthDate()

  Returns:

  User birth Date as UNIX timestamp in milliseconds, empty if unable to extract

• getFullName

  @Nullable() String getFullName()

  Returns:

  Full name of the user, empty if unable to extract

• getFirstName

  @Nullable() String getFirstName()

  Returns:

  First name of the user, empty if unable to extract

• getGivenNameMrz

  @Nullable() String getGivenNameMrz()

• getMiddleName

  @Nullable() String getMiddleName()

  Returns:

  Middle (or maternal) name of the user, empty if unable to extract

• getLastName

  @Nullable() String getLastName()

  Returns:

  Last (or paternal) name of the user, empty if unable to extract

• getLastNameMrz

  @Nullable() String getLastNameMrz()

• getAddress

  @Nullable() String getAddress()

  Returns:

  Address of the user, empty if unable to extract

• getGender

  @Nullable() String getGender()

  Returns:

  Gender of the user, "M" for male, "F" for female, empty if unable to extract

• getRegistrationDate

   int getRegistrationDate()

  Returns:

  year when the person was registered, 0 if unable to extract

• getIssueDate

   int getIssueDate()

  Returns:

  year when the ID was issued, 0 if unable to extract

• getExpirationDate

   int getExpirationDate()

  Returns:

  year when the ID will expire, 0 if unable to extract

• getClaveDeElector

   String getClaveDeElector()

  Returns:

  String, 18 characters. Clave de elector as read from id.

• getCurp

   String getCurp()

  Returns:

  String, 18 characters. Curp as read form id.

• getNumeroEmisionCredencial

   String getNumeroEmisionCredencial()

  Returns:

  Numero Emision Credencial as read from id.

• getCic

   String getCic()

  Returns:

  String, 9 characters. Cic as read from id. (This field is read from back side of id)

• getOcr

   String getOcr()

  Returns:

  String, 13 characters. Ocr as read from id. (This field is read from back side of id)

• getIssuingCountry

   String getIssuingCountry()

  Returns:

  Country that issued the document

• getNotExtracted

   int getNotExtracted()

  Returns:

  Number of fields that could not be extracted by the Ocr.

• getNotExtractedDetails

   List<String> getNotExtractedDetails()

  Returns:

  List of fields that could not be extracted from the id.

• getAddressFields

   IncodeWelcome.AddressFields getAddressFields()

  Returns:

  Address separated into following fields: street, colony, postal code, city and state read from the ID.

• getAddressFieldsFromStatement

   IncodeWelcome.AddressFields getAddressFieldsFromStatement()

  Returns:

  Address separated into following fields: street, colony, postal code, city and state read from the address statement.

• getExtendedOcrJsonData

   Map<String, Object> getExtendedOcrJsonData()

  Returns:

  A map with the raw data from the server response.

• createEmpty

   static IncodeWelcome.OCRData createEmpty()

• createDummy

   static IncodeWelcome.OCRData createDummy()

• toString

   String toString()