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="2023-05-09T15:46:41.754885500+02:00[Europe/Vienna]")
public class ExtractionCapabilityResponseData
extends Object
ExtractionCapabilityResponseData
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionaccountNumber
(Object accountNumber) addDlCategoriesItem
(DrivingLicenseCategory dlCategoriesItem) address
(AddressResponse address) cardNumberLastFourDigits
(String cardNumberLastFourDigits) citizenship
(String citizenship) currentAge
(String currentAge) customExtractionPoints
(Map<String, Object> customExtractionPoints) dateOfBirth
(LocalDate dateOfBirth) dateOfBirthParts
(DateParts dateOfBirthParts) disabilities
(String disabilities) dlCategories
(List<DrivingLicenseCategory> dlCategories) documentCopy
(String documentCopy) documentIdentificationNumber
(String documentIdentificationNumber) documentNumber
(String documentNumber) documentType
(Object documentType) dueDateParts
(DateParts dueDateParts) durationOfStay
(String durationOfStay) boolean
expiryDate
(LocalDate expiryDate) expiryDateParts
(DateParts expiryDateParts) fathersName
(String fathersName) Get accountNumberorg.openapitools.jackson.nullable.JsonNullable<Object>
Get addresscontains last 4 digits of credit card number for CCS document typeCitizenship (if extraction is enabled)getCpf()
Get cpfgetCurp()
The CURP for mexican documentsCurrent age, calculated based on the date of birth or the date of birth parts field (if currentAge calculation is enabled)Get customExtractionPointsGet dateOfBirthGet dateOfBirthPartsDisabilities (if extraction is enabled)Get dlCategoriesgetDni()
DNI as available on the ID if idCountry = ESP and idSubtype = NATIONAL_IDDocument copy (if extraction is enabled)Document identification number (if extraction is enabled)Get documentNumberGet documentTypeorg.openapitools.jackson.nullable.JsonNullable<Object>
Get dueDateGet dueDatePartsDuration of stay if idType = VISA and additional extraction for Visa enabledGet expiryDateGet expiryDatePartsGet fathersNameGet firstName- M - F - XIssuing authority of the documentThe country this document was issued.Get issuingDateGet issuingDateParts\\\"Numero de emission\\\" number for idCountry = MEX (if extraction is enabled)Issuing place of the documentLabor identification number (if extraction is enabled)Get lastNameLast name at birth (if extraction is enabled)Marital status (if extraction is enabled)contains credit card's expiry date in format MM/YYGet mothersNameNationality of the document holder in ISO 3166-1 alpha-3 country code or country specific non ISO nationalities (3 letters)Number of entries if idType = VISA and additional extraction for Visa enabledOptional field of MRZ line 1Optional field of MRZ line 2PAN number in case of CC document type (Can be masked as well)Passport number if idType = VISA and additional extraction for Visa enabledGet personalIdentificationNumberGet personalNumbergetPesel()
Get peselGet placeOfBirthProfession (if extraction is enabled)Get registrationNumberReligion (if extraction is enabled)Remarks (if extraction is enabled)Permit remarks related to \"Golden Visas\" (if extraction is enabled)Permit type related to \"Golden Visas\" (if extraction is enabled)Get rgNumberwhether signature is available on SSN or not (only applies to SSN in USA)getSsn()
represents the SSN for USAgetState()
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 codeGet subTypeGet swiftCodeorg.openapitools.jackson.nullable.JsonNullable<Object>
Tax number of the document in case the country is ITA and type is HEALTH_ID or TAX_IDgetType()
Get typeVisa category if idType = VISA and additional extraction for Visa enabled\\\"Clave de elector\\\" number for idCountry = MEX (if extraction is enabled)Work permit number (if extraction is enabled)int
hashCode()
issuingAuthority
(String issuingAuthority) issuingCountry
(String issuingCountry) issuingDate
(LocalDate issuingDate) issuingDateParts
(DateParts issuingDateParts) issuingNumber
(String issuingNumber) issuingPlace
(String issuingPlace) laborIdentificationNumber
(String laborIdentificationNumber) lastNameAtBirth
(String lastNameAtBirth) maritalStatus
(String maritalStatus) monthYearExpiry
(String monthYearExpiry) mothersName
(String mothersName) nationality
(String nationality) numberOfEntries
(String numberOfEntries) optionalMrzField1
(String optionalMrzField1) optionalMrzField2
(String optionalMrzField2) passportNumber
(String passportNumber) personalIdentificationNumber
(String personalIdentificationNumber) personalNumber
(String personalNumber) placeOfBirth
(String placeOfBirth) profession
(String profession) putCustomExtractionPointsItem
(String key, Object customExtractionPointsItem) registrationNumber
(String registrationNumber) residentPermitRemarks
(String residentPermitRemarks) residentPermitType
(String residentPermitType) void
setAccountNumber
(Object accountNumber) void
setAccountNumber_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<Object> accountNumber) void
setAddress
(AddressResponse address) void
setCardNumberLastFourDigits
(String cardNumberLastFourDigits) void
setCitizenship
(String citizenship) void
void
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
void
setDocumentCopy
(String documentCopy) void
setDocumentIdentificationNumber
(String documentIdentificationNumber) void
setDocumentNumber
(String documentNumber) void
setDocumentType
(Object documentType) void
setDocumentType_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<Object> documentType) void
setDueDate
(LocalDate dueDate) void
setDueDateParts
(DateParts dueDateParts) void
setDurationOfStay
(String durationOfStay) void
setExpiryDate
(LocalDate expiryDate) void
setExpiryDateParts
(DateParts expiryDateParts) void
setFathersName
(String fathersName) void
setFirstName
(String firstName) void
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
setMonthYearExpiry
(String monthYearExpiry) void
setMothersName
(String mothersName) 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
void
setPlaceOfBirth
(String placeOfBirth) void
setProfession
(String profession) void
setRegistrationNumber
(String registrationNumber) void
setReligion
(String religion) void
setRemarks
(String remarks) void
setResidentPermitRemarks
(String residentPermitRemarks) void
setResidentPermitType
(String residentPermitType) void
setRgNumber
(String rgNumber) void
setSignatureAvailable
(Boolean signatureAvailable) void
void
void
setSubType
(String subType) void
setSwiftCode
(Object swiftCode) void
setSwiftCode_JsonNullable
(org.openapitools.jackson.nullable.JsonNullable<Object> swiftCode) void
setTaxNumber
(String taxNumber) void
void
setVisaCategory
(String visaCategory) void
setVoterIdNumber
(String voterIdNumber) void
setWorkPermitNumber
(String workPermitNumber) signatureAvailable
(Boolean signatureAvailable) toString()
visaCategory
(String visaCategory) voterIdNumber
(String voterIdNumber) workPermitNumber
(String workPermitNumber)
-
Field Details
-
JSON_PROPERTY_TYPE
- See Also:
-
JSON_PROPERTY_SUB_TYPE
- See Also:
-
JSON_PROPERTY_ISSUING_COUNTRY
- See Also:
-
JSON_PROPERTY_FIRST_NAME
- See Also:
-
JSON_PROPERTY_LAST_NAME
- See Also:
-
JSON_PROPERTY_DATE_OF_BIRTH
- See Also:
-
JSON_PROPERTY_DATE_OF_BIRTH_PARTS
- See Also:
-
JSON_PROPERTY_EXPIRY_DATE
- See Also:
-
JSON_PROPERTY_EXPIRY_DATE_PARTS
- See Also:
-
JSON_PROPERTY_ISSUING_DATE
- See Also:
-
JSON_PROPERTY_ISSUING_DATE_PARTS
- See Also:
-
JSON_PROPERTY_DUE_DATE
- See Also:
-
JSON_PROPERTY_DUE_DATE_PARTS
- See Also:
-
JSON_PROPERTY_ACCOUNT_NUMBER
- See Also:
-
JSON_PROPERTY_SWIFT_CODE
- See Also:
-
JSON_PROPERTY_DOCUMENT_TYPE
- See Also:
-
JSON_PROPERTY_DOCUMENT_NUMBER
- See Also:
-
JSON_PROPERTY_SSN
- See Also:
-
JSON_PROPERTY_SIGNATURE_AVAILABLE
- See Also:
-
JSON_PROPERTY_STATE
- See Also:
-
JSON_PROPERTY_PERSONAL_NUMBER
- See Also:
-
JSON_PROPERTY_OPTIONAL_MRZ_FIELD1
- See Also:
-
JSON_PROPERTY_OPTIONAL_MRZ_FIELD2
- See Also:
-
JSON_PROPERTY_ADDRESS
- See Also:
-
JSON_PROPERTY_ISSUING_AUTHORITY
- See Also:
-
JSON_PROPERTY_ISSUING_PLACE
- See Also:
-
JSON_PROPERTY_CURP
- See Also:
-
JSON_PROPERTY_GENDER
- See Also:
-
JSON_PROPERTY_NATIONALITY
- See Also:
-
JSON_PROPERTY_PLACE_OF_BIRTH
- See Also:
-
JSON_PROPERTY_TAX_NUMBER
- See Also:
-
JSON_PROPERTY_CPF
- See Also:
-
JSON_PROPERTY_REGISTRATION_NUMBER
- See Also:
-
JSON_PROPERTY_MOTHERS_NAME
- See Also:
-
JSON_PROPERTY_FATHERS_NAME
- See Also:
-
JSON_PROPERTY_PERSONAL_IDENTIFICATION_NUMBER
- See Also:
-
JSON_PROPERTY_RG_NUMBER
- See Also:
-
JSON_PROPERTY_DL_CATEGORIES
- See Also:
-
JSON_PROPERTY_VOTER_ID_NUMBER
- See Also:
-
JSON_PROPERTY_ISSUING_NUMBER
- See Also:
-
JSON_PROPERTY_PASSPORT_NUMBER
- See Also:
-
JSON_PROPERTY_DURATION_OF_STAY
- See Also:
-
JSON_PROPERTY_NUMBER_OF_ENTRIES
- See Also:
-
JSON_PROPERTY_VISA_CATEGORY
- See Also:
-
JSON_PROPERTY_DNI
- See Also:
-
JSON_PROPERTY_PESEL
- See Also:
-
JSON_PROPERTY_RESIDENT_PERMIT_TYPE
- See Also:
-
JSON_PROPERTY_RESIDENT_PERMIT_REMARKS
- See Also:
-
JSON_PROPERTY_PROFESSION
- See Also:
-
JSON_PROPERTY_CITIZENSHIP
- See Also:
-
JSON_PROPERTY_MARITAL_STATUS
- See Also:
-
JSON_PROPERTY_RELIGION
- See Also:
-
JSON_PROPERTY_DOCUMENT_IDENTIFICATION_NUMBER
- See Also:
-
JSON_PROPERTY_WORK_PERMIT_NUMBER
- See Also:
-
JSON_PROPERTY_LABOR_IDENTIFICATION_NUMBER
- See Also:
-
JSON_PROPERTY_DOCUMENT_COPY
- See Also:
-
JSON_PROPERTY_LAST_NAME_AT_BIRTH
- See Also:
-
JSON_PROPERTY_REMARKS
- See Also:
-
JSON_PROPERTY_DISABILITIES
- See Also:
-
JSON_PROPERTY_PAN_NUMBER
- See Also:
-
JSON_PROPERTY_MONTH_YEAR_EXPIRY
- See Also:
-
JSON_PROPERTY_CARD_NUMBER_LAST_FOUR_DIGITS
- See Also:
-
JSON_PROPERTY_CUSTOM_EXTRACTION_POINTS
- See Also:
-
JSON_PROPERTY_CURRENT_AGE
- See Also:
-
-
Constructor Details
-
ExtractionCapabilityResponseData
public ExtractionCapabilityResponseData()
-
-
Method Details
-
type
-
getType
Get type- Returns:
- type
-
setType
-
subType
-
getSubType
Get subType- Returns:
- subType
-
setSubType
-
issuingCountry
-
getIssuingCountry
The country this document was issued. Can be any ISO 3166-1 alpha-3 country code, and XKX for Kosovo- Returns:
- issuingCountry
-
setIssuingCountry
-
firstName
-
getFirstName
Get firstName- Returns:
- firstName
-
setFirstName
-
lastName
-
getLastName
Get lastName- Returns:
- lastName
-
setLastName
-
dateOfBirth
-
getDateOfBirth
Get dateOfBirth- Returns:
- dateOfBirth
-
setDateOfBirth
-
dateOfBirthParts
-
getDateOfBirthParts
Get dateOfBirthParts- Returns:
- dateOfBirthParts
-
setDateOfBirthParts
-
expiryDate
-
getExpiryDate
Get expiryDate- Returns:
- expiryDate
-
setExpiryDate
-
expiryDateParts
-
getExpiryDateParts
Get expiryDateParts- Returns:
- expiryDateParts
-
setExpiryDateParts
-
issuingDate
-
getIssuingDate
Get issuingDate- Returns:
- issuingDate
-
setIssuingDate
-
issuingDateParts
-
getIssuingDateParts
Get issuingDateParts- Returns:
- issuingDateParts
-
setIssuingDateParts
-
dueDate
-
getDueDate
Get dueDate- Returns:
- dueDate
-
setDueDate
-
dueDateParts
-
getDueDateParts
Get dueDateParts- Returns:
- dueDateParts
-
setDueDateParts
-
accountNumber
-
getAccountNumber
Get accountNumber- Returns:
- accountNumber
-
getAccountNumber_JsonNullable
-
setAccountNumber_JsonNullable
public void setAccountNumber_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Object> accountNumber) -
setAccountNumber
-
swiftCode
-
getSwiftCode
Get swiftCode- Returns:
- swiftCode
-
getSwiftCode_JsonNullable
-
setSwiftCode_JsonNullable
public void setSwiftCode_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Object> swiftCode) -
setSwiftCode
-
documentType
-
getDocumentType
Get documentType- Returns:
- documentType
-
getDocumentType_JsonNullable
-
setDocumentType_JsonNullable
public void setDocumentType_JsonNullable(org.openapitools.jackson.nullable.JsonNullable<Object> documentType) -
setDocumentType
-
documentNumber
-
getDocumentNumber
Get documentNumber- Returns:
- documentNumber
-
setDocumentNumber
-
ssn
-
getSsn
represents the SSN for USA- Returns:
- ssn
-
setSsn
-
signatureAvailable
-
getSignatureAvailable
whether signature is available on SSN or not (only applies to SSN in USA)- Returns:
- signatureAvailable
-
setSignatureAvailable
-
state
-
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
-
personalNumber
-
getPersonalNumber
Get personalNumber- Returns:
- personalNumber
-
setPersonalNumber
-
optionalMrzField1
-
getOptionalMrzField1
Optional field of MRZ line 1- Returns:
- optionalMrzField1
-
setOptionalMrzField1
-
optionalMrzField2
-
getOptionalMrzField2
Optional field of MRZ line 2- Returns:
- optionalMrzField2
-
setOptionalMrzField2
-
address
-
getAddress
Get address- Returns:
- address
-
setAddress
-
issuingAuthority
-
getIssuingAuthority
Issuing authority of the document- Returns:
- issuingAuthority
-
setIssuingAuthority
-
issuingPlace
-
getIssuingPlace
Issuing place of the document- Returns:
- issuingPlace
-
setIssuingPlace
-
curp
-
getCurp
The CURP for mexican documents- Returns:
- curp
-
setCurp
-
gender
-
getGender
- M - F - X- Returns:
- gender
-
setGender
-
nationality
-
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
-
placeOfBirth
-
getPlaceOfBirth
Get placeOfBirth- Returns:
- placeOfBirth
-
setPlaceOfBirth
-
taxNumber
-
getTaxNumber
Tax number of the document in case the country is ITA and type is HEALTH_ID or TAX_ID- Returns:
- taxNumber
-
setTaxNumber
-
cpf
-
getCpf
Get cpf- Returns:
- cpf
-
setCpf
-
registrationNumber
-
getRegistrationNumber
Get registrationNumber- Returns:
- registrationNumber
-
setRegistrationNumber
-
mothersName
-
getMothersName
Get mothersName- Returns:
- mothersName
-
setMothersName
-
fathersName
-
getFathersName
Get fathersName- Returns:
- fathersName
-
setFathersName
-
personalIdentificationNumber
public ExtractionCapabilityResponseData personalIdentificationNumber(String personalIdentificationNumber) -
getPersonalIdentificationNumber
Get personalIdentificationNumber- Returns:
- personalIdentificationNumber
-
setPersonalIdentificationNumber
-
rgNumber
-
getRgNumber
Get rgNumber- Returns:
- rgNumber
-
setRgNumber
-
dlCategories
-
addDlCategoriesItem
public ExtractionCapabilityResponseData addDlCategoriesItem(DrivingLicenseCategory dlCategoriesItem) -
getDlCategories
Get dlCategories- Returns:
- dlCategories
-
setDlCategories
-
voterIdNumber
-
getVoterIdNumber
\\\"Clave de elector\\\" number for idCountry = MEX (if extraction is enabled)- Returns:
- voterIdNumber
-
setVoterIdNumber
-
issuingNumber
-
getIssuingNumber
\\\"Numero de emission\\\" number for idCountry = MEX (if extraction is enabled)- Returns:
- issuingNumber
-
setIssuingNumber
-
passportNumber
-
getPassportNumber
Passport number if idType = VISA and additional extraction for Visa enabled- Returns:
- passportNumber
-
setPassportNumber
-
durationOfStay
-
getDurationOfStay
Duration of stay if idType = VISA and additional extraction for Visa enabled- Returns:
- durationOfStay
-
setDurationOfStay
-
numberOfEntries
-
getNumberOfEntries
Number of entries if idType = VISA and additional extraction for Visa enabled- Returns:
- numberOfEntries
-
setNumberOfEntries
-
visaCategory
-
getVisaCategory
Visa category if idType = VISA and additional extraction for Visa enabled- Returns:
- visaCategory
-
setVisaCategory
-
dni
-
getDni
DNI as available on the ID if idCountry = ESP and idSubtype = NATIONAL_ID- Returns:
- dni
-
setDni
-
pesel
-
getPesel
Get pesel- Returns:
- pesel
-
setPesel
-
residentPermitType
-
getResidentPermitType
Permit type related to \"Golden Visas\" (if extraction is enabled)- Returns:
- residentPermitType
-
setResidentPermitType
-
residentPermitRemarks
-
getResidentPermitRemarks
Permit remarks related to \"Golden Visas\" (if extraction is enabled)- Returns:
- residentPermitRemarks
-
setResidentPermitRemarks
-
profession
-
getProfession
Profession (if extraction is enabled)- Returns:
- profession
-
setProfession
-
citizenship
-
getCitizenship
Citizenship (if extraction is enabled)- Returns:
- citizenship
-
setCitizenship
-
maritalStatus
-
getMaritalStatus
Marital status (if extraction is enabled)- Returns:
- maritalStatus
-
setMaritalStatus
-
religion
-
getReligion
Religion (if extraction is enabled)- Returns:
- religion
-
setReligion
-
documentIdentificationNumber
public ExtractionCapabilityResponseData documentIdentificationNumber(String documentIdentificationNumber) -
getDocumentIdentificationNumber
Document identification number (if extraction is enabled)- Returns:
- documentIdentificationNumber
-
setDocumentIdentificationNumber
-
workPermitNumber
-
getWorkPermitNumber
Work permit number (if extraction is enabled)- Returns:
- workPermitNumber
-
setWorkPermitNumber
-
laborIdentificationNumber
-
getLaborIdentificationNumber
Labor identification number (if extraction is enabled)- Returns:
- laborIdentificationNumber
-
setLaborIdentificationNumber
-
documentCopy
-
getDocumentCopy
Document copy (if extraction is enabled)- Returns:
- documentCopy
-
setDocumentCopy
-
lastNameAtBirth
-
getLastNameAtBirth
Last name at birth (if extraction is enabled)- Returns:
- lastNameAtBirth
-
setLastNameAtBirth
-
remarks
-
getRemarks
Remarks (if extraction is enabled)- Returns:
- remarks
-
setRemarks
-
disabilities
-
getDisabilities
Disabilities (if extraction is enabled)- Returns:
- disabilities
-
setDisabilities
-
panNumber
-
getPanNumber
PAN number in case of CC document type (Can be masked as well)- Returns:
- panNumber
-
setPanNumber
-
monthYearExpiry
-
getMonthYearExpiry
contains credit card's expiry date in format MM/YY- Returns:
- monthYearExpiry
-
setMonthYearExpiry
-
cardNumberLastFourDigits
-
getCardNumberLastFourDigits
contains last 4 digits of credit card number for CCS document type- Returns:
- cardNumberLastFourDigits
-
setCardNumberLastFourDigits
-
customExtractionPoints
public ExtractionCapabilityResponseData customExtractionPoints(Map<String, Object> customExtractionPoints) -
putCustomExtractionPointsItem
public ExtractionCapabilityResponseData putCustomExtractionPointsItem(String key, Object customExtractionPointsItem) -
getCustomExtractionPoints
Get customExtractionPoints- Returns:
- customExtractionPoints
-
setCustomExtractionPoints
-
currentAge
-
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
-
equals
-
hashCode
public int hashCode() -
toString
-