Package com.jumio.sdk.retrieval_v3.model

Class ExtractionCapabilityResponseData

java.lang.Object

com.jumio.sdk.retrieval_v3.model.ExtractionCapabilityResponseData

              @Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
                date="2025-10-16T16:59:20.653944300+02:00[Europe/Vienna]") public class ExtractionCapabilityResponseData
              extends
                Object
            

ExtractionCapabilityResponseData

Field Summary

Fields

Modifier and Type	Field	Description
static final String	JSON_PROPERTY_ACADEMIC_DEGREE
static final String	JSON_PROPERTY_ACCOUNT_NUMBER
static final String	JSON_PROPERTY_ADDITIONAL_LANGUAGE
static final String	JSON_PROPERTY_ADDRESS
static final String	JSON_PROPERTY_BLOOD_GROUP
static final String	JSON_PROPERTY_BODY_HEIGHT
static final String	JSON_PROPERTY_BODY_WEIGHT
static final String	JSON_PROPERTY_CARD_NUMBER_LAST_FOUR_DIGITS
static final String	JSON_PROPERTY_CITIZENSHIP
static final String	JSON_PROPERTY_CONTROL_NUMBER
static final String	JSON_PROPERTY_CPF
static final String	JSON_PROPERTY_CURP
static final String	JSON_PROPERTY_CURRENT_AGE
static final String	JSON_PROPERTY_CUSTOM_EXTRACTION_POINTS
static final String	JSON_PROPERTY_DATE_OF_BIRTH
static final String	JSON_PROPERTY_DATE_OF_BIRTH_PARTS
static final String	JSON_PROPERTY_DISABILITIES
static final String	JSON_PROPERTY_DL_CATEGORIES
static final String	JSON_PROPERTY_DL_ENDORSEMENTS
static final String	JSON_PROPERTY_DL_RESTRICTIONS
static final String	JSON_PROPERTY_DNI
static final String	JSON_PROPERTY_DOCUMENT_COPY
static final String	JSON_PROPERTY_DOCUMENT_FIRST_ISSUING_DATE
static final String	JSON_PROPERTY_DOCUMENT_IDENTIFICATION_NUMBER
static final String	JSON_PROPERTY_DOCUMENT_NUMBER
static final String	JSON_PROPERTY_DOCUMENT_TYPE
static final String	JSON_PROPERTY_DUE_DATE
static final String	JSON_PROPERTY_DUE_DATE_PARTS
static final String	JSON_PROPERTY_DURATION_OF_STAY
static final String	JSON_PROPERTY_EMPLOYER
static final String	JSON_PROPERTY_ETHNICITY
static final String	JSON_PROPERTY_EXPIRY_DATE
static final String	JSON_PROPERTY_EXPIRY_DATE_PARTS
static final String	JSON_PROPERTY_EYE_COLOR
static final String	JSON_PROPERTY_FATHERS_NAME
static final String	JSON_PROPERTY_FIRST_NAME
static final String	JSON_PROPERTY_GENDER
static final String	JSON_PROPERTY_HAIR_COLOR
static final String	JSON_PROPERTY_ISSUING_AUTHORITY
static final String	JSON_PROPERTY_ISSUING_COUNTRY
static final String	JSON_PROPERTY_ISSUING_DATE
static final String	JSON_PROPERTY_ISSUING_DATE_PARTS
static final String	JSON_PROPERTY_ISSUING_NUMBER
static final String	JSON_PROPERTY_ISSUING_PLACE
static final String	JSON_PROPERTY_LABOR_IDENTIFICATION_NUMBER
static final String	JSON_PROPERTY_LAST_NAME
static final String	JSON_PROPERTY_LAST_NAME_AT_BIRTH
static final String	JSON_PROPERTY_MARITAL_STATUS
static final String	JSON_PROPERTY_MIDDLE_NAME
static final String	JSON_PROPERTY_MILITARY_NUMBER
static final String	JSON_PROPERTY_MILITARY_STATUS
static final String	JSON_PROPERTY_MONTH_YEAR_EXPIRY
static final String	JSON_PROPERTY_MOTHERS_NAME
static final String	JSON_PROPERTY_MRZ
static final String	JSON_PROPERTY_NATIONALITY
static final String	JSON_PROPERTY_NUMBER_OF_ENTRIES
static final String	JSON_PROPERTY_OPTIONAL_MRZ_FIELD1
static final String	JSON_PROPERTY_OPTIONAL_MRZ_FIELD2
static final String	JSON_PROPERTY_PAN_NUMBER
static final String	JSON_PROPERTY_PASSPORT_NUMBER
static final String	JSON_PROPERTY_PERSONAL_IDENTIFICATION_NUMBER
static final String	JSON_PROPERTY_PERSONAL_NUMBER
static final String	JSON_PROPERTY_PESEL
static final String	JSON_PROPERTY_PETITIONER
static final String	JSON_PROPERTY_PLACE_OF_BIRTH
static final String	JSON_PROPERTY_PROFESSION
static final String	JSON_PROPERTY_REGISTRATION_NUMBER
static final String	JSON_PROPERTY_RELIGION
static final String	JSON_PROPERTY_REMARKS
static final String	JSON_PROPERTY_RESIDENT_PERMIT_NUMBER
static final String	JSON_PROPERTY_RESIDENT_PERMIT_REMARKS
static final String	JSON_PROPERTY_RESIDENT_PERMIT_TYPE
static final String	JSON_PROPERTY_RG_NUMBER
static final String	JSON_PROPERTY_RHESUS_FACTOR
static final String	JSON_PROPERTY_SALUTATION
static final String	JSON_PROPERTY_SERIAL_NUMBER
static final String	JSON_PROPERTY_SIGNATURE_AVAILABLE
static final String	JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
static final String	JSON_PROPERTY_STATE
static final String	JSON_PROPERTY_SUB_TYPE
static final String	JSON_PROPERTY_SWIFT_CODE
static final String	JSON_PROPERTY_TAX_NUMBER
static final String	JSON_PROPERTY_TYPE
static final String	JSON_PROPERTY_VISA_CATEGORY
static final String	JSON_PROPERTY_VOTER_ID_NUMBER
static final String	JSON_PROPERTY_WORK_PERMIT_NUMBER

Constructor Summary

Constructors

Constructor	Description
ExtractionCapabilityResponseData()

Method Summary

Modifier and Type	Method	Description
ExtractionCapabilityResponseData	academicDegree(String academicDegree)
ExtractionCapabilityResponseData	accountNumber(String accountNumber)
ExtractionCapabilityResponseData	addDlCategoriesItem(DrivingLicenseCategory dlCategoriesItem)
ExtractionCapabilityResponseData	addDlRestrictionsItem(DlRestriction dlRestrictionsItem)
ExtractionCapabilityResponseData	additionalLanguage(ExtractionCapabilityResponseDataAdditionalLanguage additionalLanguage)
ExtractionCapabilityResponseData	address(AddressResponse address)
ExtractionCapabilityResponseData	bloodGroup(String bloodGroup)
ExtractionCapabilityResponseData	bodyHeight(String bodyHeight)
ExtractionCapabilityResponseData	bodyWeight(String bodyWeight)
ExtractionCapabilityResponseData	cardNumberLastFourDigits(String cardNumberLastFourDigits)
ExtractionCapabilityResponseData	citizenship(String citizenship)
ExtractionCapabilityResponseData	controlNumber(String controlNumber)
ExtractionCapabilityResponseData	cpf(String cpf)
ExtractionCapabilityResponseData	curp(String curp)
ExtractionCapabilityResponseData	currentAge(String currentAge)
ExtractionCapabilityResponseData	customExtractionPoints(Map<String,Object> customExtractionPoints)
ExtractionCapabilityResponseData	dateOfBirth(LocalDate dateOfBirth)
ExtractionCapabilityResponseData	dateOfBirthParts(DateParts dateOfBirthParts)
ExtractionCapabilityResponseData	disabilities(String disabilities)
ExtractionCapabilityResponseData	dlCategories(List<DrivingLicenseCategory> dlCategories)
ExtractionCapabilityResponseData	dlEndorsements(String dlEndorsements)
ExtractionCapabilityResponseData	dlRestrictions(List<DlRestriction> dlRestrictions)
ExtractionCapabilityResponseData	dni(String dni)
ExtractionCapabilityResponseData	documentCopy(String documentCopy)
ExtractionCapabilityResponseData	documentFirstIssuingDate(LocalDate documentFirstIssuingDate)
ExtractionCapabilityResponseData	documentIdentificationNumber(String documentIdentificationNumber)
ExtractionCapabilityResponseData	documentNumber(String documentNumber)
ExtractionCapabilityResponseData	documentType(String documentType)
ExtractionCapabilityResponseData	dueDate(LocalDate dueDate)
ExtractionCapabilityResponseData	dueDateParts(DateParts dueDateParts)
ExtractionCapabilityResponseData	durationOfStay(String durationOfStay)
ExtractionCapabilityResponseData	employer(String employer)
boolean	equals(Object o)
ExtractionCapabilityResponseData	ethnicity(String ethnicity)
ExtractionCapabilityResponseData	expiryDate(LocalDate expiryDate)
ExtractionCapabilityResponseData	expiryDateParts(DateParts expiryDateParts)
ExtractionCapabilityResponseData	eyeColor(String eyeColor)
ExtractionCapabilityResponseData	fathersName(String fathersName)
ExtractionCapabilityResponseData	firstName(String firstName)
ExtractionCapabilityResponseData	gender(String gender)
String	getAcademicDegree()	Academic degree (if extraction is enabled)
String	getAccountNumber()	Get accountNumber
ExtractionCapabilityResponseDataAdditionalLanguage	getAdditionalLanguage()	Get additionalLanguage
AddressResponse	getAddress()	Get address
String	getBloodGroup()	Blood group (if extraction is enabled)
String	getBodyHeight()	Body height (if extraction is enabled)
String	getBodyWeight()	Body weight (if extraction is enabled)
String	getCardNumberLastFourDigits()	contains last 4 digits of credit card number for CCS document type
String	getCitizenship()	Citizenship (if extraction is enabled)
String	getControlNumber()	Control number (if extraction is enabled)
String	getCpf()	Get cpf
String	getCurp()	The CURP for mexican documents
String	getCurrentAge()	Current age, calculated based on the date of birth or the date of birth parts field (if currentAge calculation is enabled)
Map<String,Object>	getCustomExtractionPoints()	Get customExtractionPoints
LocalDate	getDateOfBirth()	Get dateOfBirth
DateParts	getDateOfBirthParts()	Get dateOfBirthParts
String	getDisabilities()	Disabilities (if extraction is enabled)
List<DrivingLicenseCategory>	getDlCategories()	Get dlCategories
String	getDlEndorsements()	Driving license endorsements (if extraction is enabled)
List<DlRestriction>	getDlRestrictions()	Get dlRestrictions
String	getDni()	DNI as available on the ID if idCountry = ESP and idSubtype = NATIONAL_ID
String	getDocumentCopy()	Document copy (if extraction is enabled)
LocalDate	getDocumentFirstIssuingDate()	Document First Issuing Date (if extraction is enabled)
String	getDocumentIdentificationNumber()	Document identification number (if extraction is enabled)
String	getDocumentNumber()	Get documentNumber
String	getDocumentType()	Get documentType
LocalDate	getDueDate()	Get dueDate
DateParts	getDueDateParts()	Get dueDateParts
String	getDurationOfStay()	Duration of stay if idType = VISA and additional extraction for Visa enabled
String	getEmployer()	Employer (if extraction is enabled)
String	getEthnicity()	Ethnicity (if extraction is enabled)
LocalDate	getExpiryDate()	Get expiryDate
DateParts	getExpiryDateParts()	Get expiryDateParts
String	getEyeColor()	Eye color (if extraction is enabled)
String	getFathersName()	Get fathersName
String	getFirstName()	Get firstName
String	getGender()	- M - F - X
String	getHairColor()	Hair color (if extraction is enabled)
String	getIssuingAuthority()	Issuing authority of the document
String	getIssuingCountry()	The country this document was issued.
LocalDate	getIssuingDate()	Get issuingDate
DateParts	getIssuingDateParts()	Get issuingDateParts
String	getIssuingNumber()	\\\"Numero de emission\\\" number for idCountry = MEX (if extraction is enabled)
String	getIssuingPlace()	Issuing place of the document
String	getLaborIdentificationNumber()	Labor identification number (if extraction is enabled)
String	getLastName()	Get lastName
String	getLastNameAtBirth()	Last name at birth (if extraction is enabled)
String	getMaritalStatus()	Marital status (if extraction is enabled)
String	getMiddleName()	Middle name (if extraction is enabled)
String	getMilitaryNumber()	Military number (if extraction is enabled)
String	getMilitaryStatus()	Military status (if extraction is enabled)
String	getMonthYearExpiry()	contains credit card's expiry date in format MM/YY
String	getMothersName()	Get mothersName
ExtractionCapabilityResponseDataMrz	getMrz()	Get mrz
String	getNationality()	Nationality of the document holder in ISO 3166-1 alpha-3 country code or country specific non ISO nationalities (3 letters)
String	getNumberOfEntries()	Number of entries if idType = VISA and additional extraction for Visa enabled
String	getOptionalMrzField1()	Optional field of MRZ line 1
String	getOptionalMrzField2()	Optional field of MRZ line 2
String	getPanNumber()	PAN number in case of CC document type (Can be masked as well)
String	getPassportNumber()	Passport number either for documents with VISA idType or passport number on non-VISA documents (if passport number extraction of non-VISA documents is enabled)
String	getPersonalIdentificationNumber()	Get personalIdentificationNumber
String	getPersonalNumber()	Get personalNumber
String	getPesel()	Get pesel
String	getPetitioner()	Petitioner (if extraction is enabled)
String	getPlaceOfBirth()	Get placeOfBirth
String	getProfession()	Profession (if extraction is enabled)
String	getRegistrationNumber()	Get registrationNumber
String	getReligion()	Religion (if extraction is enabled)
String	getRemarks()	Remarks (if extraction is enabled)
String	getResidentPermitNumber()	Resident permit number (if extraction is enabled)
String	getResidentPermitRemarks()	Permit remarks related to \"Golden Visas\" (if extraction is enabled)
String	getResidentPermitType()	Permit type related to \"Golden Visas\" (if extraction is enabled)
String	getRgNumber()	Get rgNumber
String	getRhesusFactor()	Rhesus factor (if extraction is enabled)
String	getSalutation()	Salutation (if extraction is enabled)
String	getSerialNumber()	Serial number (if extraction is enabled)
Boolean	getSignatureAvailable()	whether signature is available on SSN or not (only applies to SSN in USA)
String	getSocialSecurityNumber()	represents the SSN for USA
String	getState()	Possible values: - Last two characters of ISO 3166-2:US state code - Last 2-3 characters of ISO 3166-2:AU state code - Last two characters of ISO 3166-2:CA state code - ISO 3166-1 country name - XKX (Kosovo) - Free text if it can't be mapped to a state/country code
String	getSubType()	Get subType
String	getSwiftCode()	Get swiftCode
String	getTaxNumber()	Tax number of the document in case the country is ITA and type is HEALTH_ID or TAX_ID
String	getType()	Get type
String	getVisaCategory()	Visa category if idType = VISA and additional extraction for Visa enabled
String	getVoterIdNumber()	\\\"Clave de elector\\\" number for idCountry = MEX (if extraction is enabled)
String	getWorkPermitNumber()	Work permit number (if extraction is enabled)
ExtractionCapabilityResponseData	hairColor(String hairColor)
int	hashCode()
ExtractionCapabilityResponseData	issuingAuthority(String issuingAuthority)
ExtractionCapabilityResponseData	issuingCountry(String issuingCountry)
ExtractionCapabilityResponseData	issuingDate(LocalDate issuingDate)
ExtractionCapabilityResponseData	issuingDateParts(DateParts issuingDateParts)
ExtractionCapabilityResponseData	issuingNumber(String issuingNumber)
ExtractionCapabilityResponseData	issuingPlace(String issuingPlace)
ExtractionCapabilityResponseData	laborIdentificationNumber(String laborIdentificationNumber)
ExtractionCapabilityResponseData	lastName(String lastName)
ExtractionCapabilityResponseData	lastNameAtBirth(String lastNameAtBirth)
ExtractionCapabilityResponseData	maritalStatus(String maritalStatus)
ExtractionCapabilityResponseData	middleName(String middleName)
ExtractionCapabilityResponseData	militaryNumber(String militaryNumber)
ExtractionCapabilityResponseData	militaryStatus(String militaryStatus)
ExtractionCapabilityResponseData	monthYearExpiry(String monthYearExpiry)
ExtractionCapabilityResponseData	mothersName(String mothersName)
ExtractionCapabilityResponseData	mrz(ExtractionCapabilityResponseDataMrz mrz)
ExtractionCapabilityResponseData	nationality(String nationality)
ExtractionCapabilityResponseData	numberOfEntries(String numberOfEntries)
ExtractionCapabilityResponseData	optionalMrzField1(String optionalMrzField1)
ExtractionCapabilityResponseData	optionalMrzField2(String optionalMrzField2)
ExtractionCapabilityResponseData	panNumber(String panNumber)
ExtractionCapabilityResponseData	passportNumber(String passportNumber)
ExtractionCapabilityResponseData	personalIdentificationNumber(String personalIdentificationNumber)
ExtractionCapabilityResponseData	personalNumber(String personalNumber)
ExtractionCapabilityResponseData	pesel(String pesel)
ExtractionCapabilityResponseData	petitioner(String petitioner)
ExtractionCapabilityResponseData	placeOfBirth(String placeOfBirth)
ExtractionCapabilityResponseData	profession(String profession)
ExtractionCapabilityResponseData	putCustomExtractionPointsItem(String key, Object customExtractionPointsItem)
ExtractionCapabilityResponseData	registrationNumber(String registrationNumber)
ExtractionCapabilityResponseData	religion(String religion)
ExtractionCapabilityResponseData	remarks(String remarks)
ExtractionCapabilityResponseData	residentPermitNumber(String residentPermitNumber)
ExtractionCapabilityResponseData	residentPermitRemarks(String residentPermitRemarks)
ExtractionCapabilityResponseData	residentPermitType(String residentPermitType)
ExtractionCapabilityResponseData	rgNumber(String rgNumber)
ExtractionCapabilityResponseData	rhesusFactor(String rhesusFactor)
ExtractionCapabilityResponseData	salutation(String salutation)
ExtractionCapabilityResponseData	serialNumber(String serialNumber)
void	setAcademicDegree(String academicDegree)
void	setAccountNumber(String accountNumber)
void	setAdditionalLanguage(ExtractionCapabilityResponseDataAdditionalLanguage additionalLanguage)
void	setAddress(AddressResponse address)
void	setBloodGroup(String bloodGroup)
void	setBodyHeight(String bodyHeight)
void	setBodyWeight(String bodyWeight)
void	setCardNumberLastFourDigits(String cardNumberLastFourDigits)
void	setCitizenship(String citizenship)
void	setControlNumber(String controlNumber)
void	setCpf(String cpf)
void	setCurp(String curp)
void	setCurrentAge(String currentAge)
void	setCustomExtractionPoints(Map<String,Object> customExtractionPoints)
void	setDateOfBirth(LocalDate dateOfBirth)
void	setDateOfBirthParts(DateParts dateOfBirthParts)
void	setDisabilities(String disabilities)
void	setDlCategories(List<DrivingLicenseCategory> dlCategories)
void	setDlEndorsements(String dlEndorsements)
void	setDlRestrictions(List<DlRestriction> dlRestrictions)
void	setDni(String dni)
void	setDocumentCopy(String documentCopy)
void	setDocumentFirstIssuingDate(LocalDate documentFirstIssuingDate)
void	setDocumentIdentificationNumber(String documentIdentificationNumber)
void	setDocumentNumber(String documentNumber)
void	setDocumentType(String documentType)
void	setDueDate(LocalDate dueDate)
void	setDueDateParts(DateParts dueDateParts)
void	setDurationOfStay(String durationOfStay)
void	setEmployer(String employer)
void	setEthnicity(String ethnicity)
void	setExpiryDate(LocalDate expiryDate)
void	setExpiryDateParts(DateParts expiryDateParts)
void	setEyeColor(String eyeColor)
void	setFathersName(String fathersName)
void	setFirstName(String firstName)
void	setGender(String gender)
void	setHairColor(String hairColor)
void	setIssuingAuthority(String issuingAuthority)
void	setIssuingCountry(String issuingCountry)
void	setIssuingDate(LocalDate issuingDate)
void	setIssuingDateParts(DateParts issuingDateParts)
void	setIssuingNumber(String issuingNumber)
void	setIssuingPlace(String issuingPlace)
void	setLaborIdentificationNumber(String laborIdentificationNumber)
void	setLastName(String lastName)
void	setLastNameAtBirth(String lastNameAtBirth)
void	setMaritalStatus(String maritalStatus)
void	setMiddleName(String middleName)
void	setMilitaryNumber(String militaryNumber)
void	setMilitaryStatus(String militaryStatus)
void	setMonthYearExpiry(String monthYearExpiry)
void	setMothersName(String mothersName)
void	setMrz(ExtractionCapabilityResponseDataMrz mrz)
void	setNationality(String nationality)
void	setNumberOfEntries(String numberOfEntries)
void	setOptionalMrzField1(String optionalMrzField1)
void	setOptionalMrzField2(String optionalMrzField2)
void	setPanNumber(String panNumber)
void	setPassportNumber(String passportNumber)
void	setPersonalIdentificationNumber(String personalIdentificationNumber)
void	setPersonalNumber(String personalNumber)
void	setPesel(String pesel)
void	setPetitioner(String petitioner)
void	setPlaceOfBirth(String placeOfBirth)
void	setProfession(String profession)
void	setRegistrationNumber(String registrationNumber)
void	setReligion(String religion)
void	setRemarks(String remarks)
void	setResidentPermitNumber(String residentPermitNumber)
void	setResidentPermitRemarks(String residentPermitRemarks)
void	setResidentPermitType(String residentPermitType)
void	setRgNumber(String rgNumber)
void	setRhesusFactor(String rhesusFactor)
void	setSalutation(String salutation)
void	setSerialNumber(String serialNumber)
void	setSignatureAvailable(Boolean signatureAvailable)
void	setSocialSecurityNumber(String socialSecurityNumber)
void	setState(String state)
void	setSubType(String subType)
void	setSwiftCode(String swiftCode)
void	setTaxNumber(String taxNumber)
void	setType(String type)
void	setVisaCategory(String visaCategory)
void	setVoterIdNumber(String voterIdNumber)
void	setWorkPermitNumber(String workPermitNumber)
ExtractionCapabilityResponseData	signatureAvailable(Boolean signatureAvailable)
ExtractionCapabilityResponseData	socialSecurityNumber(String socialSecurityNumber)
ExtractionCapabilityResponseData	state(String state)
ExtractionCapabilityResponseData	subType(String subType)
ExtractionCapabilityResponseData	swiftCode(String swiftCode)
ExtractionCapabilityResponseData	taxNumber(String taxNumber)
String	toString()
ExtractionCapabilityResponseData	type(String type)
ExtractionCapabilityResponseData	visaCategory(String visaCategory)
ExtractionCapabilityResponseData	voterIdNumber(String voterIdNumber)
ExtractionCapabilityResponseData	workPermitNumber(String workPermitNumber)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

JSON_PROPERTY_TYPE

                          public static final String JSON_PROPERTY_TYPE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_SUB_TYPE

                          public static final String JSON_PROPERTY_SUB_TYPE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_ISSUING_COUNTRY

                          public static final String JSON_PROPERTY_ISSUING_COUNTRY
                        

See Also:

• Constant Field Values

JSON_PROPERTY_FIRST_NAME

                          public static final String JSON_PROPERTY_FIRST_NAME
                        

See Also:

• Constant Field Values

JSON_PROPERTY_LAST_NAME

                          public static final String JSON_PROPERTY_LAST_NAME
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DATE_OF_BIRTH

                          public static final String JSON_PROPERTY_DATE_OF_BIRTH
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DATE_OF_BIRTH_PARTS

                          public static final String JSON_PROPERTY_DATE_OF_BIRTH_PARTS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_EXPIRY_DATE

                          public static final String JSON_PROPERTY_EXPIRY_DATE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_EXPIRY_DATE_PARTS

                          public static final String JSON_PROPERTY_EXPIRY_DATE_PARTS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_ISSUING_DATE

                          public static final String JSON_PROPERTY_ISSUING_DATE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_ISSUING_DATE_PARTS

                          public static final String JSON_PROPERTY_ISSUING_DATE_PARTS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DUE_DATE

                          public static final String JSON_PROPERTY_DUE_DATE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DUE_DATE_PARTS

                          public static final String JSON_PROPERTY_DUE_DATE_PARTS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_ACCOUNT_NUMBER

                          public static final String JSON_PROPERTY_ACCOUNT_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_SWIFT_CODE

                          public static final String JSON_PROPERTY_SWIFT_CODE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DOCUMENT_TYPE

                          public static final String JSON_PROPERTY_DOCUMENT_TYPE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DOCUMENT_NUMBER

                          public static final String JSON_PROPERTY_DOCUMENT_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_SOCIAL_SECURITY_NUMBER

                          public static final String JSON_PROPERTY_SOCIAL_SECURITY_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_SIGNATURE_AVAILABLE

                          public static final String JSON_PROPERTY_SIGNATURE_AVAILABLE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_STATE

                          public static final String JSON_PROPERTY_STATE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_PERSONAL_NUMBER

                          public static final String JSON_PROPERTY_PERSONAL_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_OPTIONAL_MRZ_FIELD1

                          public static final String JSON_PROPERTY_OPTIONAL_MRZ_FIELD1
                        

See Also:

• Constant Field Values

JSON_PROPERTY_OPTIONAL_MRZ_FIELD2

                          public static final String JSON_PROPERTY_OPTIONAL_MRZ_FIELD2
                        

See Also:

• Constant Field Values

JSON_PROPERTY_ADDRESS

                          public static final String JSON_PROPERTY_ADDRESS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_ISSUING_AUTHORITY

                          public static final String JSON_PROPERTY_ISSUING_AUTHORITY
                        

See Also:

• Constant Field Values

JSON_PROPERTY_ISSUING_PLACE

                          public static final String JSON_PROPERTY_ISSUING_PLACE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_CURP

                          public static final String JSON_PROPERTY_CURP
                        

See Also:

• Constant Field Values

JSON_PROPERTY_GENDER

                          public static final String JSON_PROPERTY_GENDER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_NATIONALITY

                          public static final String JSON_PROPERTY_NATIONALITY
                        

See Also:

• Constant Field Values

JSON_PROPERTY_PLACE_OF_BIRTH

                          public static final String JSON_PROPERTY_PLACE_OF_BIRTH
                        

See Also:

• Constant Field Values

JSON_PROPERTY_TAX_NUMBER

                          public static final String JSON_PROPERTY_TAX_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_CPF

                          public static final String JSON_PROPERTY_CPF
                        

See Also:

• Constant Field Values

JSON_PROPERTY_REGISTRATION_NUMBER

                          public static final String JSON_PROPERTY_REGISTRATION_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_MOTHERS_NAME

                          public static final String JSON_PROPERTY_MOTHERS_NAME
                        

See Also:

• Constant Field Values

JSON_PROPERTY_FATHERS_NAME

                          public static final String JSON_PROPERTY_FATHERS_NAME
                        

See Also:

• Constant Field Values

JSON_PROPERTY_PERSONAL_IDENTIFICATION_NUMBER

                          public static final String JSON_PROPERTY_PERSONAL_IDENTIFICATION_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_RG_NUMBER

                          public static final String JSON_PROPERTY_RG_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DL_CATEGORIES

                          public static final String JSON_PROPERTY_DL_CATEGORIES
                        

See Also:

• Constant Field Values

JSON_PROPERTY_VOTER_ID_NUMBER

                          public static final String JSON_PROPERTY_VOTER_ID_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_ISSUING_NUMBER

                          public static final String JSON_PROPERTY_ISSUING_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_PASSPORT_NUMBER

                          public static final String JSON_PROPERTY_PASSPORT_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DURATION_OF_STAY

                          public static final String JSON_PROPERTY_DURATION_OF_STAY
                        

See Also:

• Constant Field Values

JSON_PROPERTY_NUMBER_OF_ENTRIES

                          public static final String JSON_PROPERTY_NUMBER_OF_ENTRIES
                        

See Also:

• Constant Field Values

JSON_PROPERTY_VISA_CATEGORY

                          public static final String JSON_PROPERTY_VISA_CATEGORY
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DNI

                          public static final String JSON_PROPERTY_DNI
                        

See Also:

• Constant Field Values

JSON_PROPERTY_PESEL

                          public static final String JSON_PROPERTY_PESEL
                        

See Also:

• Constant Field Values

JSON_PROPERTY_RESIDENT_PERMIT_TYPE

                          public static final String JSON_PROPERTY_RESIDENT_PERMIT_TYPE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_RESIDENT_PERMIT_REMARKS

                          public static final String JSON_PROPERTY_RESIDENT_PERMIT_REMARKS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_PROFESSION

                          public static final String JSON_PROPERTY_PROFESSION
                        

See Also:

• Constant Field Values

JSON_PROPERTY_CITIZENSHIP

                          public static final String JSON_PROPERTY_CITIZENSHIP
                        

See Also:

• Constant Field Values

JSON_PROPERTY_MARITAL_STATUS

                          public static final String JSON_PROPERTY_MARITAL_STATUS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_RELIGION

                          public static final String JSON_PROPERTY_RELIGION
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DOCUMENT_IDENTIFICATION_NUMBER

                          public static final String JSON_PROPERTY_DOCUMENT_IDENTIFICATION_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_WORK_PERMIT_NUMBER

                          public static final String JSON_PROPERTY_WORK_PERMIT_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_LABOR_IDENTIFICATION_NUMBER

                          public static final String JSON_PROPERTY_LABOR_IDENTIFICATION_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DOCUMENT_COPY

                          public static final String JSON_PROPERTY_DOCUMENT_COPY
                        

See Also:

• Constant Field Values

JSON_PROPERTY_LAST_NAME_AT_BIRTH

                          public static final String JSON_PROPERTY_LAST_NAME_AT_BIRTH
                        

See Also:

• Constant Field Values

JSON_PROPERTY_REMARKS

                          public static final String JSON_PROPERTY_REMARKS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DISABILITIES

                          public static final String JSON_PROPERTY_DISABILITIES
                        

See Also:

• Constant Field Values

JSON_PROPERTY_EMPLOYER

                          public static final String JSON_PROPERTY_EMPLOYER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_MILITARY_NUMBER

                          public static final String JSON_PROPERTY_MILITARY_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_MILITARY_STATUS

                          public static final String JSON_PROPERTY_MILITARY_STATUS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_MIDDLE_NAME

                          public static final String JSON_PROPERTY_MIDDLE_NAME
                        

See Also:

• Constant Field Values

JSON_PROPERTY_SALUTATION

                          public static final String JSON_PROPERTY_SALUTATION
                        

See Also:

• Constant Field Values

JSON_PROPERTY_ACADEMIC_DEGREE

                          public static final String JSON_PROPERTY_ACADEMIC_DEGREE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_EYE_COLOR

                          public static final String JSON_PROPERTY_EYE_COLOR
                        

See Also:

• Constant Field Values

JSON_PROPERTY_HAIR_COLOR

                          public static final String JSON_PROPERTY_HAIR_COLOR
                        

See Also:

• Constant Field Values

JSON_PROPERTY_BODY_HEIGHT

                          public static final String JSON_PROPERTY_BODY_HEIGHT
                        

See Also:

• Constant Field Values

JSON_PROPERTY_BODY_WEIGHT

                          public static final String JSON_PROPERTY_BODY_WEIGHT
                        

See Also:

• Constant Field Values

JSON_PROPERTY_ETHNICITY

                          public static final String JSON_PROPERTY_ETHNICITY
                        

See Also:

• Constant Field Values

JSON_PROPERTY_BLOOD_GROUP

                          public static final String JSON_PROPERTY_BLOOD_GROUP
                        

See Also:

• Constant Field Values

JSON_PROPERTY_RHESUS_FACTOR

                          public static final String JSON_PROPERTY_RHESUS_FACTOR
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DL_RESTRICTIONS

                          public static final String JSON_PROPERTY_DL_RESTRICTIONS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DL_ENDORSEMENTS

                          public static final String JSON_PROPERTY_DL_ENDORSEMENTS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_RESIDENT_PERMIT_NUMBER

                          public static final String JSON_PROPERTY_RESIDENT_PERMIT_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_CONTROL_NUMBER

                          public static final String JSON_PROPERTY_CONTROL_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_PETITIONER

                          public static final String JSON_PROPERTY_PETITIONER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_SERIAL_NUMBER

                          public static final String JSON_PROPERTY_SERIAL_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_DOCUMENT_FIRST_ISSUING_DATE

                          public static final String JSON_PROPERTY_DOCUMENT_FIRST_ISSUING_DATE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_PAN_NUMBER

                          public static final String JSON_PROPERTY_PAN_NUMBER
                        

See Also:

• Constant Field Values

JSON_PROPERTY_MONTH_YEAR_EXPIRY

                          public static final String JSON_PROPERTY_MONTH_YEAR_EXPIRY
                        

See Also:

• Constant Field Values

JSON_PROPERTY_CARD_NUMBER_LAST_FOUR_DIGITS

                          public static final String JSON_PROPERTY_CARD_NUMBER_LAST_FOUR_DIGITS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_CUSTOM_EXTRACTION_POINTS

                          public static final String JSON_PROPERTY_CUSTOM_EXTRACTION_POINTS
                        

See Also:

• Constant Field Values

JSON_PROPERTY_CURRENT_AGE

                          public static final String JSON_PROPERTY_CURRENT_AGE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_ADDITIONAL_LANGUAGE

                          public static final String JSON_PROPERTY_ADDITIONAL_LANGUAGE
                        

See Also:

• Constant Field Values

JSON_PROPERTY_MRZ

                          public static final String JSON_PROPERTY_MRZ
                        

See Also:

• Constant Field Values

Constructor Details

ExtractionCapabilityResponseData

                          public ExtractionCapabilityResponseData()
                        

Method Details

type

                          public ExtractionCapabilityResponseData type(String type)
                        

getType

                          @Nullable public String getType()
                        

Get type

Returns:

type

setType

                          public void setType(String type)
                        

subType

                          public ExtractionCapabilityResponseData subType(String subType)
                        

getSubType

                          @Nullable public String getSubType()
                        

Get subType

Returns:

subType

setSubType

                          public void setSubType(String subType)
                        

issuingCountry

                          public ExtractionCapabilityResponseData issuingCountry(String issuingCountry)
                        

getIssuingCountry

                          @Nullable public String getIssuingCountry()
                        

The country this document was issued. Can be any ISO 3166-1 alpha-3 country code, and XKX for Kosovo

Returns:

issuingCountry

setIssuingCountry

                          public void setIssuingCountry(String issuingCountry)
                        

firstName

                          public ExtractionCapabilityResponseData firstName(String firstName)
                        

getFirstName

                          @Nullable public String getFirstName()
                        

Get firstName

Returns:

firstName

setFirstName

                          public void setFirstName(String firstName)
                        

lastName

                          public ExtractionCapabilityResponseData lastName(String lastName)
                        

getLastName

                          @Nullable public String getLastName()
                        

Get lastName

Returns:

lastName

setLastName

                          public void setLastName(String lastName)
                        

dateOfBirth

                          public ExtractionCapabilityResponseData dateOfBirth(LocalDate dateOfBirth)
                        

getDateOfBirth

                          @Nullable public LocalDate getDateOfBirth()
                        

Get dateOfBirth

Returns:

dateOfBirth

setDateOfBirth

                          public void setDateOfBirth(LocalDate dateOfBirth)
                        

dateOfBirthParts

                          public ExtractionCapabilityResponseData dateOfBirthParts(DateParts dateOfBirthParts)
                        

getDateOfBirthParts

                          @Nullable public DateParts getDateOfBirthParts()
                        

Get dateOfBirthParts

Returns:

dateOfBirthParts

setDateOfBirthParts

                          public void setDateOfBirthParts(DateParts dateOfBirthParts)
                        

expiryDate

                          public ExtractionCapabilityResponseData expiryDate(LocalDate expiryDate)
                        

getExpiryDate

                          @Nullable public LocalDate getExpiryDate()
                        

Get expiryDate

Returns:

expiryDate

setExpiryDate

                          public void setExpiryDate(LocalDate expiryDate)
                        

expiryDateParts

                          public ExtractionCapabilityResponseData expiryDateParts(DateParts expiryDateParts)
                        

getExpiryDateParts

                          @Nullable public DateParts getExpiryDateParts()
                        

Get expiryDateParts

Returns:

expiryDateParts

setExpiryDateParts

                          public void setExpiryDateParts(DateParts expiryDateParts)
                        

issuingDate

                          public ExtractionCapabilityResponseData issuingDate(LocalDate issuingDate)
                        

getIssuingDate

                          @Nullable public LocalDate getIssuingDate()
                        

Get issuingDate

Returns:

issuingDate

setIssuingDate

                          public void setIssuingDate(LocalDate issuingDate)
                        

issuingDateParts

                          public ExtractionCapabilityResponseData issuingDateParts(DateParts issuingDateParts)
                        

getIssuingDateParts

                          @Nullable public DateParts getIssuingDateParts()
                        

Get issuingDateParts

Returns:

issuingDateParts

setIssuingDateParts

                          public void setIssuingDateParts(DateParts issuingDateParts)
                        

dueDate

                          public ExtractionCapabilityResponseData dueDate(LocalDate dueDate)
                        

getDueDate

                          @Nullable public LocalDate getDueDate()
                        

Get dueDate

Returns:

dueDate

setDueDate

                          public void setDueDate(LocalDate dueDate)
                        

dueDateParts

                          public ExtractionCapabilityResponseData dueDateParts(DateParts dueDateParts)
                        

getDueDateParts

                          @Nullable public DateParts getDueDateParts()
                        

Get dueDateParts

Returns:

dueDateParts

setDueDateParts

                          public void setDueDateParts(DateParts dueDateParts)
                        

accountNumber

                          public ExtractionCapabilityResponseData accountNumber(String accountNumber)
                        

getAccountNumber

                          @Nullable public String getAccountNumber()
                        

Get accountNumber

Returns:

accountNumber

setAccountNumber

                          public void setAccountNumber(String accountNumber)
                        

swiftCode

                          public ExtractionCapabilityResponseData swiftCode(String swiftCode)
                        

getSwiftCode

                          @Nullable public String getSwiftCode()
                        

Get swiftCode

Returns:

swiftCode

setSwiftCode

                          public void setSwiftCode(String swiftCode)
                        

documentType

                          public ExtractionCapabilityResponseData documentType(String documentType)
                        

getDocumentType

                          @Nullable public String getDocumentType()
                        

Get documentType

Returns:

documentType

setDocumentType

                          public void setDocumentType(String documentType)
                        

documentNumber

                          public ExtractionCapabilityResponseData documentNumber(String documentNumber)
                        

getDocumentNumber

                          @Nullable public String getDocumentNumber()
                        

Get documentNumber

Returns:

documentNumber

setDocumentNumber

                          public void setDocumentNumber(String documentNumber)
                        

socialSecurityNumber

                          public ExtractionCapabilityResponseData socialSecurityNumber(String socialSecurityNumber)
                        

getSocialSecurityNumber

                          @Nullable public String getSocialSecurityNumber()
                        

represents the SSN for USA

Returns:

socialSecurityNumber

setSocialSecurityNumber

                          public void setSocialSecurityNumber(String socialSecurityNumber)
                        

signatureAvailable

                          public ExtractionCapabilityResponseData signatureAvailable(Boolean signatureAvailable)
                        

getSignatureAvailable

                          @Nullable public Boolean getSignatureAvailable()
                        

whether signature is available on SSN or not (only applies to SSN in USA)

Returns:

signatureAvailable

setSignatureAvailable

                          public void setSignatureAvailable(Boolean signatureAvailable)
                        

state

                          public ExtractionCapabilityResponseData state(String state)
                        

getState

                          @Nullable public String getState()
                        

Possible values: - Last two characters of ISO 3166-2:US state code - Last 2-3 characters of ISO 3166-2:AU state code - Last two characters of ISO 3166-2:CA state code - ISO 3166-1 country name - XKX (Kosovo) - Free text if it can't be mapped to a state/country code

Returns:

state

setState

                          public void setState(String state)
                        

personalNumber

                          public ExtractionCapabilityResponseData personalNumber(String personalNumber)
                        

getPersonalNumber

                          @Nullable public String getPersonalNumber()
                        

Get personalNumber

Returns:

personalNumber

setPersonalNumber

                          public void setPersonalNumber(String personalNumber)
                        

optionalMrzField1

                          public ExtractionCapabilityResponseData optionalMrzField1(String optionalMrzField1)
                        

getOptionalMrzField1

                          @Nullable public String getOptionalMrzField1()
                        

Optional field of MRZ line 1

Returns:

optionalMrzField1

setOptionalMrzField1

                          public void setOptionalMrzField1(String optionalMrzField1)
                        

optionalMrzField2

                          public ExtractionCapabilityResponseData optionalMrzField2(String optionalMrzField2)
                        

getOptionalMrzField2

                          @Nullable public String getOptionalMrzField2()
                        

Optional field of MRZ line 2

Returns:

optionalMrzField2

setOptionalMrzField2

                          public void setOptionalMrzField2(String optionalMrzField2)
                        

address

                          public ExtractionCapabilityResponseData address(AddressResponse address)
                        

getAddress

                          @Nullable public AddressResponse getAddress()
                        

Get address

Returns:

address

setAddress

                          public void setAddress(AddressResponse address)
                        

issuingAuthority

                          public ExtractionCapabilityResponseData issuingAuthority(String issuingAuthority)
                        

getIssuingAuthority

                          @Nullable public String getIssuingAuthority()
                        

Issuing authority of the document

Returns:

issuingAuthority

setIssuingAuthority

                          public void setIssuingAuthority(String issuingAuthority)
                        

issuingPlace

                          public ExtractionCapabilityResponseData issuingPlace(String issuingPlace)
                        

getIssuingPlace

                          @Nullable public String getIssuingPlace()
                        

Issuing place of the document

Returns:

issuingPlace

setIssuingPlace

                          public void setIssuingPlace(String issuingPlace)
                        

curp

                          public ExtractionCapabilityResponseData curp(String curp)
                        

getCurp

                          @Nullable public String getCurp()
                        

The CURP for mexican documents

Returns:

curp

setCurp

                          public void setCurp(String curp)
                        

gender

                          public ExtractionCapabilityResponseData gender(String gender)
                        

getGender

                          @Nullable public String getGender()
                        

- M - F - X

Returns:

gender

setGender

                          public void setGender(String gender)
                        

nationality

                          public ExtractionCapabilityResponseData nationality(String nationality)
                        

getNationality

                          @Nullable public String getNationality()
                        

Nationality of the document holder in ISO 3166-1 alpha-3 country code or country specific non ISO nationalities (3 letters)

Returns:

nationality

setNationality

                          public void setNationality(String nationality)
                        

placeOfBirth

                          public ExtractionCapabilityResponseData placeOfBirth(String placeOfBirth)
                        

getPlaceOfBirth

                          @Nullable public String getPlaceOfBirth()
                        

Get placeOfBirth

Returns:

placeOfBirth

setPlaceOfBirth

                          public void setPlaceOfBirth(String placeOfBirth)
                        

taxNumber

                          public ExtractionCapabilityResponseData taxNumber(String taxNumber)
                        

getTaxNumber

                          @Nullable public String getTaxNumber()
                        

Tax number of the document in case the country is ITA and type is HEALTH_ID or TAX_ID

Returns:

taxNumber

setTaxNumber

                          public void setTaxNumber(String taxNumber)
                        

cpf

                          public ExtractionCapabilityResponseData cpf(String cpf)
                        

getCpf

                          @Nullable public String getCpf()
                        

Get cpf

Returns:

cpf

setCpf

                          public void setCpf(String cpf)
                        

registrationNumber

                          public ExtractionCapabilityResponseData registrationNumber(String registrationNumber)
                        

getRegistrationNumber

                          @Nullable public String getRegistrationNumber()
                        

Get registrationNumber

Returns:

registrationNumber

setRegistrationNumber

                          public void setRegistrationNumber(String registrationNumber)
                        

mothersName

                          public ExtractionCapabilityResponseData mothersName(String mothersName)
                        

getMothersName

                          @Nullable public String getMothersName()
                        

Get mothersName

Returns:

mothersName

setMothersName

                          public void setMothersName(String mothersName)
                        

fathersName

                          public ExtractionCapabilityResponseData fathersName(String fathersName)
                        

getFathersName

                          @Nullable public String getFathersName()
                        

Get fathersName

Returns:

fathersName

setFathersName

                          public void setFathersName(String fathersName)
                        

personalIdentificationNumber

                          public ExtractionCapabilityResponseData personalIdentificationNumber(String personalIdentificationNumber)
                        

getPersonalIdentificationNumber

                          @Nullable public String getPersonalIdentificationNumber()
                        

Get personalIdentificationNumber

Returns:

personalIdentificationNumber

setPersonalIdentificationNumber

                          public void setPersonalIdentificationNumber(String personalIdentificationNumber)
                        

rgNumber

                          public ExtractionCapabilityResponseData rgNumber(String rgNumber)
                        

getRgNumber

                          @Nullable public String getRgNumber()
                        

Get rgNumber

Returns:

rgNumber

setRgNumber

                          public void setRgNumber(String rgNumber)
                        

dlCategories

                          public ExtractionCapabilityResponseData dlCategories(List<DrivingLicenseCategory> dlCategories)
                        

addDlCategoriesItem

                          public ExtractionCapabilityResponseData addDlCategoriesItem(DrivingLicenseCategory dlCategoriesItem)
                        

getDlCategories

                          @Nullable public List<DrivingLicenseCategory> getDlCategories()
                        

Get dlCategories

Returns:

dlCategories

setDlCategories

                          public void setDlCategories(List<DrivingLicenseCategory> dlCategories)
                        

voterIdNumber

                          public ExtractionCapabilityResponseData voterIdNumber(String voterIdNumber)
                        

getVoterIdNumber

                          @Nullable public String getVoterIdNumber()
                        

\\\"Clave de elector\\\" number for idCountry = MEX (if extraction is enabled)

Returns:

voterIdNumber

setVoterIdNumber

                          public void setVoterIdNumber(String voterIdNumber)
                        

issuingNumber

                          public ExtractionCapabilityResponseData issuingNumber(String issuingNumber)
                        

getIssuingNumber

                          @Nullable public String getIssuingNumber()
                        

\\\"Numero de emission\\\" number for idCountry = MEX (if extraction is enabled)

Returns:

issuingNumber

setIssuingNumber

                          public void setIssuingNumber(String issuingNumber)
                        

passportNumber

                          public ExtractionCapabilityResponseData passportNumber(String passportNumber)
                        

getPassportNumber

                          @Nullable public String getPassportNumber()
                        

Passport number either for documents with VISA idType or passport number on non-VISA documents (if passport number extraction of non-VISA documents is enabled)

Returns:

passportNumber

setPassportNumber

                          public void setPassportNumber(String passportNumber)
                        

durationOfStay

                          public ExtractionCapabilityResponseData durationOfStay(String durationOfStay)
                        

getDurationOfStay

                          @Nullable public String getDurationOfStay()
                        

Duration of stay if idType = VISA and additional extraction for Visa enabled

Returns:

durationOfStay

setDurationOfStay

                          public void setDurationOfStay(String durationOfStay)
                        

numberOfEntries

                          public ExtractionCapabilityResponseData numberOfEntries(String numberOfEntries)
                        

getNumberOfEntries

                          @Nullable public String getNumberOfEntries()
                        

Number of entries if idType = VISA and additional extraction for Visa enabled

Returns:

numberOfEntries

setNumberOfEntries

                          public void setNumberOfEntries(String numberOfEntries)
                        

visaCategory

                          public ExtractionCapabilityResponseData visaCategory(String visaCategory)
                        

getVisaCategory

                          @Nullable public String getVisaCategory()
                        

Visa category if idType = VISA and additional extraction for Visa enabled

Returns:

visaCategory

setVisaCategory

                          public void setVisaCategory(String visaCategory)
                        

dni

                          public ExtractionCapabilityResponseData dni(String dni)
                        

getDni

                          @Nullable public String getDni()
                        

DNI as available on the ID if idCountry = ESP and idSubtype = NATIONAL_ID

Returns:

dni

setDni

                          public void setDni(String dni)
                        

pesel

                          public ExtractionCapabilityResponseData pesel(String pesel)
                        

getPesel

                          @Nullable public String getPesel()
                        

Get pesel

Returns:

pesel

setPesel

                          public void setPesel(String pesel)
                        

residentPermitType

                          public ExtractionCapabilityResponseData residentPermitType(String residentPermitType)
                        

getResidentPermitType

                          @Nullable public String getResidentPermitType()
                        

Permit type related to \"Golden Visas\" (if extraction is enabled)

Returns:

residentPermitType

setResidentPermitType

                          public void setResidentPermitType(String residentPermitType)
                        

residentPermitRemarks

                          public ExtractionCapabilityResponseData residentPermitRemarks(String residentPermitRemarks)
                        

getResidentPermitRemarks

                          @Nullable public String getResidentPermitRemarks()
                        

Permit remarks related to \"Golden Visas\" (if extraction is enabled)

Returns:

residentPermitRemarks

setResidentPermitRemarks

                          public void setResidentPermitRemarks(String residentPermitRemarks)
                        

profession

                          public ExtractionCapabilityResponseData profession(String profession)
                        

getProfession

                          @Nullable public String getProfession()
                        

Profession (if extraction is enabled)

Returns:

profession

setProfession

                          public void setProfession(String profession)
                        

citizenship

                          public ExtractionCapabilityResponseData citizenship(String citizenship)
                        

getCitizenship

                          @Nullable public String getCitizenship()
                        

Citizenship (if extraction is enabled)

Returns:

citizenship

setCitizenship

                          public void setCitizenship(String citizenship)
                        

maritalStatus

                          public ExtractionCapabilityResponseData maritalStatus(String maritalStatus)
                        

getMaritalStatus

                          @Nullable public String getMaritalStatus()
                        

Marital status (if extraction is enabled)

Returns:

maritalStatus

setMaritalStatus

                          public void setMaritalStatus(String maritalStatus)
                        

religion

                          public ExtractionCapabilityResponseData religion(String religion)
                        

getReligion

                          @Nullable public String getReligion()
                        

Religion (if extraction is enabled)

Returns:

religion

setReligion

                          public void setReligion(String religion)
                        

documentIdentificationNumber

                          public ExtractionCapabilityResponseData documentIdentificationNumber(String documentIdentificationNumber)
                        

getDocumentIdentificationNumber

                          @Nullable public String getDocumentIdentificationNumber()
                        

Document identification number (if extraction is enabled)

Returns:

documentIdentificationNumber

setDocumentIdentificationNumber

                          public void setDocumentIdentificationNumber(String documentIdentificationNumber)
                        

workPermitNumber

                          public ExtractionCapabilityResponseData workPermitNumber(String workPermitNumber)
                        

getWorkPermitNumber

                          @Nullable public String getWorkPermitNumber()
                        

Work permit number (if extraction is enabled)

Returns:

workPermitNumber

setWorkPermitNumber

                          public void setWorkPermitNumber(String workPermitNumber)
                        

laborIdentificationNumber

                          public ExtractionCapabilityResponseData laborIdentificationNumber(String laborIdentificationNumber)
                        

getLaborIdentificationNumber

                          @Nullable public String getLaborIdentificationNumber()
                        

Labor identification number (if extraction is enabled)

Returns:

laborIdentificationNumber

setLaborIdentificationNumber

                          public void setLaborIdentificationNumber(String laborIdentificationNumber)
                        

documentCopy

                          public ExtractionCapabilityResponseData documentCopy(String documentCopy)
                        

getDocumentCopy

                          @Nullable public String getDocumentCopy()
                        

Document copy (if extraction is enabled)

Returns:

documentCopy

setDocumentCopy

                          public void setDocumentCopy(String documentCopy)
                        

lastNameAtBirth

                          public ExtractionCapabilityResponseData lastNameAtBirth(String lastNameAtBirth)
                        

getLastNameAtBirth

                          @Nullable public String getLastNameAtBirth()
                        

Last name at birth (if extraction is enabled)

Returns:

lastNameAtBirth

setLastNameAtBirth

                          public void setLastNameAtBirth(String lastNameAtBirth)
                        

remarks

                          public ExtractionCapabilityResponseData remarks(String remarks)
                        

getRemarks

                          @Nullable public String getRemarks()
                        

Remarks (if extraction is enabled)

Returns:

remarks

setRemarks

                          public void setRemarks(String remarks)
                        

disabilities

                          public ExtractionCapabilityResponseData disabilities(String disabilities)
                        

getDisabilities

                          @Nullable public String getDisabilities()
                        

Disabilities (if extraction is enabled)

Returns:

disabilities

setDisabilities

                          public void setDisabilities(String disabilities)
                        

employer

                          public ExtractionCapabilityResponseData employer(String employer)
                        

getEmployer

                          @Nullable public String getEmployer()
                        

Employer (if extraction is enabled)

Returns:

employer

setEmployer

                          public void setEmployer(String employer)
                        

militaryNumber

                          public ExtractionCapabilityResponseData militaryNumber(String militaryNumber)
                        

getMilitaryNumber

                          @Nullable public String getMilitaryNumber()
                        

Military number (if extraction is enabled)

Returns:

militaryNumber

setMilitaryNumber

                          public void setMilitaryNumber(String militaryNumber)
                        

militaryStatus

                          public ExtractionCapabilityResponseData militaryStatus(String militaryStatus)
                        

getMilitaryStatus

                          @Nullable public String getMilitaryStatus()
                        

Military status (if extraction is enabled)

Returns:

militaryStatus

setMilitaryStatus

                          public void setMilitaryStatus(String militaryStatus)
                        

middleName

                          public ExtractionCapabilityResponseData middleName(String middleName)
                        

getMiddleName

                          @Nullable public String getMiddleName()
                        

Middle name (if extraction is enabled)

Returns:

middleName

setMiddleName

                          public void setMiddleName(String middleName)
                        

salutation

                          public ExtractionCapabilityResponseData salutation(String salutation)
                        

getSalutation

                          @Nullable public String getSalutation()
                        

Salutation (if extraction is enabled)

Returns:

salutation

setSalutation

                          public void setSalutation(String salutation)
                        

academicDegree

                          public ExtractionCapabilityResponseData academicDegree(String academicDegree)
                        

getAcademicDegree

                          @Nullable public String getAcademicDegree()
                        

Academic degree (if extraction is enabled)

Returns:

academicDegree

setAcademicDegree

                          public void setAcademicDegree(String academicDegree)
                        

eyeColor

                          public ExtractionCapabilityResponseData eyeColor(String eyeColor)
                        

getEyeColor

                          @Nullable public String getEyeColor()
                        

Eye color (if extraction is enabled)

Returns:

eyeColor

setEyeColor

                          public void setEyeColor(String eyeColor)
                        

hairColor

                          public ExtractionCapabilityResponseData hairColor(String hairColor)
                        

getHairColor

                          @Nullable public String getHairColor()
                        

Hair color (if extraction is enabled)

Returns:

hairColor

setHairColor

                          public void setHairColor(String hairColor)
                        

bodyHeight

                          public ExtractionCapabilityResponseData bodyHeight(String bodyHeight)
                        

getBodyHeight

                          @Nullable public String getBodyHeight()
                        

Body height (if extraction is enabled)

Returns:

bodyHeight

setBodyHeight

                          public void setBodyHeight(String bodyHeight)
                        

bodyWeight

                          public ExtractionCapabilityResponseData bodyWeight(String bodyWeight)
                        

getBodyWeight

                          @Nullable public String getBodyWeight()
                        

Body weight (if extraction is enabled)

Returns:

bodyWeight

setBodyWeight

                          public void setBodyWeight(String bodyWeight)
                        

ethnicity

                          public ExtractionCapabilityResponseData ethnicity(String ethnicity)
                        

getEthnicity

                          @Nullable public String getEthnicity()
                        

Ethnicity (if extraction is enabled)

Returns:

ethnicity

setEthnicity

                          public void setEthnicity(String ethnicity)
                        

bloodGroup

                          public ExtractionCapabilityResponseData bloodGroup(String bloodGroup)
                        

getBloodGroup

                          @Nullable public String getBloodGroup()
                        

Blood group (if extraction is enabled)

Returns:

bloodGroup

setBloodGroup

                          public void setBloodGroup(String bloodGroup)
                        

rhesusFactor

                          public ExtractionCapabilityResponseData rhesusFactor(String rhesusFactor)
                        

getRhesusFactor

                          @Nullable public String getRhesusFactor()
                        

Rhesus factor (if extraction is enabled)

Returns:

rhesusFactor

setRhesusFactor

                          public void setRhesusFactor(String rhesusFactor)
                        

dlRestrictions

                          public ExtractionCapabilityResponseData dlRestrictions(List<DlRestriction> dlRestrictions)
                        

addDlRestrictionsItem

                          public ExtractionCapabilityResponseData addDlRestrictionsItem(DlRestriction dlRestrictionsItem)
                        

getDlRestrictions

                          @Nullable public List<DlRestriction> getDlRestrictions()
                        

Get dlRestrictions

Returns:

dlRestrictions

setDlRestrictions

                          public void setDlRestrictions(List<DlRestriction> dlRestrictions)
                        

dlEndorsements

                          public ExtractionCapabilityResponseData dlEndorsements(String dlEndorsements)
                        

getDlEndorsements

                          @Nullable public String getDlEndorsements()
                        

Driving license endorsements (if extraction is enabled)

Returns:

dlEndorsements

setDlEndorsements

                          public void setDlEndorsements(String dlEndorsements)
                        

residentPermitNumber

                          public ExtractionCapabilityResponseData residentPermitNumber(String residentPermitNumber)
                        

getResidentPermitNumber

                          @Nullable public String getResidentPermitNumber()
                        

Resident permit number (if extraction is enabled)

Returns:

residentPermitNumber

setResidentPermitNumber

                          public void setResidentPermitNumber(String residentPermitNumber)
                        

controlNumber

                          public ExtractionCapabilityResponseData controlNumber(String controlNumber)
                        

getControlNumber

                          @Nullable public String getControlNumber()
                        

Control number (if extraction is enabled)

Returns:

controlNumber

setControlNumber

                          public void setControlNumber(String controlNumber)
                        

petitioner

                          public ExtractionCapabilityResponseData petitioner(String petitioner)
                        

getPetitioner

                          @Nullable public String getPetitioner()
                        

Petitioner (if extraction is enabled)

Returns:

petitioner

setPetitioner

                          public void setPetitioner(String petitioner)
                        

serialNumber

                          public ExtractionCapabilityResponseData serialNumber(String serialNumber)
                        

getSerialNumber

                          @Nullable public String getSerialNumber()
                        

Serial number (if extraction is enabled)

Returns:

serialNumber

setSerialNumber

                          public void setSerialNumber(String serialNumber)
                        

documentFirstIssuingDate

                          public ExtractionCapabilityResponseData documentFirstIssuingDate(LocalDate documentFirstIssuingDate)
                        

getDocumentFirstIssuingDate

                          @Nullable public LocalDate getDocumentFirstIssuingDate()
                        

Document First Issuing Date (if extraction is enabled)

Returns:

documentFirstIssuingDate

setDocumentFirstIssuingDate

                          public void setDocumentFirstIssuingDate(LocalDate documentFirstIssuingDate)
                        

panNumber

                          public ExtractionCapabilityResponseData panNumber(String panNumber)
                        

getPanNumber

                          @Nullable public String getPanNumber()
                        

PAN number in case of CC document type (Can be masked as well)

Returns:

panNumber

setPanNumber

                          public void setPanNumber(String panNumber)
                        

monthYearExpiry

                          public ExtractionCapabilityResponseData monthYearExpiry(String monthYearExpiry)
                        

getMonthYearExpiry

                          @Nullable public String getMonthYearExpiry()
                        

contains credit card's expiry date in format MM/YY

Returns:

monthYearExpiry

setMonthYearExpiry

                          public void setMonthYearExpiry(String monthYearExpiry)
                        

cardNumberLastFourDigits

                          public ExtractionCapabilityResponseData cardNumberLastFourDigits(String cardNumberLastFourDigits)
                        

getCardNumberLastFourDigits

                          @Nullable public String getCardNumberLastFourDigits()
                        

contains last 4 digits of credit card number for CCS document type

Returns:

cardNumberLastFourDigits

setCardNumberLastFourDigits

                          public void setCardNumberLastFourDigits(String cardNumberLastFourDigits)
                        

customExtractionPoints

                          public ExtractionCapabilityResponseData customExtractionPoints(Map<String,Object> customExtractionPoints)
                        

putCustomExtractionPointsItem

                          public ExtractionCapabilityResponseData putCustomExtractionPointsItem(String key,
                            Object customExtractionPointsItem)
                        

getCustomExtractionPoints

                          @Nullable public Map<String,Object> getCustomExtractionPoints()
                        

Get customExtractionPoints

Returns:

customExtractionPoints

setCustomExtractionPoints

                          public void setCustomExtractionPoints(Map<String,Object> customExtractionPoints)
                        

currentAge

                          public ExtractionCapabilityResponseData currentAge(String currentAge)
                        

getCurrentAge

                          @Nullable public String getCurrentAge()
                        

Current age, calculated based on the date of birth or the date of birth parts field (if currentAge calculation is enabled)

Returns:

currentAge

setCurrentAge

                          public void setCurrentAge(String currentAge)
                        

additionalLanguage

                          public ExtractionCapabilityResponseData additionalLanguage(ExtractionCapabilityResponseDataAdditionalLanguage additionalLanguage)
                        

getAdditionalLanguage

                          @Nullable public ExtractionCapabilityResponseDataAdditionalLanguage getAdditionalLanguage()
                        

Get additionalLanguage

Returns:

additionalLanguage

setAdditionalLanguage

                          public void setAdditionalLanguage(ExtractionCapabilityResponseDataAdditionalLanguage additionalLanguage)
                        

mrz

                          public ExtractionCapabilityResponseData mrz(ExtractionCapabilityResponseDataMrz mrz)
                        

getMrz

                          @Nullable public ExtractionCapabilityResponseDataMrz getMrz()
                        

Get mrz

Returns:

mrz

setMrz

                          public void setMrz(ExtractionCapabilityResponseDataMrz mrz)
                        

equals

                          public boolean equals(Object o)
                        

Overrides:

equals in class Object

hashCode

                          public int hashCode()
                        

Overrides:

hashCode in class Object

toString

                          public String toString()
                        

Overrides:

toString in class Object