Generate Token to Test Demo
1. Introduction This document introduces the Web SDK within the IDmission product suite. Developers, project managers and QA testers should reference this document for information on configuration and use of the Web SDK on the Desktop browsers. IDmission recommends reading this entire document as an implementation guide to fully understand the Web SDK functionality and its respective capabilities. 2. Key features 2.1 The main features supported in this WebSDK are:
  • Live Face Detection
  • Auto ID Capture
  • Video Capture
  • Signature Capture
  • Voice Capture
Note: When using the Web SDK, you do not need to create a request for XML; it is automatically generated by the Web SDK based on the function that you are calling. 3. Minimum Requirements and Initial Setup 3.1 IDMWebSDK links 3.1.1 Add following links in your files for import latest IDMWebSDK.

    <link rel="stylesheet" href="https://demo.idmission.com/IDMWebSDK/Download/idmSDK.css">

    <script type="text/javascript" src="https://demo.idmission.com/IDMWebSDK/Download/idmSDK.js"></script>

    <script type="text/javascript" src="https://demo.idmission.com/IDMWebSDK/Download/idmsLiveFaceID-2.0.js"></script>

    <link rel="stylesheet" href="https://kyc.idmission.com/IDMWebSDK/Download/idmSDK.css">

    <script type="text/javascript" src="https://kyc.idmission.com/IDMWebSDK/Download/idmSDK.js"></script>

    <script type="text/javascript" src="https://kyc.idmission.com/IDMWebSDK/Download/idmsLiveFaceID-2.0.js"></script>

    <link rel="stylesheet" href="https://uat.idmission.com/IDMWebSDK/Download/idmSDK.css">

    <script type="text/javascript" src="https://uat.idmission.com/IDMWebSDK/Download/idmSDK.js"></script>

    <script type="text/javascript" src="https://uat.idmission.com/IDMWebSDK/Download/idmsLiveFaceID-2.0.js"></script>

3.2 Token for WebSDK Token is required to use WebSDK. Token needs to be generated on the server hosting the web app using the credentials provided by IDmission. Credentials are the client secret and should not be visible on the client html using view source or any other method on streams Token is valid for 10 mins and needs to be sent to client side app to be sent in each request to the library. 3.2.1 URL used to generate token :

https://kyc.idmission.com/apps/generateToken

3.2.2 Request Parameters :
Parameter Default Description
loginId * - Your Login ID
password * - Your Login Password
requestId * - Unique alphanumeric string
merchantId * - Your Merchant ID
Note: All parameters having '*' are mandatory. Example Request: 3.2.3 Response Status Codes :
Status Code Status Message
000 Token has been created successfully.
002 Unique request ID required.
224 Invalid login credentials.
Example Response:

var response = {

'statusCode' : '000',

'statusMessage' : 'Token has been created successfully.',

'dataList' : [],

'data': {

'requestId': '123123',

'tokenId': '790693F1BA9FDB02A4F1E85DB7EA19551C9F11CC84B4EB26E1ABD8339BB21547.ZGVTBZAWMVSXMC4WLJAUMJM4XQ'

}

};

3.3 The following permission should be present: 3.3.1 navigator.geolocation.getCurrentPosition to access user's current position. If user doesn't allow to capture location, it will be sent as 0. If user allow to capture location, Set location to global variable of WebSDK like below:

var gpsCoordinates = {

'Latitude' : position.coords.latitude,

'Longitude' : position.coords.longitude,

'AreaName' : "N/A"

};

WebSDK.gpsCoordinates = gpsCoordinates;

Select Service



4. Service Names Each of these features are available through various Service Names. A full list of current available services is provided in the table below.
Service Name Service Description Included Features
Validate-id-match-face ID Validation + Face Match Capturing ID document(s), validate the ID and extract data from it. Additionally capture a selfie and match it against the photo on ID.
Validate-id ID Validation Only Capturing ID document(s), validate the ID and extract data from it.
Enroll ID Validation + Face Match Customer Enrollment Capturing ID document(s), validate the ID and extract data from it. Additionally capture a selfie of customer and match it against the photo on the ID then enroll all captured biometrics with the customer if the match is positive.
Verify Customer Verification Capture of biometrics data to verify against a previously enrolled customer.
Enroll-from-Video IDV + Video Match with Customer Enrollment (Primary ID) Capturing ID document(s), validate the ID and extract data from it. Additionally capture a video of customer and match it against the photo on the ID, then enroll all captured biometrics with the customer if the match is positive.
Enroll-biometrics Customer Enroll with Biometrics Capture customer data and biometrics and enroll into the customer database. No ID documents are captured.
Live-check Live Face Capturing a selfie to detect liveness .
identify 1:N Face Match 1:N Face Match
ID Validation + Face Match
5. ID Validation + Face Match Capturing ID document(s), validate the ID and extract data from it. Additionally capture a selfie and match it against the photo on ID.
5. ID Validation Only Capturing ID document(s), validate the ID and extract data from it.
5. ID Validation + Face Match with Customer Enrollment Capturing ID document(s), validate the ID and extract data from it. Additionally capture a selfie of customer and match it against the photo on the ID,capture a Signature of customer then enroll all captured biometrics with the customer if the match is positive.
5.1 ID Types
ID Type ID Type Value ID Back Required
Passport PP N
National ID NID Y
Resident Permit RID Y
Drivers License DL Y
Photo ID PID Y
Voter ID VID Y
Tax ID Card TID Y
Work Permit WV Y
Student Visa SV Y
Government or Military ID GID Y
Boat Or Ship ID Card BID Y
Other OTH Y
Global Entry Card GE Y
Passport Card PPC Y
5.1 Set service parameters and pre-download required components for Auto ID capture

WebSDK.setServices(configuration);

where, 5.1.1 configuration will be as follows:

configuration = {

'serviceName' : Selected Service by Name,

'enableswagger' : Y,

'Enabled GEO Location' : N,//'If we set Enabled Geo Location: "Y" then it allows location pop-up on browser'

'idType' : "NSP",

'idCountry' : "NSP",

'idState' : "",

'requestId': 'RequestId',//'Request id received from generate token'

'tokenId' : 'TokenId',//'Token id received from generate token'

'productId' : '4130',

'merchantId' : '12511',

'baseUrl' : 'https://demo.idmission.com/apps/'

}

By default, all of the ID Types from various countries that IDmission accepts are made available to you through this Web SDK. If you want to limit the ID Types you accept, you can do so by limiting the selections within your initiating web application. The list of all supported ID types is available on the IDmission website. If you find that there is an ID Type that is not supported, please contact our support team to request one to be added.
< Go back to Service Selection
  • Capture ID Front
  • Capture ID Back
  • Selfie Capture
  • Voice Capture
  • Video Capture
  • Signature Capture
add_card
Capture ID Front
add_card
Capture ID Back
portrait
Selfie Capture
draw
Signature Capture
Capture Voice
ReCapture Voice
Capture Video
ReCapture Voice
Supported Configuration(s)
Supported Configuration(s)
Supported Configuration(s)
Supported Configuration(s)
Supported Configuration(s)
7. Live Face Detection This feature is used to detect live or spoof face and capture an image of the face. 7.1 Initiate Live Face Detection

WebSDK.initRealFace(configuration, getResponseCallback);

where, 7.1.1 configuration will be as follows:

configuration = {

'InitialMessage' : 'Look straight into the camera',

'FacemaskMessage' : 'Face mask Detected',

'EyeCoveringMessage' : 'Eye Covering Detected',

'CellPhoneMessage' : 'Cell Phone detected',

'HeadcoveringMessage' : 'Head covering detected',

'FaceNotFoundMessage' : 'Face Not Found',

'SelfiePreviewMessageFound' : 'Verify your eyes are open and there is no excessive light in the background.',

'FontforMessage' : 'N',

'FaceDetectedMessage' : 'Success',

'MaxTime': '25',

'AllowedTotalLiveFaceRequest': '1',

'maxNumberOfRetryForSelfie' : '5',

'MoveCenterMessage' : 'Move to center',

'MoveBackMessage' : 'Move Back',

'LiveFaceNotDetectedMsg' : 'Live face not detected, please try again',

'Position' : 'Top',

'notaligned' : 'FF3030',

'notalignedfont' : 'FFFFF',

'Initialtag' : '3FB900',

'Initialtagfont' : 'FFFFF',

'DetectedFaceOutlineColor' : '3FB900',

'RetryButtonColor' : '302222',

'ConfirmButtonColor' : '302222',

'SendDataToPFDModel' : 'N',

'EnableManualCapture' : 'N',

'EnableInstructionScreenFace' : 'Y',

'CheckLiveFace' : 'Y',

'CheckHeadCovering' : 'N',

'CheckEyeCovering' : 'N',

'CheckCellPhone' : 'N',

'DisableAutoCapture' : 'N',

'SkipSelfiepreview' : 'N',

'SupportStockCamera' : 'N',

'CaptureFullScreen' : 'N',

'FaceMaskCheckFlag' : 'N',

'InstructionScreenFaceMessage' : 'Remove Glasses & Hat
Avoid Excessive Backlighting',

'InstructionScreenFaceContinueMessage' : 'Continue',

'FaceTopId' : 'Move back message buffer (value-1)',

'Yaxisbuff' : 'Y axis buffer (value-50)',

}

Live Face Detection Parameters
Parameter Default Value Description
InitialMessage Initial Message Look straight into the camera
FacemaskMessage Facemask Message Face Mask Detected
EyeCoveringMessage Eye Covering Message Eye Covering Detected
CellPhoneMessage Cell Phone Message Cell Phone Detected
HeadCoveringMessage Head Covering Message Head Covering Detected
FaceNotFoundMessage Face Not Found Face Not Found
SelfiePreviewMessageFound Verify your eyes are open and there is no excessive light in the background. Header text after face detected successfully
FontForMessage N We can change font of SUCCESS Message.
FaceDetectedMessage Success Header text after face detected successfully
MaxTime 25 Enable Manual Capture Button.
AllowedTotalLiveFaceRequest 1 Number of successive real face check.
maxNumberOfRetryForSelfie 5 Max Number Of Retry For Selfie
MoveCenterMessage Move to center To ask user to move center of screen while detecting face
LiveFaceNotDetectedMsg LiveFace Not Detected Msg Live face not detected, please try again face
FaceTopId 1 Move back message buffer
Yaxisbuff 50 Y axis buffer
MoveBackMessage Move Back To ask user to move back from screen while detecting face
PositionOfTheInstructionLabel Top Position Of The Instruction Label can be changed as per user perspective. Top||Center||Bottom.
notaligned FF3030 Warning background color if face not found
notalignedfont FFFFF Warning Text color if face not found
Initialtag 3FB900 Initial message background color
Initialtagfont FFFFF Initial message text color
DetectedFaceOutlineColor 3FB900 This is colour of outline after detecting live face
RetryButtonColor 302222 This is the color of retry button.
ConfirmButtonColor 302222 This is the color of tick in confirm button.
SendDataToPFDModel N All captured selfies while doing Live (Passive) face Detection will be send to server to train PFD model
EnableManualCapture N If value of EnableManualCapture is 'N' then will not show take photo button after 10 sec. When EnableManualCapture is 'Y',Will show take photo button after 10 sec.
EnableInstructionScreenFace Y When EnableInstructionScreenFace is 'Y', Will show instruction screen to user. If value of EnableInstructionScreenFace is 'N' then will not show instruction screen.
CheckLiveFace Y When CheckLiveFace is 'Y', Will check Liveness Face screen to user. If value of CheckLiveFace is 'N' then will not check Liveness of Face.
CheckHeadCovering N If value of CheckHeadCovering is 'N' then will not check Head Covering. When CheckHeadCovering is 'Y', Will check Head Covering screen to user.
CheckEyeCovering N If value of CheckEyeCovering is 'N' then will not check Eye Covering. When CheckEyeCovering is 'Y', Will check Eye Covering screen to user.
CheckCellPhone N If value of CheckCellPhone is 'N' then will not check Cell Phone. When CheckCellPhone is 'Y', Will check Cell Phone screen to user.
FaceMaskCheckFlag N If value of FaceMaskCheck is 'N' then will not check Cell Phone. When FaceMaskCheck is 'Y', Will check Cell Phone screen to user.
DisableAutoCapture N If value of DisableAutoCapture is 'N' then will not show take photo button. When DisableAutoCapture is 'Y', Will show take photo button(direct camera open with take photo button).
SkipSelfiepreview N If value of SkipSelfiepreview is 'N' then will not show preview of selfie. When SkipSelfiepreview is 'Y', Will show preview of selfie(direct camera open with take photo button).
CaptureFullScreen N If value of CaptureFullScreen is 'N' then crop selfie image. When CaptureFullScreen is 'Y', Will show preview of selfie without cropped .
SupportStockCamera N If value of SupportStockCamera is 'Y' then it will open stock camera of device and captured photo will be used for Face else capture the photo from existing Face detection video frame.(Only for Mobile Device)
InstructionScreenFaceMessage Remove Glasses & Hat
Avoid Excessive Backlighting 		Instruction to be shown to user for capturing Live face
InstructionScreenFaceContinueMessage Continue Instruction button continue message
7.1.2 getResponseCallback

getResponseCallback(response){...}

is a callback function where response of Live Face Detection result will be returned. 7.2 Response of Live Face Detection 7.2.1 Response JSON on Success :

response = {

'Status' : 'SUCCESS',

'ImageData' : base64 of Real Face

'ImageType' : 'Face'

'FaceDetected' : 'Y'

}

7.2.2 Response JSON if Token has expired :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Token expired.'

}

7.2.3 Response JSON if Live Face not detected :

response = {

'Status' : 'SUCCESS',

'StatusMessage' : 'Live face not detected.'

'ImageType' : 'Face'

'FaceDetected' : 'N'

}

7.2.4 Response JSON When Network Issue or IDMS Server is not reachable :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Network Issue! Please try again.'

}

6. Auto ID Capture This feature is used to automatic detect IDs. 6.1 Initiate Auto ID Capture

WebSDK.initAutoIDDocCapture(configuration, getResponseCallback, idImageType);

where, 6.1.1 configuration will be as follows:

configuration = {

'HeaderTextLabelMessage' : 'Searching for ID',

'IdMaxTime' : '10',

'InitialMessageForId' : 'Please wait',

'IdNotFoundInstruction' : 'ID Not Found',

'AlignIdInsideRectangle' : 'Hold ID straight and steady',

'maxNumberOfRetryForID' : '5',

'IdCapturePreviewHeader' : 'Success',

'IdCapturePreviewMessage' : 'Verify the entire ID was captured clearly with no glare',

'EnableDebugMode' : 'N',

'positionID' : 'Top',

'IdCaptureType': 'PP',

'idNotFoundInstructiontag' : 'FF3030',

'idNotFoundInstructionfont' : 'FFFFF',

'alignIdInsideRectangletag' : '3FB900',

'alignIdInsideRectanglefont' : 'FFFFF',

'DetectedIdOutlineColor' : '3FB900',

'CanvasColor' : 'FFFFFF',

'IdOutlineColor' : 'FFAD36',

'ConfirmButtonColor' : '302222',

'RetryButtonColor' : '302222',

'EnableIDSpoofingAPI' : 'N',

'EnableInstructionScreen' : 'Y',

'EnableManualCapture' : 'N',

'AllowIDDesktopUpload' : 'Y',

'SupportStockCamera' : 'N',

'DisableAutoCapture' : 'N',

'SkipIDpreview' : 'N',

'InstructionScreenIDMessage' : 'Use your device camera to capture your ID',

'InstructionScreenIDContinueMessage' : 'Continue'

}

Auto ID capture Parameters
Parameter Default Value Description
HeaderTextLabelMessage Searching for ID This is text displayed on header while auto ID capture
IdMaxTime 10 Enable Manual Capture Button.
InitialMessageForId Please Wait Message when models are being loaded and compiled at background
IdNotFoundInstruction ID Not Found If ID is not detected while capturing
AlignIdInsideRectangle Hold ID straight and steady Message displayed when ID is capturing successfully.
maxNumberOfRetryForID 5 Max Number Of Retry For ID.
IdCapturePreviewHeader Success Header text after auto ID capture successfully
IdCapturePreviewMessage Verify the entire ID was captured clearly with no glare Help message text after auto ID capture successfully
IdCaptureType PP Set PP when capturing Passport or ID in case of ID document capture.
EnableDebugMode N Enable Debug Mode
PositionOfTheInstructionLabel Top Position Of The Instruction Label can be changed as per user perspective. Top||Center||Bottom.
idNotFoundInstructiontag FF3030 Id ID Not Found Instruction tag background color
idNotFoundInstructionfont FFFFF Id ID Not Found Instruction tag Text color
alignIdInsideRectangletag 3FB900 Align Id Inside Rectangle tag background color
alignIdInsideRectanglefont FFFFF Align Id Inside Rectangle tag text color
DetectedIdOutlineColor 3FB900 This is colour of outline after auto ID capture successfully
CanvasColor FFFFFF This is color of modal
IdOutlineColor FFAD36 This is colour of outline while auto ID capture
ConfirmButtonColor 302222 This is the color of tick in confirm button.
RetryButtonColor 302222 This is the color of retry button.
EnableIDSpoofingAPI N If value of EnableIDSpoofingAPI is 'N' then authenticity of ID is detected at client side. When EnableIDSpoofingAPI is 'Y'. Server side API for detecting Real or Spoof ID is used. It's result will be returned in 'IDDetected' response parameter. IDDetected will be 'Y' if Real ID is detected and IDDetected will be 'N' if photocopy or screen is detected.
EnableInstructionScreen Y When EnableInstructionScreen is 'Y',Will show instruction screen to user.If value of EnableInstructionScreen is 'N' then will not show instruction screen.
EnableManualCapture N If value of EnableManualCapture is 'N' then will not show take photo button after 10 sec. When EnableManualCapture is 'Y',Will show take photo button after 10 sec.
AllowIDDesktopUpload Y If value of AllowIDDesktopUpload is 'N' then will show auto ID capture . When AllowIDDesktopUpload is 'Y',Will show upload ID option.
SupportStockCamera N If value of SupportStockCamera is 'Y' then it will open stock camera of device and captured photo will be used for ID else capture the photo from existing ID detection video frame.
SkipIDpreview N If value of SkipIDpreview is 'Y' then will not show ID preview page. When SkipIDpreview is 'N', Will show It will show ID preview page
DisableAutoCapture N If value of DisableAutoCapture is 'N' then will upload ID from your device. When DisableAutoCapture is 'Y', Will show Use your device camera to capture your ID Page click on continue button. Then Will show direct camera open with take photo button.
InstructionScreenIDMessage Use your device camera to capture your ID Instruction to be shown to user for capturing ID
InstructionScreenIDContinueMessage Continue Instruction button continue message
6.1.2 getResponseCallback

getResponseCallback(response){...}

is a callback function where response of Auto ID Capture result will be returned. 6.1.3 idImageType 'idImageType' specifies the type of ID capture such as 'IDFront' and 'IDBack'. 6.2 Response of Auto ID Capture 6.2.1 Response JSON When Real ID is detected :

response = {

'Status' : 'SUCCESS',

'ImageData' : base64 of ID image,

'ImageType' : 'IDFront' or 'IDBack',

'IDDetected' : 'Y'

}

6.2.2 Response JSON if Token has expired :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Token expired.'

}

6.2.3 Response JSON When Spoof ID is detected :

response = {

'Status' : 'SUCCESS',

'StatusMessage' : 'Real ID not detected.',

'ImageType' : 'IDFront' or 'IDBack',

'IDDetected' : 'N'

}

6.2.4 Response JSON When Network Issue or IDMS Server is not reachable :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Network Issue! Please try again.'

}

Signeture capture Parameters
Parameter Default Value Description
CanvasColor FFFFFF This is color of modal
ClearButtonColor 000000 This is the color of retry button.
ConfirmButtonColor 000000 This is the color of tick in confirm button.
TokenId * It will be same as token received after token generation
RequestId * It will be same as used for generating token
BaseUrl * It will be same as url used for generating token
8. Voice Capture This feature is used to capture Voice. 8.1 Initiate Voice Capture

WebSDK.initVoiceCapture(configuration, getResponseCallback);

where, 8.1.1 configuration will be as follows:

configuration = {

'CanvasColor' : 'FFFFFF',

'VoiceRecordingTime' : '15',

'InitialMessageForVoice' : 'Click Button to Start Recording',

'SuccessMessageForVoice' : 'Recording Completed Successfully',

'SuccessMessageColorForVoice' : '3FB900'

}

Voice capture Parameters
Parameter Default Value Description
CanvasColor FFFFFF This is color of modal
VoiceRecordingTime 15 This is time limit of voice recording
InitialMessageForVoice Click Button to Start Recording This is initial message of voice recording
SuccessMessageForVoice Recording Completed Successfully This is success message of voice recording
SuccessMessageColorForVoice 3FB900 This is colour of message after voice recording
8.1.2 getResponseCallback

getResponseCallback(response){...}

is a callback function where response of Voice capture result will be returned. 8.2 Response of Voice Capture 8.2.1 Response JSON When Voice Captured :

response = {

'Status' : 'SUCCESS',

'VoiceData' : base64 of Voice recorded,

'StatusMessage' : 'Voice recorded successfully.',

'ImageType' : 'Voice'

}

8.2.2 Response JSON if Token has expired :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Token expired.'

}

8.2.3 Response JSON When Network Issue or IDMS Server is not reachable :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Network Issue! Please try again.'

}

11.Signature Capture This feature is used to get Signature. 11.1 Initiate Signature

WebSDK.initSignatureCapture(config, signCallBackFunction);

where, 11.1.1 configuration will be as follows:

configuration = {

'RetryButtonColor' : '302222',

'ConfirmButtonColor' : '302222',

'CanvasColor' : 'FFFFFF',

}

Signature Capture Parameters
Parameter Default Value Description
CanvasColor FFFFFF This is color of modal
RetryButtonColor 302222 This is the color of retry button.
ConfirmButtonColor 302222 This is the color of tick in confirm button.
Click to know Signature parameters description 11.1.2 getResponseCallback

getResponseCallback(response){...}

is a callback function where response of Signature Capture result will be returned. 11.2 Response of Signature Capture 11.2.1 Response JSON When Real ID is detected :

response = {

'Status' : 'SUCCESS',

'ImageData' : base64 of Signature image,

}

11.2.2 Response JSON if Token has expired :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Token expired.'

}

11.2.3 Response JSON When Network Issue or IDMS Server is not reachable :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Network Issue! Please try again.'

}

10. Video Capture This feature is used to capture Video. 10.1 Initiate Video Capture

WebSDK.initVideoCapture(configuration, getResponseCallback);

where, 10.1.1 configuration will be as follows:

configuration = {

'CanvasColor' : 'FFFFFF',

'VideoRecordingTime' : '15',

'MinVideoRecordingTime' : '7',

'InitialMessageForVideo' : 'Click Button to Start Recording',

'SuccessMessageForVideo' : 'Recording Completed Successfully',

'SuccessMessageColorForVideo' : '3FB900'

}

Video capture Parameters
Parameter Default Value Description
CanvasColor FFFFFF This is color of modal
VideoRecordingTime 15 This is time limit of video recording
MinVideoRecordingTime 7 This is time limit minimum of video recording
InitialMessageForVideo Click Button to Start Recording This is initial message of video recording
SuccessMessageForVideo Recording Completed Successfully This is success message of video recording
SuccessMessageColorForVideo 3FB900 This is colour of message after video recording
10.1.2 getResponseCallback

getResponseCallback(response){...}

is a callback function where response of Video capture result will be returned. 10.2 Response of Video Capture 10.2.1 Response JSON When Video Captured :

response = {

'Status' : 'SUCCESS',

'VideoData' : base64 of Video recorded,

'StatusMessage' : 'Video captured successfully.',

'ImageType' : 'Video'

}

10.2.2 Response JSON if Token has expired :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Token expired.'

}

10.2.3 Response JSON When Network Issue or IDMS Server is not reachable :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Network Issue! Please try again.'

}

9. Configuration required for Submitting Data 9.1 Initiate Final Submission of Data

WebSDK.submitData(configuration, getResponseCallback);

where, 9.1.1 configuration will be as follows: Additional Optional Final Submit configuration will be as follows:

configuration = {

'manualReviewRequired' : 'N',

'bypassAgeValidation' : 'N',

'postDataAPIRequired' : 'N',

'sendInputImagesInPost' : 'N',

'dedupSynchronous' : 'N',

'idBackImageRequired' : 'N',

'dedupManualReviewRequired' : 'N',

'dedupRequired' : 'N',

'deDupDataRequiredInResponse' : 'N',

'bypassNameMathing' : 'N',

'needImmediateResponse' : 'N',//We have a quick response for a form goes in Async manner set 'Y', Process Async call (Immediate Response)

'sendProcessedImagesInPost' : 'N',

'verifyDataWithHost' : 'N',

'stripSpecialCharacters' : 'N',

'SendDataToPFDModel' : 'N',

}

Final Data Submit Parameters
Service Name Required JSON
Validate-id-match-face configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'idType' : Selected ID type value, 'idCountry' : Selected ID country value, 'idState' : Selected ID state value }
Validate-id configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'idType' : Selected ID type value, 'idCountry' : Selected ID country value, 'idState' : Selected ID state value }
Enroll configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service name to be use, 'idType' : Selected ID type value, 'idCountry' : Selected ID country value, 'idState' : Selected ID state value, 'uniqueCustomerNumber' : Unique customer enrollment number }
Verify configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'uniqueCustomerNumber' : Unique customer enrollment number }
Enroll-from-Video configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'idType' : Selected ID type value, 'idCountry' : Selected ID country value, 'idState' : Selected ID state value, 'employeeCode' : Employee Code }
Enroll-biometrics configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'employeeCode' : Employee Code }
Live-check configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'liveFaceDetected' : Live face result 'Y' or 'N' }
identify configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, }
9.1.2 getResponseCallback

getResponseCallback(response){...}

is a callback function where response of final form submit will be returned. 9.2 Response of Final Submission of Data 9.2.1 Response JSON on Success :

response = {

'enableswagger' : "String" (set to "Y" if want to use swagger API call)

'Status' : JSON of form status

'FormDetails' : JSON of form fields data

}

Click to know Final Submission of Response JSON on Success description 9.2.2 Response JSON When Network Issue or IDMS Server is not reachable :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Network Issue! Please try again.'

}

Form State Returns and State Codes
Field Name Form Status Description Recommended Actions
00 Approved
  • All checks in our system have passed
  • Data was extracted with the level of accuracy within our defined thresholds based on image quality.
  • No action required
  • ID is approved
50 Barcode Unreadable A barcode is expected to be present, but the barcode data is not detected by IDmission. The application using this API should prompt the user to recapture the images where the barcode is present in better lighting without glare so the ID can be processed properly.
32 biometrics Match Fail If the user's biometrics data (face, voice, and/or fingerprint) captured does not match the biometrics data in the database from a previously enrolled user. The application using this SDK/API should prompt the user to recapture their biometrics information, ensuring that face, fingerprint, and voice can be captured with clarity and accuracy.
46 Customer Found If the customer biometrics data (face, voice, and/or fingerprint) has matched the biometrics data in the database of a previous enrollment.
  • No action required
  • Customer verification is approved.
44 Customer Not Found If the customer biometrics data (face, voice, and/or fingerprint) does not match the biometrics data in the database from a previously enrolled user. The application using this SDK/API should prompt the user to recapture their biometrics information. The capture should be completed in a well-lit room with the customer biometrics fully visible.
34 Customer Onboarded
  • All validation and security checks in our system have passed.
  • The customer was successfully enrolled in the database.
  • No action required.
  • Customer enrollment is approved.
37 Customer Onboarding Failed
  • The customer ID documents and/or biometrics have failed one or more validation checks in our system.
  • The customer was not enrolled into the database.
  • The application using this SDK/API should prompt the user to reattempt enrollment.
  • When reattempting to enroll, the recapture should be completed in a well-lit room with the ID documents and biometrics fully visible.
  • The customer failed to enroll.
39 Customer Updated If the capture of customer data has updated a previously enrolled customer record.
  • No action required
  • Customer data is successfully updated.
35 Duplicate Customer The biometrics data provided by the customer for a new enrollment has matched to a previously enrolled user.
  • The application using the SDK should request the user to use the original unique customer identifier that was used during enrollment.
  • If not, the application using the SDK should delete the previous record and prompt the user to reattempt enrollment.
36 Duplicate Employee The biometrics data provided by the employee for a new enrollment has matched to biometrics data from a previous enrollment.
  • The application using the SDK should request the user to use the original unique employee identifier that was used during enrollment.
  • If not, the application using the SDK should delete the previous record and prompt the user to reattempt enrollment.
47 Employee Found If the customer biometrics data (face, voice, and/or fingerprint) has matched the biometrics data in the database of a previous enrollment.
  • No action required.
  • Customer verification is approved
45 Employee Not Found If the customer biometrics data (face, voice, and/or fingerprint) does not match the biometrics data in the database from a previously enrolled user. The application using this SDK/API should prompt the user to recapture their biometrics information. The capture should be completed in a well-lit room with the customer biometrics fully visible.
33 Employee Onboarded
  • All validation and security checks in our system have passed.
  • The employee was successfully enrolled in the database.
  • No action required.
  • Employee enrollment is approved.
38 Employee Onboarding Failed
  • The employee ID documents and/or biometrics data have failed one or more validation checks in our system.
  • The employee was not enrolled into the database.
  • The application using this SDK/API should prompt the user to reattempt enrollment.
  • When reattempting to enroll, the recapture should be completed in a well-lit room with the ID documents and biometrics fully visible.
  • The employee failed to enroll.
41 Employee Updated If the capture of employee data has updated a previously enrolled customer record.
  • No action required
  • Employee data is successfully updated.
40 Expired ID The expiration date on the ID is equal to or less than the current date. The application using this API should prompt the user to provide an ID with a valid expiration date.
31 Face Not Detected
  • A face is not detected on an image.
  • Typically, this occurs when the face is not present on the ID.
  • In some cases, is due to poor image quality or image glare.
 The application using this API should prompt the user to provide a clear image of an ID that includes a photo.
30 Facial biometrics Match Failed If a customer photo is captured and does not biometrically match the photo in the ID document, the ability to review the images is in the back office. The application using this API should prompt the user to capture a new selfie image.
10 ID Back Image not found
  • The back of an ID is expected to be present.
  • The back image was not sent or
  • A blank image was provided.
 The application using this API should prompt the user to provide a clear image of the back of the ID.
52 ID Face Not Found
  • When conducting facial biometrics verification, no face is found on submitted ID to match with selfie.
  • Accordingly, facial biometrics verification cannot be validated with the submitted ID
 The application using this SDK/API should prompt the user to provide a clear ID with a clear face image to ensure that facial biometrics verification can be completed.
60 ID Front and Back Mismatch If the data extracted from the back of the ID image does not belong to the data presented on the front of the ID image.

The application using the API should prompt the user to provide new front and back images because inconsistences were found.

Note: If this occurs more than once, the application could decide to push this to a manual review queue because it could be an issue with OCR extraction accuracy.
11 ID Front Image Not Found The front of an ID is not uploaded, or a blank image was provided. The application using this API should prompt the user to provide a clear image of the front of the ID.
61 ID Not Accepted The uploaded ID contains an invalid configuration for the selected country.

The application using this API should prompt the user to provide an ID that is in the list of accepted ID Types.

Note: The application should prompt the user to select an ID type from a dropdown list, which reduces the likeliness of this result.
62 ID Type Mismatch If the ID Type submitted doesn't match the ID Type extracted from the ID Image. The application using this API should prompt the user to select the ID Type that matches the Type of ID that was uploaded/captured.
51 IDNumber Match Failed The ID Number that was extracted by OCR from the ID does not match the ID Number that was extracted from the MRZ or Barcode. The application using this SDK/API should prompt the user to retry ID Validation.
63 Invalid ID Number The ID Number on the ID does not match the pattern defined in the ID Template. The application using this API should prompt the user to provide a valid ID.
12 Key Component Not Visible If one of the key components on the ID such as the date of birth or expiration date is missing. The application using this SDK should prompt the user that: The ID they have provided is not valid or the image provided may be blurred or unreadable in some portions or to recapture or capture an image of a different ID.
13 Low Resolution
  • The front or back image that is uploaded has been detected as low resolution or
  • The ID image is not a color/grayscale image based on resolution thresholds defined by IDmission.
 The application using this API should prompt the user to recapture the images in better lighting without glare so the ID can be processed properly.
48 Live Face Detected If our system detects a live face from the selfie.
  • No action required.
  • Live face detection was approved.
49 Live Face Not Detected If our system does not detect a live face from the selfie image (e.g., if the selfie image is a photo of a photo, if the selfie image is a screen capture of a face, etc.) The application using the SDK should prompt the user to retake the selfie ensuring that a live face is captured in good lighting.
64 MRZ and ID Data Mismatch If the data extracted from the MRZ does not match the data extracted from the ID image itself.

The application using the API should prompt the user to provide new image(s) because inconsistences were found.

Note: If this occurs more than once, the application could decide to push this to a manual review queue because it could be an issue with OCR extraction accuracy.
65 MRZ Invalid The MRZ Validation flag (Machine Readable Zone) results in determining that the MRZ Data was not correct according to the standards. The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID.
66 Name Match Failed If the name submitted for the Customer or the Employee doesn't meet the matching thresholds against the name extracted from the ID Document. The application using this API should prompt the user to provide a valid ID as this was deemed invalid.
14 No Image Found The ID front and back images are black or white and missing an ID Image. The application using this API should prompt the user to recapture the images in better lighting without glare so the ID can be processed properly.
N/A Pending Review Initial state of the form. System checks are still pending. No action required. Final results are sent via the POST API
53 Real ID Detected If our system detects a real ID from the ID image.
  • No action required.
  • Real ID Detection was approved.
54 Real ID Not Detected If our system does not detect a real ID from the ID image (e.g., if the ID image is a photocopy, if the ID image is a screen capture of an ID, etc.) The application using the SDK should prompt the user to retake the ID image ensuring that a real ID is captured in good lighting.
67 Sample ID If an ID has been confirmed as a sample after manual review. The application using this API should prompt the user that: The ID they have provided is not valid and to capture a different ID image.
68 Security Feature Invalid One or more security features defined for the ID template are a mismatch with the provided image. The application using this API should prompt the user to recapture the ID or a different one.
01 Submitted If it is an asynchronous call via the API, the ID is awaiting process completion to be categorized into a form state.
  • No action required.
OR
  • If the call is asynchronous, the application using this SDK/API should get-process-data.
69 Suspected Sample An ID has been detected as a sample (logic has been configured to recognize sample ID numbers, names, watermarks and other suspected sample data.) The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID.
70 Suspected Tampering
  • Photo editing software (e.g. Microsoft Paint, Adobe Photoshop) was detected.
  • Dates have been falsely created or modified in the ID document image.
 The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID.
73 Suspicious ID
  • If an ID is found to be suspicious based on IDmission's AI logic.
 The application using this API should prompt the user that the ID they have provided is not valid and to capture an image of a different ID.
71 Tampered ID An ID has been confirmed to be tampered with after manual review. The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID.
15 Template Not Found

The correct template cannot be matched against those configured for the client.

Note: The system will not find a template to associate with the image for correct data extraction and validation.

 The application using the API should prompt the user to capture a different ID.
80 Third Party Verification Failed If an ID has not been successfully verified by a third party.
  • The application using this SDK/API should prompt the user that the ID they have provided is not valid and to capture an image of a different ID.
  • If the user thinks it is an error, they can retry.
72 Under the age of 18

The date of birth (extracted from the barcode / MRZ) calculates the individual as under the age of 18.

 The date of birth indicates that the user is under the age of 18

Note: The API can determine if this was already indicated in the application. If it was not indicated, the API should prompt for correct ID.
Final Submission of Response JSON on Success description
Field Name Field Type Response Description
IDType Text In most cases, this is an echo back from the request, unless it was updated by the ID Verification Team because it was incorrect.
IDState Text In most cases, this is an echo back from the request, unless it was added/updated by the ID Verification Team because it was not provided or incorrect.
Name Text Full Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
Name_Doc Text Full Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
FirstName Text First Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
FirstName_doc Text First Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
MiddleName Text Middle Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
LastName Text Last Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present
LastName_doc Text Last Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present
LastName2 Text If there is a secondary last name, it will display as extracted from either the barcode, MRZ, or front of the ID when MRZ/barcode are not present.
Address Text Full Address extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
Address1 Text Address Line 1 (usually the Street Number and Street Name) extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not presen.
Address2 Text Address Line 2 (e.g. Suite Number, Unit) extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
Country Text City parsed from a barcode or MRZ, only when a one is present. In most cases the address will be in AddressLine1 / 2.
IDNumber Text ID Number extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
IDNumber1 Text Additional IDNumber 1, extracted from barcode/MRZ data, or if neither are present, from the front of the ID. This will only be present if this additional ID Number component is defined in the matching ID template.
IDNumber2 Text Additional IDNumber 2, extracted from barcode/MRZ data, or if neither are present, from the front of the ID. This will only be present if this additional ID Number 2 component is defined in the matching ID template.
IDNumber3 Text Additional IDNumber 3, extracted from barcode/MRZ data, or if neither are present, from the front of the ID. This will only be present if this additional ID Number 3 component is defined in the matching ID template.
IDNumber_FirstSix Text Additional IDNumber First Six digit, extracted from barcode/MRZ data, or if neither are present, from the front of the ID. This will only be present if this additional ID Number component is defined in the matching ID template.
IDNumber_Doc_Expected Text Additional IDNumber as per Document:'Y', extracted from barcode/MRZ data, or if neither are present, from the front of the ID. This will only be present if this additional ID Number component is defined in the matching ID template.
IDNumber_Doc Text ID Number extracted from Document: 'Y' either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
ValidIDNumber Text

Flag that indicates of the format of the ID number matches what is defined in the matching ID template.

- Flag = Y if the ID Number extracts correctly and matches the format.

- Flag = N if the ID Number does not match the format.

- Flag = NA If there is no specific format defined

- Flag = D if it cannot be clearly determined (D = Doubtful)
DateofBirth Text Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. This is the text that is extracted directly, not always a formatted date.
Date_of_Birth_Formatted Date

Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. If the date cannot be formatted based on extraction (e.g. Odd format, not present in the MRZ and not corrected by manual review) then this field would be blank.

Format: DD/MM/YYYY
DateofBirth_Doc_Expected Date

As per Document Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. If the date cannot be formatted based on extraction (e.g. Odd format, not present in the MRZ and not corrected by manual review) then this field would be blank.

Format: DD/MM/YYYY
IDExpirationDate Text Expiration Date extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. This is the text that is extracted directly, not always a formatted date.
IdExpirationDateFormatted Date

Expiration Date extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. If the date cannot be formatted based on extraction (e.g. Odd format, not present in the MRZ and not corrected by manual review) then this field would be blank.

Format: DD/MM/YYYY
ExpiryDate_Doc_Expected Date

Expiration Date expected from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. If the date cannot be formatted based on extraction (e.g. Odd format, not present in the MRZ and not corrected by manual review) then this field would be blank.

Format: DD/MM/YYYY
IdIssueDate Text Issue Date extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. In most cases this is not present in a machine-readable portion of the ID, so we often see many variations of formats. This will be sent as a Text field.
IdIssueCountry Text This is the 3-digit ISO country code in which the identity document was issued, either extracted from the barcode/MRZ or as defined in the template.
Face_Detected Text This flag indicates whether or not a clear/visible face is found on the identity document. If a 'Photo' component is captured for the specific ID template matched, and a face is clearly detected, this flag will = Y. If a face is expected and is NOT clearly detected, this flag will = N. If there is no 'Photo' component captured for the template, this flag will be blank.
Face_Expected Text This flag indicates whether or not a clear/visible face is found on the identity document. If a 'Photo' component is captured for the specific ID template matched, and a face is clearly detected, this flag will = Y. If a face is expected and is NOT clearly detected, this flag will = N. If there is no 'Photo' component captured for the template, this flag will be blank.
EnoughFeatureFound Text Enough Feature Found:'Y'
EnoughFeatureFoundOnID_FRONT Text Enough Feature Found On ID_FRONT :'Y'
MatchingTemplateFound Text Matching Template Found :'Y'
MatchingTemplateId Text
NoTemplatesAvailable Text No Templates Available :'N'
MRZData Text This is the raw data extracted from the MRZ. There is a parsing tool (in the back-office portal) where you can copy and paste the extracted MRZ string, compare it to the image, and correct any errors that may have resulted during OCR. This way you can determine the validity of the MRZ without having to ask the customer to resubmit their identity documents.
MRZValid Text This flag indicates the validity of the MRZ data, this will = Y if it is valid (passes all of the check digits), otherwise this will = N. When flag = N, there are usually MRZ Error Messages associated with. When there is not an MRZ detected (MRZ Detected = N), this flag will be blank. NA when there is a template matched, but no MRZ expected.
ID_BACK_FOUND Text This field is ID BACK FOUND:'Y'/'N'
ID_FRONT_FOUND Text This field is ID FRONT FOUND:'Y'/'N'
IDBackImageExpected Text This field is ID Back Image Expected:'Y'/'N'
Nationality Text This field contains the Nationality associated with the ID submitted as part of the original request.
FaceVerificationResult Text This is the result of the Face Match 'Verified' or 'Not Verified' will be the values. A verified face must have a score that equates to a 62% or higher match.
ManualReviewExecuted Text If a request was submitted with the 'Manual_Review_Required' parameter = Y, and a manual review was actually executed, this field will = Y. If not, it will = N or Blank.
NameNonEng Text This field is extracted from the front or back of the ID
FirstNameNonEng Text This field is extracted from the front or back of the ID
LastNameNonEng Text This field is extracted from the front or back of the ID
MiddleNameNonEng Text This field is extracted from the front or back of the ID
LastName2 Text

This field is extracted from:

- The barcode or MRZ (if present)

- The front or back of the ID, if both the MRZ and barcode are not present.
AddressNonEng Text This field is extracted from the front or back of the ID
AddressLine1NonEng Text This field is extracted from the front or back of the ID
AddressLine2NonEng Text This field is extracted from the front or back of the ID
IDNumberNonEng Text This field is extracted from the front or back of the ID
IDNumber2NonEng Text This field is extracted from the front or back of the ID
IdDateofBirthNonEng Text This field is extracted from the front or back of the ID
ExpiryDateNonEng Text This field is extracted from the front or back of the ID
IdIssueDateNonEng Text This field is extracted from the front or back of the ID
Gender Text

This field is extracted from:

- The barcode or MRZ

- The front or back of the ID, if both the MRZ and barcode are not present.
uniqueNumber Text This field is an echo back from what is submitted in the request. This is not extracted from the ID or generated by IDmission. It is for the client to use to define a unique number associated with their customer.
API_resultCount_NM Text This field returns a count of matches found using the customer or employee name against a Negative Media database.
API_resultCount_PEP Text This field returns a count of matches found using the customer or employee name against Politically Exposed Persons (PEPs) lists.
API_resultCount_WLS Text This field returns a count of matches found using the customer or employee name against Global watchlists.
Client_Customer_Number Text This field contains the unique client customer number associated with the customer record from the original enrollment. This is also used for ongoing verification.
AddressLine1 Text This field contains Address Line 1 for the customer that was submitted as part of the request.
AddressLine2 Text This field contains Address Line 2 for the customer that was submitted as part of the request.
City Text This field contains the city for the customer that was submitted as part of the request.
Country Text This field contains the country code or country name for the customer that was submitted as part of the request.
IdDateOfBirth Text This field contains the date of birth for the customer that was submitted as part of the request.
District Text This field contains the district for the customer that was submitted as part of the request.
Email Text This field contains the email address for the customer that was submitted as part of the request.
Enrolled_Date Date This field indicates the date the customer was enrolled. Format: YYYY-MM-DD
FP_Data Image BLOB This field returns the fingerprint data associated with the original enrollment of the Customer that a verification submission is verified against.
Gender Text This field contains the gender code that was submitted as part of the request.
CustomerName Text This field contains the Customer Name that was submitted as part of the request or the name that was extracted from the ID document if present.
PhoneNumber Text This field contains the phone number for the customer that was submitted as part of the request.
Customer_Search_Status Text This field returns the status of the search results for the Customer based on the biometrics data that was sent. The valid values are "SUCCESS" and "FAIL".
SignatureData Image BLOB This is an image of the customer's signature that can be optionally collected during any service where customer data is supported.
verificationResult Text This field returns the results of the Verify Customer request. The valid values are "Verified" and "Verification Failed".
CustomerCode Text This field contains the Customer Code that is auto-generated by the IDmission system during the enrollment process.
CustomerStatus Text This field is used for Customer Enrollment processing. This field indicates if a customer has been found and returns the current status of that customer. The field can return "SUCCESS" or "FAILED".
CustomerVerification_Status Text This field indicates the current status of the customer in the IDmission database. The field can return "Verified" or "Unverified".
deDuplicationRequired Text The field indicates the overall status of Deduplication processing. This field can return "SUCCESS" or "FAIL".
deDupDataRequiredInResponse Text The field indicates the overall status of Deduplication processing data. This field can return deduplication data in Response. This field need to use with deDuplicationRequired flag
Employee_AddresLine1 Text This field contains Address Line 1 for the employee that was submitted as part of the request.
Employee_AddresLine2 Text This field contains Address Line 2 for the employee that was submitted as part of the request.
Employee_City Text This field contains the city associated with the address of the employee submitted as part of the request.
EMPLOYEE_CODE Text This field contains the employee code submitted as part of the request.
Employee_Country Text This field contains the country associated with the address for the employee submitted as part of the request.
Employee_Email Text This field contains the email associated with the employee submitted as part of the request.
Employee_Gender Text This field contains the gender code that was submitted as part of the request.
Employee_ID Text The field contains the employee ID that was provided during the employee enrollment process as part of the request.
Employee_ID_State Text This field contains the State associated with the ID of the employee submitted as part of the original request.
Employee_LoginID Text This field contains the employee Login ID that was submitted as part of the request.
EmployeeName Text This field contains the name of the employee submitted as part of the request.
EmployeePhone Text This field contains the phone number associated with the employee submitted as part of the request.
EmployeePostalCode Text This field contains the postal/zip code associated with the address for the employee submitted as part of the request.
EmployeeType Text This field contains the type of employee that was specified during the employee enrollment process, as part of the request.
EmployeeverificationResult Text This field returns the results of the Verify Employee request. The valid values are "Verified" and "Verification Failed".
EmployeeCreateStatus Text This field indicates whether or not the Employee enrollment was successful. The field can return "SUCCESS" or "FAILED".
EmployeeCreateStatusMessage Text This field is the message that is returned based on the employee enrollment processing. For example, "Employee already exists" or "User does not have required privileges."
EmployeeID Text This field is the employee ID provided during any employee enrollment services.
EmployeeSignature Image BLOB This field contains a signature image captured during the original employee enrollment.
EmployeeVerification_Status Text This field indicates the current status of the employee in the IDmission database. The field can return "Verified" or "Unverified".
ENROLLED_FACE_IMAGE Image BLOB This field returns the photograph associated with the original enrollment of the Customer or Employee that a verification submission is verified against.
FullName Text This field is the full name of the customer, with the First,Middle, and Last names combined into one field.
HOST_URL Text This field is the URL that is provided to IDmission to return the POST API to.
ID_Number_Match_Result Text This field indicates if the ID Number that was extracted from the ID matches the ID Number that was read from the MRZ or Barcode when applicable.
Name_Match_Result Text This field returns the result of the name submitted in request matches the name extracted from the ID during processing.
serviceName Text This is an echo back of the serviceName sent in the request for the SDK, or utilized when using the Swagger API. The serviceName is associated with the service being performed (e.g., ID Validation, Customer Enrollment, Verification, etc.)
CompanyCode Text This is an echo back of the CompanyCode submitted in the original request that the form is processed under.
CustomerIDExpiryDate Date This is the expiration date from an ID document that has been enrolled for a customer. This will be provided back based on input parameters in the Verification requests. Format: dd/mm/yyyy.
DocumentType Text This is ID Type that is determined based on the template it was matched against. This will be the same list of values are in the input ID Type.
PlaceOfBirth Text This is a text-based field that will contain the place of birth if specified on the ID. (Currently only available for Italy IDs)
PlaceofIssue Text This is a text-based field that will contain the place in which the ID was issued if specified on the ID. (Currently only available for Italy IDs)
IssuingAuthority Text This is a text-based field that will contain the issuing authority of the ID. This will only be present if this is a text-based field on the ID, it will not be extracted from a stamp. (Currently only available for Italy IDs)
IssuingCountry Text This is a text-based field that will contain the issuing Country of the ID.
OCR_Signature Image BLOB This field is the signature that is extracted from the ID
PostalCode Text This field contains postal code for the customer that was submitted as part of the request.
Image_ProcessedFront Image BLOB This image is the processed version of the front image from the server after ID validation processing is completed. It will be cropped and de-skewed and have security features highlighted.
Image_ProcessedBack Image BLOB This image is the processed version of the back image from the server after ID validation processing is completed. It will be cropped and de-skewed and have security features highlighted.
Image_Front Image BLOB This image is the front image provided by the client.
Image_Back Image BLOB This image is the back image provided by the client.
MatchedTemplateCode Text Matched Template Code
TemplateFoundUsingFilter Text Template Found Using Filter
Customer_Photo Image BLOB This image is the live selfie image provided by the client.
Form_State_Code Single Select

This is the two-digit code associated with the Form_Status.

For a full list of values, please refer to the Form Status and State Codes Section of this document.
Verification_Approval_Code Text 4 digit verification code when biometrics verification is done through the IDentity as a Service (IDaaS) Web Application.
Result
Data Capture
8. Configuration required for Submitting Data 8.1 Initiate Final Submission of Data

WebSDK.submitData(configuration, getResponseCallback);

where,
8.1.1 configuration will be as follows:

configuration = {

'uniqueCustomerNumber' :'Enter Unique customer enrollment number',

'CustomerName' :'Enter Customer Enrollment Name',

'CustomerPhone' :'Enter Customer Enrollment Phone Number',

'CustomerEmail' :'Enter Customer Enrollment Email Address',

}

8.1.1 configuration will be as follows:

configuration = {

'EmployeeCode' :'Enter Employee Enrollment Code',

'EmployeeName' :'Enter Employee Enrollment Name',

'EmployeeType' :'Enter Employee Enrollment Type',

}

8.1.1 configuration will be as follows:

configuration = {

'uniqueCustomerNumber' :'Enter Unique customer enrollment number',

'CustomerName' :'Enter Customer Enrollment Name',

'CustomerPhone' :'Enter Customer Enrollment Phone Number',

'CustomerEmail' :'Enter Customer Enrollment Email Address',

'PreviousFormKey' :'Enter Customer Enrollment Previous Form Key',

}

Additional Optional Final Submit configuration will be as follows:

configuration = {

'manualReviewRequired' : 'N',

'bypassAgeValidation' : 'N',

'postDataAPIRequired' : 'N',

'sendInputImagesInPost' : 'N',

'dedupSynchronous' : 'N',

'idBackImageRequired' : 'N',

'dedupManualReviewRequired' : 'N',

'dedupRequired' : 'N',

'deDupDataRequiredInResponse' : 'N',

'bypassNameMathing' : 'N',

'needImmediateResponse' : 'N',//We have a quick response for a form goes in Async manner set 'Y', Process Async call (Immediate Response)

'sendProcessedImagesInPost' : 'N',

'verifyDataWithHost' : 'N',

'stripSpecialCharacters' : 'N',

'SendDataToPFDModel' : 'N',

}

Final Data Submit Parameters
Service Name Required JSON
Validate-id-match-face configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'idType' : Selected ID type value, 'idCountry' : Selected ID country value, 'idState' : Selected ID state value }
Validate-id configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'idType' : Selected ID type value, 'idCountry' : Selected ID country value, 'idState' : Selected ID state value }
Enroll configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'idType' : Selected ID type value, 'idCountry' : Selected ID country value, 'idState' : Selected ID state value, 'uniqueCustomerNumber' : Unique customer enrollment number }
Verify configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'uniqueCustomerNumber' : Unique customer enrollment number }
Enroll-from-Video configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'idType' : Selected ID type value, 'idCountry' : Selected ID country value, 'idState' : Selected ID state value, 'employeeCode' : Employee Code }
Enroll-biometrics configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'idType' : Selected ID type value, 'idCountry' : Selected ID country value, 'idState' : Selected ID state value, 'employeeCode' : Employee Code }
Live-check configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use, 'liveFaceDetected' : Live face result 'Y' or 'N' }
identify configuration = { 'baseUrl': IDmission Apps URL, 'merchantId' : Your Merchant ID, 'productId' : Your Product ID, 'tokenId' : Token id received from generate token, 'requestId' : Any string value to generate token, 'serviceName' : Service Name to be use }
8.1.2 getResponseCallback

getResponseCallback(response){...}

is a callback function where response of final form submit will be returned. 8.2 Response of Final Submission of Data 8.2.1 Response JSON on Success :

response = {

'Status' : JSON of form status

'FormDetails' : JSON of form fields data

}

Click to know Final Submission of Response JSON on Success description 8.2.2 Response JSON When Network Issue or IDMS Server is not reachable :

response = {

'Status' : 'FAIL',

'StatusMessage' : 'Network Issue! Please try again.'

}

Form State Returns and State Codes
Field Name Form Status Description Recommended Actions
00 Approved
  • All checks in our system have passed
  • Data was extracted with the level of accuracy within our defined thresholds based on image quality.
  • No action required
  • ID is approved
50 Barcode Unreadable A barcode is expected to be present, but the barcode data is not detected by IDmission. The application using this API should prompt the user to recapture the images where the barcode is present in better lighting without glare so the ID can be processed properly.
32 biometrics Match Fail If the user’s biometrics data (face, voice, and/or fingerprint) captured does not match the biometrics data in the database from a previously enrolled user. The application using this SDK/API should prompt the user to recapture their biometrics information, ensuring that face, fingerprint, and voice can be captured with clarity and accuracy.
46 Customer Found If the customer biometrics data (face, voice, and/or fingerprint) has matched the biometrics data in the database of a previous enrollment.
  • No action required
  • Customer verification is approved.
44 Customer Not Found If the customer biometrics data (face, voice, and/or fingerprint) does not match the biometrics data in the database from a previously enrolled user. The application using this SDK/API should prompt the user to recapture their biometrics information. The capture should be completed in a well-lit room with the customer biometrics fully visible.
34 Customer Onboarded
  • All validation and security checks in our system have passed.
  • The customer was successfully enrolled in the database.
  • No action required.
  • Customer enrollment is approved.
37 Customer Onboarding Failed
  • The customer ID documents and/or biometrics have failed one or more validation checks in our system.
  • The customer was not enrolled into the database.
  • The application using this SDK/API should prompt the user to reattempt enrollment.
  • When reattempting to enroll, the recapture should be completed in a well-lit room with the ID documents and biometrics fully visible.
  • The customer failed to enroll.
39 Customer Updated If the capture of customer data has updated a previously enrolled customer record.
  • No action required
  • Customer data is successfully updated.
35 Duplicate Customer The biometrics data provided by the customer for a new enrollment has matched to a previously enrolled user.
  • The application using the SDK should request the user to use the original unique customer identifier that was used during enrollment.
  • If not, the application using the SDK should delete the previous record and prompt the user to reattempt enrollment.
36 Duplicate Employee The biometrics data provided by the employee for a new enrollment has matched to biometrics data from a previous enrollment.
  • The application using the SDK should request the user to use the original unique employee identifier that was used during enrollment.
  • If not, the application using the SDK should delete the previous record and prompt the user to reattempt enrollment.
47 Employee Found If the customer biometrics data (face, voice, and/or fingerprint) has matched the biometrics data in the database of a previous enrollment.
  • No action required.
  • Customer verification is approved
45 Employee Not Found If the customer biometrics data (face, voice, and/or fingerprint) does not match the biometrics data in the database from a previously enrolled user. The application using this SDK/API should prompt the user to recapture their biometrics information. The capture should be completed in a well-lit room with the customer biometrics fully visible.
33 Employee Onboarded
  • All validation and security checks in our system have passed.
  • The employee was successfully enrolled in the database.
  • No action required.
  • Employee enrollment is approved.
38 Employee Onboarding Failed
  • The employee ID documents and/or biometrics data have failed one or more validation checks in our system.
  • The employee was not enrolled into the database.
  • The application using this SDK/API should prompt the user to reattempt enrollment.
  • When reattempting to enroll, the recapture should be completed in a well-lit room with the ID documents and biometrics fully visible.
  • The employee failed to enroll.
41 Employee Updated If the capture of employee data has updated a previously enrolled customer record.
  • No action required
  • Employee data is successfully updated.
40 Expired ID The expiration date on the ID is equal to or less than the current date. The application using this API should prompt the user to provide an ID with a valid expiration date.
31 Face Not Detected
  • A face is not detected on an image.
  • Typically, this occurs when the face is not present on the ID.
  • In some cases, is due to poor image quality or image glare.
 The application using this API should prompt the user to provide a clear image of an ID that includes a photo.
30 Facial biometrics Match Failed If a customer photo is captured and does not biometrically match the photo in the ID document, the ability to review the images is in the back office. The application using this API should prompt the user to capture a new selfie image.
10 ID Back Image not found
  • The back of an ID is expected to be present.
  • The back image was not sent or
  • A blank image was provided.
 The application using this API should prompt the user to provide a clear image of the back of the ID.
52 ID Face Not Found
  • When conducting facial biometrics verification, no face is found on submitted ID to match with selfie.
  • Accordingly, facial biometrics verification cannot be validated with the submitted ID
 The application using this SDK/API should prompt the user to provide a clear ID with a clear face image to ensure that facial biometrics verification can be completed.
60 ID Front and Back Mismatch If the data extracted from the back of the ID image does not belong to the data presented on the front of the ID image.

The application using the API should prompt the user to provide new front and back images because inconsistences were found.

Note: If this occurs more than once, the application could decide to push this to a manual review queue because it could be an issue with OCR extraction accuracy.
11 ID Front Image Not Found The front of an ID is not uploaded, or a blank image was provided. The application using this API should prompt the user to provide a clear image of the front of the ID.
61 ID Not Accepted The uploaded ID contains an invalid configuration for the selected country.

The application using this API should prompt the user to provide an ID that is in the list of accepted ID Types.

Note: The application should prompt the user to select an ID type from a dropdown list, which reduces the likeliness of this result.
62 ID Type Mismatch If the ID Type submitted doesn’t match the ID Type extracted from the ID Image. The application using this API should prompt the user to select the ID Type that matches the Type of ID that was uploaded/captured.
51 IDNumber Match Failed The ID Number that was extracted by OCR from the ID does not match the ID Number that was extracted from the MRZ or Barcode. The application using this SDK/API should prompt the user to retry ID Validation.
63 Invalid ID Number The ID Number on the ID does not match the pattern defined in the ID Template. The application using this API should prompt the user to provide a valid ID.
12 Key Component Not Visible If one of the key components on the ID such as the date of birth or expiration date is missing. The application using this SDK should prompt the user that: The ID they have provided is not valid or the image provided may be blurred or unreadable in some portions or to recapture or capture an image of a different ID.
13 Low Resolution
  • The front or back image that is uploaded has been detected as low resolution or
  • The ID image is not a color/grayscale image based on resolution thresholds defined by IDmission.
 The application using this API should prompt the user to recapture the images in better lighting without glare so the ID can be processed properly.
48 Live Face Detected If our system detects a live face from the selfie.
  • No action required.
  • Live face detection was approved.
49 Live Face Not Detected If our system does not detect a live face from the selfie image (e.g., if the selfie image is a photo of a photo, if the selfie image is a screen capture of a face, etc.) The application using the SDK should prompt the user to retake the selfie ensuring that a live face is captured in good lighting.
64 MRZ and ID Data Mismatch If the data extracted from the MRZ does not match the data extracted from the ID image itself.

The application using the API should prompt the user to provide new image(s) because inconsistences were found.

Note: If this occurs more than once, the application could decide to push this to a manual review queue because it could be an issue with OCR extraction accuracy.
65 MRZ Invalid The MRZ Validation flag (Machine Readable Zone) results in determining that the MRZ Data was not correct according to the standards. The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID.
66 Name Match Failed If the name submitted for the Customer or the Employee doesn’t meet the matching thresholds against the name extracted from the ID Document. The application using this API should prompt the user to provide a valid ID as this was deemed invalid.
14 No Image Found The ID front and back images are black or white and missing an ID Image. The application using this API should prompt the user to recapture the images in better lighting without glare so the ID can be processed properly.
N/A Pending Review Initial state of the form. System checks are still pending. No action required. Final results are sent via the POST API
53 Real ID Detected If our system detects a real ID from the ID image.
  • No action required.
  • Real ID Detection was approved.
54 Real ID Not Detected If our system does not detect a real ID from the ID image (e.g., if the ID image is a photocopy, if the ID image is a screen capture of an ID, etc.) The application using the SDK should prompt the user to retake the ID image ensuring that a real ID is captured in good lighting.
67 Sample ID If an ID has been confirmed as a sample after manual review. The application using this API should prompt the user that: The ID they have provided is not valid and to capture a different ID image.
68 Security Feature Invalid One or more security features defined for the ID template are a mismatch with the provided image. The application using this API should prompt the user to recapture the ID or a different one.
01 Submitted If it is an asynchronous call via the API, the ID is awaiting process completion to be categorized into a form state.
  • No action required.
OR
  • If the call is asynchronous, the application using this SDK/API should get-process-data.
69 Suspected Sample An ID has been detected as a sample (logic has been configured to recognize sample ID numbers, names, watermarks and other suspected sample data.) The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID.
70 Suspected Tampering
  • Photo editing software (e.g. Microsoft Paint, Adobe Photoshop) was detected.
  • Dates have been falsely created or modified in the ID document image.
 The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID.
73 Suspicious ID
  • If an ID is found to be suspicious based on IDmission’s AI logic.
 The application using this API should prompt the user that the ID they have provided is not valid and to capture an image of a different ID.
71 Tampered ID An ID has been confirmed to be tampered with after manual review. The application using this API should prompt the user that the ID they have provided is not valid and to capture image of a different ID.
15 Template Not Found

The correct template cannot be matched against those configured for the client.

Note: The system will not find a template to associate with the image for correct data extraction and validation.

 The application using the API should prompt the user to capture a different ID.
80 Third Party Verification Failed If an ID has not been successfully verified by a third party.
  • The application using this SDK/API should prompt the user that the ID they have provided is not valid and to capture an image of a different ID.
  • If the user thinks it is an error, they can retry.
72 Under the age of 18

The date of birth (extracted from the barcode / MRZ) calculates the individual as under the age of 18.

 The date of birth indicates that the user is under the age of 18

Note: The API can determine if this was already indicated in the application. If it was not indicated, the API should prompt for correct ID.
Final Submission of Response JSON on Success description
Field Name Field Type Response Description
IDType Text In most cases, this is an echo back from the request, unless it was updated by the ID Verification Team because it was incorrect.
IDState Text In most cases, this is an echo back from the request, unless it was added/updated by the ID Verification Team because it was not provided or incorrect.
Name Text Full Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
Name_Doc Text Full Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
FirstName Text First Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
FirstName_doc Text First Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
MiddleName Text Middle Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
LastName Text Last Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present
LastName_doc Text Last Name extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present
LastName2 Text If there is a secondary last name, it will display as extracted from either the barcode, MRZ, or front of the ID when MRZ/barcode are not present.
Address Text Full Address extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
Address1 Text Address Line 1 (usually the Street Number and Street Name) extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not presen.
Address2 Text Address Line 2 (e.g. Suite Number, Unit) extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
Country Text City parsed from a barcode or MRZ, only when a one is present. In most cases the address will be in AddressLine1 / 2.
IDNumber Text ID Number extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
IDNumber1 Text Additional IDNumber 1, extracted from barcode/MRZ data, or if neither are present, from the front of the ID. This will only be present if this additional ID Number component is defined in the matching ID template.
IDNumber2 Text Additional IDNumber 2, extracted from barcode/MRZ data, or if neither are present, from the front of the ID. This will only be present if this additional ID Number 2 component is defined in the matching ID template.
IDNumber3 Text Additional IDNumber 3, extracted from barcode/MRZ data, or if neither are present, from the front of the ID. This will only be present if this additional ID Number 3 component is defined in the matching ID template.
IDNumber_FirstSix Text Additional IDNumber First Six digit, extracted from barcode/MRZ data, or if neither are present, from the front of the ID. This will only be present if this additional ID Number component is defined in the matching ID template.
IDNumber_Doc_Expected Text Additional IDNumber as per Document:'Y', extracted from barcode/MRZ data, or if neither are present, from the front of the ID. This will only be present if this additional ID Number component is defined in the matching ID template.
IDNumber_Doc Text ID Number extracted from Document: 'Y' either barcode, MRZ, or front of the ID when MRZ/barcode are not present.
ValidIDNumber Text

Flag that indicates of the format of the ID number matches what is defined in the matching ID template.

- Flag = Y if the ID Number extracts correctly and matches the format.

- Flag = N if the ID Number does not match the format.

- Flag = NA If there is no specific format defined

- Flag = D if it cannot be clearly determined (D = Doubtful)
DateofBirth Text Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. This is the text that is extracted directly, not always a formatted date.
Date_of_Birth_Formatted Date

Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. If the date cannot be formatted based on extraction (e.g. Odd format, not present in the MRZ and not corrected by manual review) then this field would be blank.

Format: DD/MM/YYYY
DateofBirth_Doc_Expected Date

As per Document Date of Birth extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. If the date cannot be formatted based on extraction (e.g. Odd format, not present in the MRZ and not corrected by manual review) then this field would be blank.

Format: DD/MM/YYYY
IDExpirationDate Text Expiration Date extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. This is the text that is extracted directly, not always a formatted date.
IdExpirationDateFormatted Date

Expiration Date extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. If the date cannot be formatted based on extraction (e.g. Odd format, not present in the MRZ and not corrected by manual review) then this field would be blank.

Format: DD/MM/YYYY
ExpiryDate_Doc_Expected Date

Expiration Date expected from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. If the date cannot be formatted based on extraction (e.g. Odd format, not present in the MRZ and not corrected by manual review) then this field would be blank.

Format: DD/MM/YYYY
IdIssueDate Text Issue Date extracted from either barcode, MRZ, or front of the ID when MRZ/barcode are not present. In most cases this is not present in a machine-readable portion of the ID, so we often see many variations of formats. This will be sent as a Text field.
IdIssueCountry Text This is the 3-digit ISO country code in which the identity document was issued, either extracted from the barcode/MRZ or as defined in the template.
Face_Detected Text This flag indicates whether or not a clear/visible face is found on the identity document. If a 'Photo' component is captured for the specific ID template matched, and a face is clearly detected, this flag will = Y. If a face is expected and is NOT clearly detected, this flag will = N. If there is no 'Photo' component captured for the template, this flag will be blank.
Face_Expected Text This flag indicates whether or not a clear/visible face is found on the identity document. If a 'Photo' component is captured for the specific ID template matched, and a face is clearly detected, this flag will = Y. If a face is expected and is NOT clearly detected, this flag will = N. If there is no 'Photo' component captured for the template, this flag will be blank.
EnoughFeatureFound Text Enough Feature Found:'Y'
EnoughFeatureFoundOnID_FRONT Text Enough Feature Found On ID_FRONT :'Y'
MatchingTemplateFound Text Matching Template Found :'Y'
MatchingTemplateId Text
NoTemplatesAvailable Text No Templates Available :'N'
MRZData Text This is the raw data extracted from the MRZ. There is a parsing tool (in the back-office portal) where you can copy and paste the extracted MRZ string, compare it to the image, and correct any errors that may have resulted during OCR. This way you can determine the validity of the MRZ without having to ask the customer to resubmit their identity documents.
MRZValid Text This flag indicates the validity of the MRZ data, this will = Y if it is valid (passes all of the check digits), otherwise this will = N. When flag = N, there are usually MRZ Error Messages associated with. When there is not an MRZ detected (MRZ Detected = N), this flag will be blank. NA when there is a template matched, but no MRZ expected.
ID_BACK_FOUND Text This field is ID BACK FOUND:'Y'/'N'
ID_FRONT_FOUND Text This field is ID FRONT FOUND:'Y'/'N'
IDBackImageExpected Text This field is ID Back Image Expected:'Y'/'N'
Nationality Text This field contains the Nationality associated with the ID submitted as part of the original request.
FaceVerificationResult Text This is the result of the Face Match 'Verified' or 'Not Verified' will be the values. A verified face must have a score that equates to a 62% or higher match.
ManualReviewExecuted Text If a request was submitted with the 'Manual_Review_Required' parameter = Y, and a manual review was actually executed, this field will = Y. If not, it will = N or Blank.
NameNonEng Text This field is extracted from the front or back of the ID
FirstNameNonEng Text This field is extracted from the front or back of the ID
LastNameNonEng Text This field is extracted from the front or back of the ID
MiddleNameNonEng Text This field is extracted from the front or back of the ID
LastName2 Text

This field is extracted from:

- The barcode or MRZ (if present)

- The front or back of the ID, if both the MRZ and barcode are not present.
AddressNonEng Text This field is extracted from the front or back of the ID
AddressLine1NonEng Text This field is extracted from the front or back of the ID
AddressLine2NonEng Text This field is extracted from the front or back of the ID
IDNumberNonEng Text This field is extracted from the front or back of the ID
IDNumber2NonEng Text This field is extracted from the front or back of the ID
IdDateofBirthNonEng Text This field is extracted from the front or back of the ID
ExpiryDateNonEng Text This field is extracted from the front or back of the ID
IdIssueDateNonEng Text This field is extracted from the front or back of the ID
Gender Text

This field is extracted from:

- The barcode or MRZ

- The front or back of the ID, if both the MRZ and barcode are not present.
uniqueNumber Text This field is an echo back from what is submitted in the request. This is not extracted from the ID or generated by IDmission. It is for the client to use to define a unique number associated with their customer.
API_resultCount_NM Text This field returns a count of matches found using the customer or employee name against a Negative Media database.
API_resultCount_PEP Text This field returns a count of matches found using the customer or employee name against Politically Exposed Persons (PEPs) lists.
API_resultCount_WLS Text This field returns a count of matches found using the customer or employee name against Global watchlists.
Client_Customer_Number Text This field contains the unique client customer number associated with the customer record from the original enrollment. This is also used for ongoing verification.
AddressLine1 Text This field contains Address Line 1 for the customer that was submitted as part of the request.
AddressLine2 Text This field contains Address Line 2 for the customer that was submitted as part of the request.
City Text This field contains the city for the customer that was submitted as part of the request.
Country Text This field contains the country code or country name for the customer that was submitted as part of the request.
IdDateOfBirth Text This field contains the date of birth for the customer that was submitted as part of the request.
District Text This field contains the district for the customer that was submitted as part of the request.
Email Text This field contains the email address for the customer that was submitted as part of the request.
Enrolled_Date Date This field indicates the date the customer was enrolled. Format: YYYY-MM-DD
FP_Data Image BLOB This field returns the fingerprint data associated with the original enrollment of the Customer that a verification submission is verified against.
Gender Text This field contains the gender code that was submitted as part of the request.
CustomerName Text This field contains the Customer Name that was submitted as part of the request or the name that was extracted from the ID document if present.
PhoneNumber Text This field contains the phone number for the customer that was submitted as part of the request.
Customer_Search_Status Text This field returns the status of the search results for the Customer based on the biometrics data that was sent. The valid values are "SUCCESS" and "FAIL".
SignatureData Image BLOB This is an image of the customer's signature that can be optionally collected during any service where customer data is supported.
verificationResult Text This field returns the results of the Verify Customer request. The valid values are "Verified" and "Verification Failed".
CustomerCode Text This field contains the Customer Code that is auto-generated by the IDmission system during the enrollment process.
CustomerStatus Text This field is used for Customer Enrollment processing. This field indicates if a customer has been found and returns the current status of that customer. The field can return "SUCCESS" or "FAILED".
CustomerVerification_Status Text This field indicates the current status of the customer in the IDmission database. The field can return "Verified" or "Unverified".
deDuplicationRequired Text The field indicates the overall status of Deduplication processing. This field can return "SUCCESS" or "FAIL".
deDupDataRequiredInResponse Text The field indicates the overall status of Deduplication processing data. This field can return deduplication data in Response. This field need to use with deDuplicationRequired flag
Employee_AddresLine1 Text This field contains Address Line 1 for the employee that was submitted as part of the request.
Employee_AddresLine2 Text This field contains Address Line 2 for the employee that was submitted as part of the request.
Employee_City Text This field contains the city associated with the address of the employee submitted as part of the request.
EMPLOYEE_CODE Text This field contains the employee code submitted as part of the request.
Employee_Country Text This field contains the country associated with the address for the employee submitted as part of the request.
Employee_Email Text This field contains the email associated with the employee submitted as part of the request.
Employee_Gender Text This field contains the gender code that was submitted as part of the request.
Employee_ID Text The field contains the employee ID that was provided during the employee enrollment process as part of the request.
Employee_ID_State Text This field contains the State associated with the ID of the employee submitted as part of the original request.
Employee_LoginID Text This field contains the employee Login ID that was submitted as part of the request.
EmployeeName Text This field contains the name of the employee submitted as part of the request.
EmployeePhone Text This field contains the phone number associated with the employee submitted as part of the request.
EmployeePostalCode Text This field contains the postal/zip code associated with the address for the employee submitted as part of the request.
EmployeeType Text This field contains the type of employee that was specified during the employee enrollment process, as part of the request.
EmployeeverificationResult Text This field returns the results of the Verify Employee request. The valid values are "Verified" and "Verification Failed".
EmployeeCreateStatus Text This field indicates whether or not the Employee enrollment was successful. The field can return "SUCCESS" or "FAILED".
EmployeeCreateStatusMessage Text This field is the message that is returned based on the employee enrollment processing. For example, "Employee already exists" or "User does not have required privileges."
EmployeeID Text This field is the employee ID provided during any employee enrollment services.
EmployeeSignature Image BLOB This field contains a signature image captured during the original employee enrollment.
EmployeeVerification_Status Text This field indicates the current status of the employee in the IDmission database. The field can return "Verified" or "Unverified".
ENROLLED_FACE_IMAGE Image BLOB This field returns the photograph associated with the original enrollment of the Customer or Employee that a verification submission is verified against.
FullName Text This field is the full name of the customer, with the First,Middle, and Last names combined into one field.
HOST_URL Text This field is the URL that is provided to IDmission to return the POST API to.
ID_Number_Match_Result Text This field indicates if the ID Number that was extracted from the ID matches the ID Number that was read from the MRZ or Barcode when applicable.
Name_Match_Result Text This field returns the result of the name submitted in request matches the name extracted from the ID during processing.
serviceName Text This is an echo back of the serviceName sent in the request for the SDK, or utilized when using the Swagger API. The serviceName is associated with the service being performed (e.g., ID Validation, Customer Enrollment, Verification, etc.)
CompanyCode Text This is an echo back of the CompanyCode submitted in the original request that the form is processed under.
CustomerIDExpiryDate Date This is the expiration date from an ID document that has been enrolled for a customer. This will be provided back based on input parameters in the Verification requests. Format: dd/mm/yyyy.
DocumentType Text This is ID Type that is determined based on the template it was matched against. This will be the same list of values are in the input ID Type.
PlaceOfBirth Text This is a text-based field that will contain the place of birth if specified on the ID. (Currently only available for Italy IDs)
PlaceofIssue Text This is a text-based field that will contain the place in which the ID was issued if specified on the ID. (Currently only available for Italy IDs)
IssuingAuthority Text This is a text-based field that will contain the issuing authority of the ID. This will only be present if this is a text-based field on the ID, it will not be extracted from a stamp. (Currently only available for Italy IDs)
IssuingCountry Text This is a text-based field that will contain the issuing Country of the ID.
OCR_Signature Image BLOB This field is the signature that is extracted from the ID
PostalCode Text This field contains postal code for the customer that was submitted as part of the request.
Image_ProcessedFront Image BLOB This image is the processed version of the front image from the server after ID validation processing is completed. It will be cropped and de-skewed and have security features highlighted.
Image_ProcessedBack Image BLOB This image is the processed version of the back image from the server after ID validation processing is completed. It will be cropped and de-skewed and have security features highlighted.
Image_Front Image BLOB This image is the front image provided by the client.
Image_Back Image BLOB This image is the back image provided by the client.
MatchedTemplateCode Text Matched Template Code
TemplateFoundUsingFilter Text Template Found Using Filter
Customer_Photo Image BLOB This image is the live selfie image provided by the client.
Form_State_Code Single Select

This is the two-digit code associated with the Form_Status.

For a full list of values, please refer to the Form Status and State Codes Section of this document.
Verification_Approval_Code Text 4 digit verification code when biometrics verification is done through the IDentity as a Service (IDaaS) Web Application.
Supported Configuration(s)
  • Additional Configuration
Key value Actions
Some text some message..