Search docsIDmission.com ↗
Mobile SDKs18 pages
Mobile SDKs / IdDataRequest

IdDataRequest

← Browse native SDK reference

Imported 2026-10-21View original source ↗How updates workRead Markdown
On this page · 5 sections
IDentity-SDK/com.idmission.sdk2.client.model/IdDataRequest

IdDataRequest

@Serializable()
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 5MB. Minimum resolution required is 800X600.

idBarcodeImage

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

idNumber

ID Number.

idNumber2

ID Number.

issueDate

ID Issue Date. Date will be formatted as dd/mm/yyyy format.

expDate

ID Expiration Date. Date will be formatted as dd/mm/yyyy format.

videoIdImageFront

This should contain base64 data of the Customer id Front Video Data. It accepts base64 data.

videoIdImageBack

This should contain base64 data of the Customer id back Video Data. It accepts base64 data.

idFrontIrImage

This should contain base64 data of the Customer id front IR image. It accepts base64 data.

idBackIrImage

This should contain base64 data of the Customer id back IR image. It accepts base64 data.

idFrontUvImage

This should contain base64 data of the Customer id front UV image. It accepts base64 data.

idBackUvImage

This should contain base64 data of the Customer id back UV image. It accepts base64 data.

Constructors

public IdDataRequest IdDataRequest(String idType, String idCountry, String idState, String idImageFront, String idImageBack, String idBarcodeImage, String idNumber, String idNumber2, String issueDate, String expDate, String videoIdImageFront, String videoIdImageBack, String idFrontIrImage, String idBackIrImage, String idFrontUvImage, String idBackUvImage)

Properties

private String expDate

string($DD/MM/YYYY) example: 31/12/2019 ID Expiration Date. Date will be formatted as dd/mm/yyyy format.

private String idBackIrImage

string($Base64) This should contain base64 data of the Customer id back IR image. It accepts base64 data.

private String idBackUvImage

string($Base64) This should contain base64 data of the Customer id back UV image. It accepts base64 data.

private String idBarcodeImage

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

private String idCountry

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

private String idFrontIrImage

string($Base64) This should contain base64 data of the Customer id front IR image. It accepts base64 data.

private String idFrontUvImage

string($Base64) This should contain base64 data of the Customer id front UV image. It accepts base64 data.

private String idImageBack

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

private String idImageFront

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

private String idNumber

string example: 123456 ID Number.

private String idNumber2

string example: 123456 ID Number.

private 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

private 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

private String issueDate

string($DD/MM/YYYY) example: 31/12/2019 ID Issue Date. Date will be formatted as dd/mm/yyyy format.

private String videoIdImageBack

string($Base64) This should contain base64 data of the Customer id back Video Data. It accepts base64 data.

private String videoIdImageFront

string($Base64) This should contain base64 data of the Customer id Front Video Data. It accepts base64 data.

Functions

public final String getExpDate()

string($DD/MM/YYYY) example: 31/12/2019 ID Expiration Date. Date will be formatted as dd/mm/yyyy format.

public final String getIdBackIrImage()

string($Base64) This should contain base64 data of the Customer id back IR image. It accepts base64 data.

public final String getIdBackUvImage()

string($Base64) This should contain base64 data of the Customer id back UV image. It accepts base64 data.

public final String getIdBarcodeImage()

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

public final String getIdCountry()

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

public final String getIdFrontIrImage()

string($Base64) This should contain base64 data of the Customer id front IR image. It accepts base64 data.

public final String getIdFrontUvImage()

string($Base64) This should contain base64 data of the Customer id front UV image. It accepts base64 data.

public final String getIdImageBack()

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

public final String getIdImageFront()

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

public final String getIdNumber()

string example: 123456 ID Number.

public final String getIdNumber2()

string example: 123456 ID Number.

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

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

public final String getIssueDate()

string($DD/MM/YYYY) example: 31/12/2019 ID Issue Date. Date will be formatted as dd/mm/yyyy format.

public final String getVideoIdImageBack()

string($Base64) This should contain base64 data of the Customer id back Video Data. It accepts base64 data.

public final String getVideoIdImageFront()

string($Base64) This should contain base64 data of the Customer id Front Video Data. It accepts base64 data.

public final Unit setExpDate(String expDate)

string($DD/MM/YYYY) example: 31/12/2019 ID Expiration Date. Date will be formatted as dd/mm/yyyy format.

public final Unit setIdBackIrImage(String idBackIrImage)

string($Base64) This should contain base64 data of the Customer id back IR image. It accepts base64 data.

public final Unit setIdBackUvImage(String idBackUvImage)

string($Base64) This should contain base64 data of the Customer id back UV image. It accepts base64 data.

public final Unit setIdBarcodeImage(String idBarcodeImage)

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

public final Unit setIdCountry(String idCountry)

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

public final Unit setIdFrontIrImage(String idFrontIrImage)

string($Base64) This should contain base64 data of the Customer id front IR image. It accepts base64 data.

public final Unit setIdFrontUvImage(String idFrontUvImage)

string($Base64) This should contain base64 data of the Customer id front UV image. It accepts base64 data.

public final Unit setIdImageBack(String idImageBack)

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

public final Unit setIdImageFront(String idImageFront)

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

public final Unit setIdNumber(String idNumber)

string example: 123456 ID Number.

public final Unit setIdNumber2(String idNumber2)

string example: 123456 ID Number.

public final Unit setIdState(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

public final Unit setIdType(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

public final Unit setIssueDate(String issueDate)

string($DD/MM/YYYY) example: 31/12/2019 ID Issue Date. Date will be formatted as dd/mm/yyyy format.

public final Unit setVideoIdImageBack(String videoIdImageBack)

string($Base64) This should contain base64 data of the Customer id back Video Data. It accepts base64 data.

public final Unit setVideoIdImageFront(String videoIdImageFront)

string($Base64) This should contain base64 data of the Customer id Front Video Data. It accepts base64 data.

Report a docs issue

Copy this context into your team’s issue tracker or an email to support@idmission.com.