All Implemented Interfaces:


public final class IncodeWelcome.OCRData

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description

Field Summary

Fields
Modifier and Type	Field	Description
`private final String`	`birthDate`
`private final String`	`fullName`
`private final String`	`firstName`
`private final String`	`givenNameMrz`
`private final String`	`middleName`
`private final String`	`lastName`
`private final String`	`lastNameMrz`
`private final String`	`address`
`private final String`	`gender`
`private final Integer`	`registrationDate`
`private final Integer`	`issueDate`
`private final Integer`	`expirationDate`
`private final String`	`claveDeElector`
`private final String`	`curp`
`private final String`	`numeroEmisionCredencial`
`private final String`	`cic`
`private final String`	`ocr`
`private final String`	`issuingCountry`
`private final Integer`	`notExtracted`
`private final List<String>`	`notExtractedDetails`
`private final IncodeWelcome.AddressFields`	`addressFields`
`private final IncodeWelcome.AddressFields`	`addressFieldsFromStatement`
`private final Map<String, Object>`	`extendedOcrJsonData`

Constructor Summary

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

Enum Constant Summary

Enum Constants
Enum Constant	Description

Method Summary

Modifier and Type	Method	Description
`final String`	`getBirthDate()`	User birth Date as UNIX timestamp in milliseconds, empty if unable to extract
`final String`	`getFullName()`	Full name of the user, empty if unable to extract
`final String`	`getFirstName()`	First name of the user, empty if unable to extract
`final String`	`getGivenNameMrz()`
`final String`	`getMiddleName()`	Middle (or maternal) name of the user, empty if unable to extract
`final String`	`getLastName()`	Last (or paternal) name of the user, empty if unable to extract
`final String`	`getLastNameMrz()`
`final String`	`getAddress()`	Address of the user, empty if unable to extract
`final String`	`getGender()`	Gender of the user, "M" for male, "F" for female, empty if unable to extract
`final Integer`	`getRegistrationDate()`	year when the person was registered, 0 if unable to extract
`final Integer`	`getIssueDate()`	year when the ID was issued, 0 if unable to extract
`final Integer`	`getExpirationDate()`	year when the ID will expire, 0 if unable to extract
`final String`	`getClaveDeElector()`	String, 18 characters.
`final String`	`getCurp()`	String, 18 characters.
`final String`	`getNumeroEmisionCredencial()`	Numero Emision Credencial as read from id.
`final String`	`getCic()`	String, 9 characters.
`final String`	`getOcr()`	String, 13 characters.
`final String`	`getIssuingCountry()`	Country that issued the document
`final Integer`	`getNotExtracted()`	Number of fields that could not be extracted by the Ocr.
`final List<String>`	`getNotExtractedDetails()`	List of fields that could not be extracted from the id.
`final IncodeWelcome.AddressFields`	`getAddressFields()`	Address separated into following fields: street, colony, postal code, city and state read from the ID.
`final IncodeWelcome.AddressFields`	`getAddressFieldsFromStatement()`	Address separated into following fields: street, colony, postal code, city and state read from the address statement.
`final Map<String, Object>`	`getExtendedOcrJsonData()`	A map with the raw data from the server response.
`String`	`toString()`
`final static IncodeWelcome.OCRData`	`createEmpty()`
`final static IncodeWelcome.OCRData`	`createDummy()`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - IncodeWelcome.OCRData
```
IncodeWelcome.OCRData(String birthDate, String fullName, String firstName, String givenNameMrz, String middleName, String lastName, String lastNameMrz, String address, String gender, Integer registrationDate, Integer issueDate, Integer expirationDate, String claveDeElector, String curp, String numeroEmisionCredencial, String cic, String ocr, String issuingCountry, Integer notExtracted, List<String> notExtractedDetails, Map<String, Object> extendedOcrJsonData)
```
  - IncodeWelcome.OCRData
```
IncodeWelcome.OCRData(ResponseOCRData response)
```
- Method Detail
  - getBirthDate
```
 final String getBirthDate()
```
    User birth Date as UNIX timestamp in milliseconds, empty if unable to extract
  - getFullName
```
 final String getFullName()
```
    Full name of the user, empty if unable to extract
  - getFirstName
```
 final String getFirstName()
```
    First name of the user, empty if unable to extract
  - getGivenNameMrz
```
 final String getGivenNameMrz()
```
  - getMiddleName
```
 final String getMiddleName()
```
    Middle (or maternal) name of the user, empty if unable to extract
  - getLastName
```
 final String getLastName()
```
    Last (or paternal) name of the user, empty if unable to extract
  - getLastNameMrz
```
 final String getLastNameMrz()
```
  - getAddress
```
 final String getAddress()
```
    Address of the user, empty if unable to extract
  - getGender
```
 final String getGender()
```
    Gender of the user, "M" for male, "F" for female, empty if unable to extract
  - getRegistrationDate
```
 final Integer getRegistrationDate()
```
    year when the person was registered, 0 if unable to extract
  - getIssueDate
```
 final Integer getIssueDate()
```
    year when the ID was issued, 0 if unable to extract
  - getExpirationDate
```
 final Integer getExpirationDate()
```
    year when the ID will expire, 0 if unable to extract
  - getClaveDeElector
```
 final String getClaveDeElector()
```
    String, 18 characters. Clave de elector as read from id.
  - getCurp
```
 final String getCurp()
```
    String, 18 characters. Curp as read form id.
  - getNumeroEmisionCredencial
```
 final String getNumeroEmisionCredencial()
```
    Numero Emision Credencial as read from id.
  - getCic
```
 final String getCic()
```
    String, 9 characters. Cic as read from id. (This field is read from back side of id)
  - getOcr
```
 final String getOcr()
```
    String, 13 characters. Ocr as read from id. (This field is read from back side of id)
  - getIssuingCountry
```
 final String getIssuingCountry()
```
    Country that issued the document
  - getNotExtracted
```
 final Integer getNotExtracted()
```
    Number of fields that could not be extracted by the Ocr.
  - getNotExtractedDetails
```
 final List<String> getNotExtractedDetails()
```
    List of fields that could not be extracted from the id.
  - getAddressFields
```
 final IncodeWelcome.AddressFields getAddressFields()
```
    Address separated into following fields: street, colony, postal code, city and state read from the ID.
  - getAddressFieldsFromStatement
```
 final IncodeWelcome.AddressFields getAddressFieldsFromStatement()
```
    Address separated into following fields: street, colony, postal code, city and state read from the address statement.
  - getExtendedOcrJsonData
```
 final Map<String, Object> getExtendedOcrJsonData()
```
    A map with the raw data from the server response.
  - toString
```
 String toString()
```
  - createEmpty
```
 final static IncodeWelcome.OCRData createEmpty()
```
  - createDummy
```
 final static IncodeWelcome.OCRData createDummy()
```

Class IncodeWelcome.OCRData

Nested Class Summary

Field Summary

Constructor Summary

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

IncodeWelcome.OCRData

IncodeWelcome.OCRData

Method Detail

getBirthDate

getFullName

getFirstName

getGivenNameMrz

getMiddleName

getLastName

getLastNameMrz

getAddress

getGender

getRegistrationDate

getIssueDate

getExpirationDate

getClaveDeElector

getCurp

getNumeroEmisionCredencial

getCic

getOcr

getIssuingCountry

getNotExtracted

getNotExtractedDetails

getAddressFields

getAddressFieldsFromStatement

getExtendedOcrJsonData

toString

createEmpty

createDummy