ExtractedPersonalData

public final class ExtractedPersonalData

Parameters

uniqueNumber

This is a unique number that will be associated with the customer when enrolled or when performing future verifications

name

Name of the customer

email

Email address of the customer. Optional for any service

dob

Date of birth of the customer. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.

gender

Gender of the customer. Valid values are M and F

addressLine1

Address Line1 of the customer

addressLine2

Address Line2 of the customer

city

City address of the customer

country

Country associated with the Customer

lastName2

This field is extracted from: - The barcode or MRZ (if present) - The front or back of the ID.

firstName

First name extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present

middleName

Middle name extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present

lastName

This field is extracted from: - The barcode or MRZ (if present) - The front or back of the ID.

firstNameNonEng

Non English first name, extracted from the front or back of the ID.

lastNameNonEng

Non English last name, extracted from the front or back of the ID.

middleNameNonEng

Non English middle name, extracted from the front or back of the ID.

addressNonEng

Non English address, extracted from the front or back of the ID.

addressLine1NonEng

Non English address line 1, extracted from the front or back of the ID.

addressLine2NonEng

Non English address line 2, extracted from the front or back of the ID.

phone

Phone Number of the customer

district

District address of the customer

fingerprintUsedForVerification

Enrolled FP image of the customer. This should contain base64 customer photo.

enrolledDate

Enrolled date of the customer. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.

enrolledFaceImage

Enrolled face image of the customer. This should contain base64 customer photo.

state

State of the customer.

postalCode

Postal code of the customer.

selfieImage

base64 selfie image data

Constructors

Link copied to clipboard
public ExtractedPersonalData ExtractedPersonalData(String uniqueNumber, String name, String email, String dob, String gender, String address, String addressLine1, String addressLine2, String addressLine3, String city, String country, String lastName2, String firstName, String middleName, String lastName, String firstNameNonEng, String lastNameNonEng, String middleNameNonEng, String addressNonEng, String addressLine1NonEng, String addressLine2NonEng, String phone, String district, String fingerprintUsedForVerification, String enrolledDate, String enrolledFaceImage, String state, String postalCode, String selfieImage)

Properties

Link copied to clipboard
private final String address

Type:String
Example:123 Main Street, Company name, 121 Main Street
Address of the customer

Link copied to clipboard
private final String addressLine1

Type:String
Example:123 Main Street
Address Line1 of the customer

Link copied to clipboard
private final String addressLine1NonEng

Type:String
Non English address line 1, extracted from the front or back of the ID.

Link copied to clipboard
private final String addressLine2

Type:String
Example:Company name
Address Line2 of the customer

Link copied to clipboard
private final String addressLine2NonEng

Type:String
Non English address line 2, extracted from the front or back of the ID.

Link copied to clipboard
private final String addressLine3

Type:String
Example:example: 121 Main Street
Address Line3 of the customer

Link copied to clipboard
private final String addressNonEng

Type:String
Non English address, extracted from the front or back of the ID.

Link copied to clipboard
private final String city

Type:String
Example:San Francisco
City address of the customer

Link copied to clipboard
private final String country

Type:String
Maxlength:3
Minlength:3
Example:USA
Country associated with the Customer

Link copied to clipboard
private final String district

Type:String
Example:CA
District address of the customer

Link copied to clipboard
private final String dob

Type:String($DD/MM/YYYY)
Example:31/12/2019
Date of birth of the customer. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.

Link copied to clipboard
private final String email

Type:String($email)
Example:abc@gmail.com
Email address of the customer. Optional for any service

Link copied to clipboard
private final String enrolledDate

Type:String
Example:123456
Enrolled date of the customer. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.

Link copied to clipboard
private final String enrolledFaceImage

Type:String
Enrolled face image of the customer. This should contain base64 customer photo.

Link copied to clipboard

Type:String
Enrolled FP image of the customer. This should contain base64 customer photo.

Link copied to clipboard
private final String firstName

Type:String
First name extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present

Link copied to clipboard
private final String firstNameNonEng

Type:String
Non English first name, extracted from the front or back of the ID.

Link copied to clipboard
private final String gender

Type:String
Example:M
Gender of the customer. Valid values are M and F

Link copied to clipboard
private final String lastName

Type:String
This field is extracted from:

Link copied to clipboard
private final String lastName2

Type:String
This field is extracted from:

Link copied to clipboard
private final String lastNameNonEng

Type:String
Non English last name, extracted from the front or back of the ID.

Link copied to clipboard
private final String middleName

Type:String
Middle name extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present

Link copied to clipboard
private final String middleNameNonEng

Type:String
Non English middle name, extracted from the front or back of the ID.

Link copied to clipboard
private final String name

Type:String
Example:jon doe
Name of the customer

Link copied to clipboard
private final String phone

Type:String
Example:123456789
Phone Number of the customer

Link copied to clipboard

Type:String
Example:11224-0000
Postal Code of the customer

Link copied to clipboard
private final String selfieImage
Link copied to clipboard
private final String state

Type:String
Example:11224-0000
state of the customer

Link copied to clipboard
private final String uniqueNumber

Type:String
Example:123456
maxlength:45
This is a unique number that will be associated with the customer when enrolled or when performing future verifications

Functions

Link copied to clipboard
public final String getAddress()

Type:String
Example:123 Main Street, Company name, 121 Main Street
Address of the customer

Link copied to clipboard
public final String getAddressLine1()

Type:String
Example:123 Main Street
Address Line1 of the customer

Link copied to clipboard

Type:String
Non English address line 1, extracted from the front or back of the ID.

Link copied to clipboard
public final String getAddressLine2()

Type:String
Example:Company name
Address Line2 of the customer

Link copied to clipboard

Type:String
Non English address line 2, extracted from the front or back of the ID.

Link copied to clipboard
public final String getAddressLine3()

Type:String
Example:example: 121 Main Street
Address Line3 of the customer

Link copied to clipboard
public final String getAddressNonEng()

Type:String
Non English address, extracted from the front or back of the ID.

Link copied to clipboard
public final String getCity()

Type:String
Example:San Francisco
City address of the customer

Link copied to clipboard
public final String getCountry()

Type:String
Maxlength:3
Minlength:3
Example:USA
Country associated with the Customer

Link copied to clipboard
public final String getDistrict()

Type:String
Example:CA
District address of the customer

Link copied to clipboard
public final String getDob()

Type:String($DD/MM/YYYY)
Example:31/12/2019
Date of birth of the customer. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.

Link copied to clipboard
public final String getEmail()

Type:String($email)
Example:abc@gmail.com
Email address of the customer. Optional for any service

Link copied to clipboard
public final String getEnrolledDate()

Type:String
Example:123456
Enrolled date of the customer. Date will be formatted as dd/mm/yyyy format if parsed correctly after extraction.

Link copied to clipboard

Type:String
Enrolled face image of the customer. This should contain base64 customer photo.

Link copied to clipboard

Type:String
Enrolled FP image of the customer. This should contain base64 customer photo.

Link copied to clipboard
public final String getFirstName()

Type:String
First name extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present

Link copied to clipboard
public final String getFirstNameNonEng()

Type:String
Non English first name, extracted from the front or back of the ID.

Link copied to clipboard
public final String getGender()

Type:String
Example:M
Gender of the customer. Valid values are M and F

Link copied to clipboard
public final String getLastName()

Type:String
This field is extracted from:

Link copied to clipboard
public final String getLastName2()

Type:String
This field is extracted from:

Link copied to clipboard
public final String getLastNameNonEng()

Type:String
Non English last name, extracted from the front or back of the ID.

Link copied to clipboard
public final String getMiddleName()

Type:String
Middle name extracted from either barcode, MRZ, or front of the ID when MRZ / barcode are not present

Link copied to clipboard
public final String getMiddleNameNonEng()

Type:String
Non English middle name, extracted from the front or back of the ID.

Link copied to clipboard
public final String getName()

Type:String
Example:jon doe
Name of the customer

Link copied to clipboard
public final String getPhone()

Type:String
Example:123456789
Phone Number of the customer

Link copied to clipboard
public final String getPostalCode()

Type:String
Example:11224-0000
Postal Code of the customer

Link copied to clipboard
public final String getSelfieImage()
Link copied to clipboard
public final String getState()

Type:String
Example:11224-0000
state of the customer

Link copied to clipboard
public final String getUniqueNumber()

Type:String
Example:123456
maxlength:45
This is a unique number that will be associated with the customer when enrolled or when performing future verifications

Link copied to clipboard
public final Unit setPostalCode(String postalCode)

Type:String
Example:11224-0000
Postal Code of the customer