IDentity-SDK/com.idmission.sdk2.client.model/IdDataRequest

IdDataRequest

public final class IdDataRequest

Parameters

idType

This is the code value of the ID type being submitted. Valid values are: - PP - for Passport - DL - for Driver’s License - PID - for Photo ID - NID – for National ID - GID – for Government, Military or Police ID - RID – Residence Card - VID – for Voter ID Card - WV – for Work Visa or Permit - UNR – United Nations Refugee Card - OTH - Other - NSP – Not Specified

idCountry

This is the 3 digit ISO Country Code

idState

To help with targeting matching, recommended to be sent when the idCountry equals USA, CAN or AUS and idType equals PID or DL

idImageFront

This should contain base64 data of the ID front image. Max allowed upload size is 2MB.

idImageBack

This should contain base64 data of the ID front image. Max allowed upload size is 2MB.

Constructors

Link copied to clipboard
public IdDataRequest IdDataRequest(String idType, String idCountry, String idState, String idImageFront, String idImageBack)

Properties

Link copied to clipboard
private final String idCountry

Type: string
maxLength: 3
minLength: 3
example: IND
This is the 3 digit ISO Country Code

Link copied to clipboard
private final String idImageBack

Type: string($base64)
This should contain base64 data of the ID back image. Max allowed upload size is 2MB.

Link copied to clipboard
private final String idImageFront

Type: string($base64)
This should contain base64 data of the ID front image. Max allowed upload size is 2MB.

Link copied to clipboard
private final String idState

Type: string
maxLength: 3
minLength: 2
example: CA
To help with targeting matching, recommended to be sent when the idCountry equals USA, CAN or AUS and idType equals PID or DL

Link copied to clipboard
private final String idType

Type: string
example: PP This is the code value of the ID type being submitted. Valid values are:
PP - for Passport
DL - for Driver’s License
PID - for Photo ID
NID – for National ID
GID – for Government, Military or Police ID
RID – Residence Card
VID – for Voter ID Card
WV – for Work Visa or Permit
UNR – United Nations Refugee Card
OTH - Other
NSP – Not Specified

Functions

Link copied to clipboard
public final String getIdCountry()

Type: string
maxLength: 3
minLength: 3
example: IND
This is the 3 digit ISO Country Code

Link copied to clipboard
public final String getIdImageBack()

Type: string($base64)
This should contain base64 data of the ID back image. Max allowed upload size is 2MB.

Link copied to clipboard
public final String getIdImageFront()

Type: string($base64)
This should contain base64 data of the ID front image. Max allowed upload size is 2MB.

Link copied to clipboard
public final String getIdState()

Type: string
maxLength: 3
minLength: 2
example: CA
To help with targeting matching, recommended to be sent when the idCountry equals USA, CAN or AUS and idType equals PID or DL

Link copied to clipboard
public final String getIdType()

Type: string
example: PP This is the code value of the ID type being submitted. Valid values are:
PP - for Passport
DL - for Driver’s License
PID - for Photo ID
NID – for National ID
GID – for Government, Military or Police ID
RID – Residence Card
VID – for Voter ID Card
WV – for Work Visa or Permit
UNR – United Nations Refugee Card
OTH - Other
NSP – Not Specified