idmission-web-sdk 2.0.5 → 2.0.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +639 -638
- package/README.mdx +1012 -0
- package/dist/sdk2.cjs.development.js +1 -1
- package/dist/sdk2.cjs.development.js.map +1 -1
- package/dist/sdk2.cjs.production.js +1 -1
- package/dist/sdk2.esm.js +1 -1
- package/dist/sdk2.esm.js.map +1 -1
- package/dist/sdk2.umd.development.js +1 -1
- package/dist/sdk2.umd.development.js.map +1 -1
- package/dist/sdk2.umd.production.js +1 -1
- package/dist/sdk2.umd.production.js.map +1 -1
- package/dist/version.d.ts +1 -1
- package/package.json +2 -1
package/README.md
CHANGED
|
@@ -1,3 +1,5 @@
|
|
|
1
|
+
<!--- This markdown file was auto-generated from "README.mdx" -->
|
|
2
|
+
|
|
1
3
|
# IDmission Web SDK
|
|
2
4
|
|
|
3
5
|
Demo: https://websdk2demo.idmission.com
|
|
@@ -9,10 +11,12 @@ Storybook: https://websdk2test.idmission.com
|
|
|
9
11
|
Before using the IDmission WebSDK, you will need to obtain an API key. New customers receive their API credentials via email. If you haven't received them, reach out to support@idmission.com.
|
|
10
12
|
|
|
11
13
|
To test that your credentials are valid:
|
|
14
|
+
|
|
12
15
|
```bash
|
|
13
16
|
curl -s -H "Content-Type: application/json" \
|
|
14
17
|
-d '{"api_key_id": "your-api-key-id", "api_key_secret": "your-api-secret"}' \
|
|
15
18
|
https://portal-api.idmission.com/portal.sessions.v1.SessionsService/CreateSession
|
|
19
|
+
|
|
16
20
|
```
|
|
17
21
|
|
|
18
22
|
Prior to initializing the WebSDK on the client, you should generate a session on your server using these credentials. Be careful not to leak them on the client side! The generated session id is safe to pass to the client, but the secrets used to generate them are not. If you have inadvertently leaked your credentials, react out to support@idmission.com to rotate them.
|
|
@@ -23,6 +27,7 @@ If you are using NodeJS, check out our [auth client for server-side JavaScript](
|
|
|
23
27
|
|
|
24
28
|
```bash
|
|
25
29
|
npm i idmission-web-sdk
|
|
30
|
+
|
|
26
31
|
```
|
|
27
32
|
|
|
28
33
|
```jsx
|
|
@@ -31,13 +36,16 @@ import { render } from 'react-dom'
|
|
|
31
36
|
import { IdValidation } from 'idmission-web-sdk'
|
|
32
37
|
|
|
33
38
|
render(<IdValidation sessionId={YOUR_SESSION_ID} />, document.getElementById('root'))
|
|
39
|
+
|
|
34
40
|
```
|
|
35
41
|
|
|
36
42
|
## Basic Usage in HTML
|
|
37
43
|
|
|
38
44
|
Add the following script tag to your page's `<head>`:
|
|
45
|
+
|
|
39
46
|
```html
|
|
40
47
|
<script type="module" src="https://websdk-cdn-dev.idmission.com/websdk/prod/loader.js"></script>
|
|
48
|
+
|
|
41
49
|
```
|
|
42
50
|
|
|
43
51
|
You may subscribe to the `idmission-web-sdk.ready` event to be notified when loading has completed.
|
|
@@ -48,13 +56,16 @@ You may subscribe to the `idmission-web-sdk.ready` event to be notified when loa
|
|
|
48
56
|
// this code fires when the sdk has finished loading.
|
|
49
57
|
})
|
|
50
58
|
</script>
|
|
59
|
+
|
|
51
60
|
```
|
|
52
61
|
|
|
53
62
|
Then you may call any render method below, for example `renderIdValidation`, like so:
|
|
63
|
+
|
|
54
64
|
```html
|
|
55
65
|
<script type="module">
|
|
56
66
|
IDmissionSDK.renderIdValidation('#target-element', { sessionId: 'my-idmission-session-id' });
|
|
57
67
|
</script>
|
|
68
|
+
|
|
58
69
|
```
|
|
59
70
|
|
|
60
71
|
## Customer Flows
|
|
@@ -65,144 +76,141 @@ Render a fullscreen ID capture component that instructs the user to photograph b
|
|
|
65
76
|
|
|
66
77
|
**Props**
|
|
67
78
|
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
|
|
119
|
-
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
|
|
124
|
-
|
|
125
|
-
</table>
|
|
79
|
+
| sessionId | a session id generated with your IDmission credentials, or an async function that resolves to one. |
|
|
80
|
+
| ------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
81
|
+
| authUrl (optional) | URL to authenticate against. Default: https://portal-api.idmission.com |
|
|
82
|
+
| submissionUrl (optional) | URL to submit data to. Default: https://portal-api.idmission.com/swagger |
|
|
83
|
+
| documentServiceUrl (optional) | URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/ |
|
|
84
|
+
| onBeforeDocumentUpload (optional) | callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. |
|
|
85
|
+
| onDocumentUploadProgress (optional) | callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. |
|
|
86
|
+
| onDocumentUploaded (optional) | callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. |
|
|
87
|
+
| onDocumentUploadFailed (optional) | callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. |
|
|
88
|
+
| onBeforeSubmit (optional) | callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. |
|
|
89
|
+
| onComplete (optional) | callback function that fires when the user completes the IDValidation flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. |
|
|
90
|
+
| onApproved (optional) | callback function that fires when the user completes the IDValidation flow with a valid ID. Arguments: same as onComplete. |
|
|
91
|
+
| onDenied (optional) | callback function that fires when the user completes the IDValidation flow with an invalid ID. Arguments: same as onComplete. |
|
|
92
|
+
| onExitCapture (optional) | callback function that fires when the user clicks the X button during capture. |
|
|
93
|
+
| onUserCancel (optional) | callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. |
|
|
94
|
+
| onCameraAccessDenied (optional) | callback function that fires when camera access is denied or lost. |
|
|
95
|
+
| lang (optional) | language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. |
|
|
96
|
+
| captureSignature (optional) | boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false. |
|
|
97
|
+
| captureSignatureVideo (optional) | boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false. |
|
|
98
|
+
| captureAdditionalDocuments (optional) | array of additional documents to be captured, for available options consult the Additional Document Properties table below. |
|
|
99
|
+
| loadingOverlayMode (optional) | string indicating which ID capture loading overlay screen should be used. Supported values: default and legacy. Defaults to default. |
|
|
100
|
+
| idCaptureRequirement (optional) | string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport. |
|
|
101
|
+
| idAutoCaptureEnabled (optional) | boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is true. |
|
|
102
|
+
| idCardAutoCaptureScoreThreshold (optional) | number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8. |
|
|
103
|
+
| passportAutoCaptureScoreThreshold (optional) | number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. |
|
|
104
|
+
| idCardFocusScoreThreshold (optional) | number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. Defaults to 0.3. |
|
|
105
|
+
| passportFocusScoreThreshold (optional) | number between 0 and 1 at which focus guidance score condition is considered to be met for passports. Defaults to 0.3. |
|
|
106
|
+
| skipSuccessScreen (optional) | boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false. |
|
|
107
|
+
| instructions (optional) | React element or string to render on the instructions screen. |
|
|
108
|
+
| guideType (optional) | string to indicate what type of guides to use during capture. Using fit is highly recommended in order to capture the best quality image. Valid values: fit, overlay. Defaults to fit. |
|
|
109
|
+
| portraitGuidesOnMobile (optional) | boolean to indicate whether guide images should be rotated on mobile. Defaults to false. |
|
|
110
|
+
| rotateLoadingOverlayImageWhenPortrait (optional) | boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to true. |
|
|
111
|
+
| precapturedDocuments (optional) | object to allow documents that have been previously captured to be submitted. Valid keys: idCardFront, idCardBack, passport. |
|
|
112
|
+
| companyId (optional) | company identifier to include with submission. |
|
|
113
|
+
| needImmediateResponse (optional) | boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. |
|
|
114
|
+
| manualReviewRequired (optional) | boolean flag to indicate whether responses should always be reviewed by a human. Defaults to false. |
|
|
115
|
+
| idBackImageRequired (optional) | boolean flag to indicate whether the back of the ID card image will be considered in processing decisions. Defaults to true. |
|
|
116
|
+
| idImageResolutionCheck (optional) | boolean to indicate if validation of the minimum resolution for an ID (x) document image should be triggered. Defaults to false. |
|
|
117
|
+
| verifyIdWithExternalDatabases (optional) | boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc. Defaults to false. |
|
|
118
|
+
| bypassAgeValidation (optional) | boolean to indicate whether end-users under the age of 18 should be allowed through validation. Defaults to false. |
|
|
119
|
+
| bypassNameMatching (optional) | boolean to indicate if matching the name in the request against the name extracted from the ID should be bypassed. Defaults to true. |
|
|
120
|
+
| personalData (optional) | object of personal data to store with the submitted ID. Valid keys: uniqueNumber, name, phone, phoneCountryCode, email, dob, gender, addressLine1, addressLine2, city, district, postalCode, country. |
|
|
121
|
+
| cardData (optional) | object of credit/debit card data to store with the submitted ID. Valid keys: cardToken, cardLast4, cardExpDate, nameOnCard. |
|
|
122
|
+
| webhooksEnabled (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked after submission. Defaults to false. |
|
|
123
|
+
| webhooksClientTraceId (optional) | a customer provided trace id to use when invoking customer-configured webhooks. |
|
|
124
|
+
| webhooksStripSpecialCharacters (optional) | boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true. |
|
|
125
|
+
| webhooksSendInputImages (optional) | boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
126
|
+
| webhooksSendProcessedImages (optional) | boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
127
|
+
| webhooksFireOnReview (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. Defaults to false. |
|
|
128
|
+
| sendBase64DocumentsInSwaggerProxy (optional) | boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. |
|
|
129
|
+
| assets (optional) | object containing any asset overrides, for available options consult the Assets table below. |
|
|
130
|
+
| colors (optional) | object containing any color overrides, for available options consult the Colors table below. |
|
|
131
|
+
| theme (optional) | name of an included theme or object containing theme properties. |
|
|
132
|
+
| verbiage (optional) | object containing any verbiage overrides, for available options consult the Verbiage table below. |
|
|
133
|
+
| geolocationEnabled (optional) | boolean flag to indicate whether users should be prompted to share their location. Defaults to true. |
|
|
134
|
+
| geolocationRequired (optional) | boolean flag to indicate whether users should be blocked from proceeding if they block location access. Defaults to false. |
|
|
135
|
+
| debugMode (optional) | boolean flag to enable on-screen prediction information output. Defaults to false. |
|
|
126
136
|
|
|
127
137
|
**ID Capture Assets**
|
|
128
138
|
|
|
129
|
-
|
|
130
|
-
|
|
131
|
-
|
|
132
|
-
|
|
133
|
-
|
|
134
|
-
|
|
135
|
-
|
|
136
|
-
|
|
137
|
-
|
|
138
|
-
|
|
139
|
-
|
|
140
|
-
|
|
141
|
-
|
|
142
|
-
|
|
143
|
-
|
|
144
|
-
</table>
|
|
139
|
+
| documentDetectionModelUrl | Default: https://websdk-cdn-dev.idmission.com/assets/models/documentdetection448/model.json |
|
|
140
|
+
| ------------------------------------------ | -------------------------------------------------------------------------------------------------- |
|
|
141
|
+
| focusModelUrl | Default: https://websdk-cdn-dev.idmission.com/assets/models/focus/model.json |
|
|
142
|
+
| loadingOverlay.instructionImageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/WebSDK-Instruction-DL-Capture-3-Portrait.png |
|
|
143
|
+
| loadingOverlay.cameraAccessDenied.imageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png |
|
|
144
|
+
| idCardFront.portraitGuidesImageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Front-SVG-Portrait-2.svg |
|
|
145
|
+
| idCardFront.landscapeGuidesImageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Landscape-SVG-Portrait-2.svg |
|
|
146
|
+
| idCardBack.portraitGuidesImageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Back-SVG-Portrait-2.svg |
|
|
147
|
+
| idCardBack.landscapeGuidesImageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Back-SVG-Landscape-2.svg |
|
|
148
|
+
| passport.portraitGuidesImageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-Passport-Front-SVG-Portrait-2.svg |
|
|
149
|
+
| passport.landscapeGuidesImageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-Passport-Front-SVG-Landscape-2.svg |
|
|
150
|
+
| flipIdPrompt.frontPortraitGuidesImageUrl | Default: value of idCardFront.portraitGuidesImageUrl |
|
|
151
|
+
| flipIdPrompt.frontLandscapeGuidesImageUrl | Default: value of idCardFront.landscapeGuidesImageUrl |
|
|
152
|
+
| flipIdPrompt.backPortraitGuidesImageUrl | Default: value of idCardBack.portraitGuidesImageUrl |
|
|
153
|
+
| flipIdPrompt.backLandscapeGuidesImageUrl | Default: value of idCardBack.landscapeGuidesImageUrl |
|
|
145
154
|
|
|
146
155
|
**ID Capture Colors**
|
|
147
|
-
|
|
148
|
-
|
|
149
|
-
|
|
150
|
-
|
|
151
|
-
|
|
152
|
-
|
|
153
|
-
|
|
154
|
-
|
|
155
|
-
|
|
156
|
-
|
|
157
|
-
|
|
158
|
-
|
|
159
|
-
|
|
160
|
-
|
|
161
|
-
|
|
162
|
-
|
|
156
|
+
|
|
157
|
+
| loadingOverlay.continueBtn.backgroundColor | Default: #16a085 |
|
|
158
|
+
| ---------------------------------------------------------- | ---------------- |
|
|
159
|
+
| loadingOverlay.continueBtn.textColor | Default: white |
|
|
160
|
+
| loadingOverlay.continueBtn.loadingBackgroundColor | Default: gray |
|
|
161
|
+
| loadingOverlay.continueBtn.loadingTextColor | Default: white |
|
|
162
|
+
| loadingOverlay.cameraAccessDenied.retryBtn.backgroundColor | Default: #ea8557 |
|
|
163
|
+
| loadingOverlay.cameraAccessDenied.retryBtn.textColor | Default: white |
|
|
164
|
+
| guideBoxUnsatisfiedColor | Default: white |
|
|
165
|
+
| guideBoxSatisfiedColor | Default: green |
|
|
166
|
+
| videoSignatureCapture.success.retryBtn.backgroundColor | Default: #ea8557 |
|
|
167
|
+
| videoSignatureCapture.success.retryBtn.textColor | Default: white |
|
|
168
|
+
| success.doneBtn.backgroundColor | Default: #16a085 |
|
|
169
|
+
| success.doneBtn.textColor | Default: white |
|
|
170
|
+
| success.retryBtn.backgroundColor | Default: #ea8557 |
|
|
171
|
+
| success.retryBtn.textColor | Default: white |
|
|
163
172
|
|
|
164
173
|
**ID Capture Verbiage**
|
|
165
174
|
|
|
166
|
-
|
|
167
|
-
|
|
168
|
-
|
|
169
|
-
|
|
170
|
-
|
|
171
|
-
|
|
172
|
-
|
|
173
|
-
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
|
|
183
|
-
|
|
184
|
-
|
|
185
|
-
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
|
|
199
|
-
|
|
200
|
-
|
|
201
|
-
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
</table>
|
|
175
|
+
| loadingOverlay.headingText | Default: "Use your device camera to capture your ID" |
|
|
176
|
+
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
177
|
+
| loadingOverlay.useContinuityCameraText | Default: "Use your iPhone as a webcam" |
|
|
178
|
+
| loadingOverlay.modelsWarmingUpText | Default: "Models warming up..." |
|
|
179
|
+
| loadingOverlay.cameraInitializingText | Default: "Camera initializing..." |
|
|
180
|
+
| loadingOverlay.continueText | Default: "Continue" |
|
|
181
|
+
| loadingOverlay.cameraAccessDenied.headingText | Default: "Your camera permission is disabled" |
|
|
182
|
+
| loadingOverlay.cameraAccessDenied.descriptionText | Default: "This application requires access to your camera to continue. Please accept the permission once prompted by the browser. If the browser does not prompt for camera permissions, you must go to settings and provide camera access to the current browser." |
|
|
183
|
+
| loadingOverlay.cameraAccessDenied.retryBtnText | Default: "Retry" |
|
|
184
|
+
| idCardFront.instructionText | Default: "Scan the front of ID" |
|
|
185
|
+
| idCardFront.capturingText | Default: "Capturing..." |
|
|
186
|
+
| idCardFront.captureFailedText | Default: "Capture failed!" |
|
|
187
|
+
| idCardBack.instructionText | Default: "Scan the back of ID" |
|
|
188
|
+
| idCardBack.capturingText | Default: "Capturing..." |
|
|
189
|
+
| idCardBack.captureFailedText | Default: "Capture failed!" |
|
|
190
|
+
| passport.instructionText | Default: "Scan the ID page of passport" |
|
|
191
|
+
| passport.capturingText | Default: "Capturing..." |
|
|
192
|
+
| passport.captureFailedText | Default: "Capture failed!" |
|
|
193
|
+
| flipIdPrompt.instructionText | Default: "Please flip your ID card..." |
|
|
194
|
+
| additionalDocumentCapture.headingText | Default: "Additional document capture" |
|
|
195
|
+
| additionalDocumentCapture.nextBtnText | Default: "Next" |
|
|
196
|
+
| signatureCapture.headingText | Default: "Please sign the box below" |
|
|
197
|
+
| signatureCapture.acceptBtnText | Default: "Accept" |
|
|
198
|
+
| signatureCapture.clearBtnText | Default: "Clear" |
|
|
199
|
+
| videoSignatureCapture.faceLiveness | Default: see Face Liveness Verbiage section below |
|
|
200
|
+
| videoSignatureCapture.guidanceMessageText | Default: "Please sign the box below" |
|
|
201
|
+
| videoSignatureCapture.acceptBtnText | Default: "Accept" |
|
|
202
|
+
| videoSignatureCapture.clearBtnText | Default: "Clear" |
|
|
203
|
+
| videoSignatureCapture.success.headingText | Default: "Video signature has been successfully captured!" |
|
|
204
|
+
| videoSignatureCapture.success.doneBtnText | Default: "Done" |
|
|
205
|
+
| videoSignatureCapture.success.retryBtnText | Default: "Retry" |
|
|
206
|
+
| success.headingText | Default: "ID Capture Successful" |
|
|
207
|
+
| success.idCardFrontText | Default: "ID Card Front" |
|
|
208
|
+
| success.idCardBackText | Default: "ID Card Back" |
|
|
209
|
+
| success.passportText | Default: "Passport" |
|
|
210
|
+
| success.instructionText | Default: "Verify the entire ID was captured clearly with no glare." |
|
|
211
|
+
| success.retryText | Default: "Retry" |
|
|
212
|
+
| success.submittingText | Default: "Submitting..." |
|
|
213
|
+
| success.submitText | Default: "Submit" |
|
|
206
214
|
|
|
207
215
|
**Example**
|
|
208
216
|
|
|
@@ -216,6 +224,7 @@ IDmissionSDK.renderIdValidation('#target-element', {
|
|
|
216
224
|
alert('Your ID could not be validated, you shall not pass!')
|
|
217
225
|
},
|
|
218
226
|
});
|
|
227
|
+
|
|
219
228
|
```
|
|
220
229
|
|
|
221
230
|
### FaceValidation
|
|
@@ -224,105 +233,101 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
224
233
|
|
|
225
234
|
**Props**
|
|
226
235
|
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
</table>
|
|
236
|
+
| sessionId | a session id generated with your IDmission credentials, or an async function that resolves to one. |
|
|
237
|
+
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
238
|
+
| authUrl (optional) | URL to authenticate against. Default: https://portal-api.idmission.com |
|
|
239
|
+
| submissionUrl (optional) | URL to submit data to. Default: https://portal-api.idmission.com/swagger |
|
|
240
|
+
| documentServiceUrl (optional) | URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/ |
|
|
241
|
+
| onBeforeDocumentUpload (optional) | callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. |
|
|
242
|
+
| onDocumentUploadProgress (optional) | callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. |
|
|
243
|
+
| onDocumentUploaded (optional) | callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. |
|
|
244
|
+
| onDocumentUploadFailed (optional) | callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. |
|
|
245
|
+
| onBeforeSubmit (optional) | callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. |
|
|
246
|
+
| onComplete (optional) | callback function that fires when the user has completed the FaceValidation flow, regardless of whether they are approved or denied. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. |
|
|
247
|
+
| onApproved (optional) | callback function that fires when the user completes the FaceValidation flow and passes the realness check. Arguments: same as onComplete. |
|
|
248
|
+
| onDenied (optional) | callback function that fires when the user completes the FaceValidation flow and fails the realness check. Arguments: same as onComplete. |
|
|
249
|
+
| onExitCapture (optional) | callback function that fires when the user clicks the X button during capture. |
|
|
250
|
+
| onExitAfterFailure (optional) | callback function that fires when the user clicks the exit button after completing the FaceValidation flow and failing the realness check. |
|
|
251
|
+
| onUserCancel (optional) | callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. |
|
|
252
|
+
| onCameraAccessDenied (optional) | callback function that fires when camera access is denied or lost. |
|
|
253
|
+
| lang (optional) | language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. |
|
|
254
|
+
| loadingOverlayMode (optional) | string indicating which loading overlay screen should be used. Supported values: default and legacy. Defaults to default. |
|
|
255
|
+
| timeoutDurationMs (optional) | the duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000 (15 seconds). |
|
|
256
|
+
| skipSuccessScreen (optional) | boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false. |
|
|
257
|
+
| companyId (optional) | company identifier to include with submission. |
|
|
258
|
+
| needImmediateResponse (optional) | boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. |
|
|
259
|
+
| webhooksEnabled (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked after submission. Defaults to false. |
|
|
260
|
+
| webhooksClientTraceId (optional) | a customer provided trace id to use when invoking customer-configured webhooks. |
|
|
261
|
+
| webhooksStripSpecialCharacters (optional) | boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true. |
|
|
262
|
+
| webhooksSendInputImages (optional) | boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
263
|
+
| webhooksSendProcessedImages (optional) | boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
264
|
+
| sendBase64DocumentsInSwaggerProxy (optional) | boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. |
|
|
265
|
+
| assets (optional) | object containing any asset overrides, for available options consult the Assets table below. |
|
|
266
|
+
| colors (optional) | object containing any color overrides, for available options consult the Colors table below. |
|
|
267
|
+
| theme (optional) | name of an included theme or object containing theme properties. |
|
|
268
|
+
| verbiage (optional) | object containing any verbiage overrides, for available options consult the Verbiage table below. |
|
|
269
|
+
| geolocationEnabled (optional) | boolean flag to indicate whether users should be prompted to share their location. Defaults to true. |
|
|
270
|
+
| geolocationRequired (optional) | boolean flag to indicate whether users should be blocked from proceeding if they block location access. Defaults to false. |
|
|
271
|
+
| debugMode (optional) | boolean flag to enable on-screen prediction information output. Defaults to false. |
|
|
264
272
|
|
|
265
273
|
**Face Liveness Assets**
|
|
266
274
|
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
</table>
|
|
275
|
+
| loadingOverlay.instructionImageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png |
|
|
276
|
+
| ------------------------------------------ | ---------------------------------------------------------------------------- |
|
|
277
|
+
| loadingOverlay.cameraAccessDenied.imageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png |
|
|
278
|
+
| failure.imageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/manual\_capture.png |
|
|
272
279
|
|
|
273
280
|
**Face Liveness Colors**
|
|
274
281
|
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
</table>
|
|
282
|
+
| loadingOverlay.continueBtn.backgroundColor | Default: #16a085 |
|
|
283
|
+
| ---------------------------------------------------------- | ---------------- |
|
|
284
|
+
| loadingOverlay.continueBtn.textColor | Default: white |
|
|
285
|
+
| loadingOverlay.continueBtn.loadingBackgroundColor | Default: gray |
|
|
286
|
+
| loadingOverlay.continueBtn.loadingTextColor | Default: white |
|
|
287
|
+
| loadingOverlay.cameraAccessDenied.retryBtn.backgroundColor | Default: #ea8557 |
|
|
288
|
+
| loadingOverlay.cameraAccessDenied.retryBtn.textColor | Default: white |
|
|
289
|
+
| guidesUnsatisfiedColor | Default: white |
|
|
290
|
+
| guidesSatisfiedColor | Default: green |
|
|
291
|
+
| guidanceMessagesSatisfiedBackgroundColor | Default: green |
|
|
292
|
+
| guidanceMessagesUnsatisfiedBackgroundColor | Default: red |
|
|
293
|
+
| guidanceMessagesSatisfiedTextColor | Default: white |
|
|
294
|
+
| guidanceMessagesUnsatisfiedTextColor | Default: white |
|
|
295
|
+
| success.doneBtn.backgroundColor | Default: #16a085 |
|
|
296
|
+
| success.doneBtn.textColor | Default: white |
|
|
297
|
+
| success.retryBtn.backgroundColor | Default: #ea8557 |
|
|
298
|
+
| success.retryBtn.textColor | Default: white |
|
|
299
|
+
| failure.retryBtn.backgroundColor | Default: #ea8557 |
|
|
300
|
+
| failure.retryBtn.textColor | Default: white |
|
|
301
|
+
| failure.exitBtn.backgroundColor | Default: #666 |
|
|
302
|
+
| failure.exitBtn.textColor | Default: white |
|
|
297
303
|
|
|
298
304
|
**Face Liveness Verbiage**
|
|
299
305
|
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
</table>
|
|
306
|
+
| loadingOverlay.headingText | Default: "Use your device camera to capture your face" |
|
|
307
|
+
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
308
|
+
| loadingOverlay.removeEyeCoveringsText | Default: "Remove Sunglasses & Hat" |
|
|
309
|
+
| loadingOverlay.avoidExcessiveBacklightingText | Default: "Avoid Excessive Backlighting" |
|
|
310
|
+
| loadingOverlay.continueText | Default: "Continue" |
|
|
311
|
+
| loadingOverlay.cameraInitializingText | Default: "Camera initializing..." |
|
|
312
|
+
| loadingOverlay.modelsWarmingUpText | Default: "Models warming up..." |
|
|
313
|
+
| loadingOverlay.cameraAccessDenied.headingText | Default: "Your camera permission is disabled" |
|
|
314
|
+
| loadingOverlay.cameraAccessDenied.descriptionText | Default: "This application requires access to your camera to continue. Please accept the permission once prompted by the browser. If the browser does not prompt for camera permissions, you must go to settings and provide camera access to the current browser." |
|
|
315
|
+
| loadingOverlay.cameraAccessDenied.retryBtnText | Default: "Retry" |
|
|
316
|
+
| guidanceHoldStillText | Default: "Hold still for a few seconds..." |
|
|
317
|
+
| guidanceLookStraightText | Default: "Look straight into the camera..." |
|
|
318
|
+
| guidanceMoveBackText | Default: "Move back..." |
|
|
319
|
+
| guidanceMoveForwardText | Default: "Move forward..." |
|
|
320
|
+
| guidanceMoveToCenterText | Default: "Move to the center..." |
|
|
321
|
+
| guidanceRemoveEyeCoveringsText | Default: "Please remove your eye coverings (sunglasses, eye patch, etc.)..." |
|
|
322
|
+
| guidanceRemoveHeadCoveringsText | Default: "Please remove your head coverings (hat, scarf, etc.)..." |
|
|
323
|
+
| guidanceRemoveMaskText | Default: "Please remove your mask..." |
|
|
324
|
+
| progressPreviewText | Default: "Processing..." |
|
|
325
|
+
| success.headingText | Default: "Face liveness has been verified!" |
|
|
326
|
+
| success.retryBtnText | Default: "Retry" |
|
|
327
|
+
| success.doneBtnText | Default: "Done" |
|
|
328
|
+
| failure.headingText | Default: "Live face not detected, please try again" |
|
|
329
|
+
| failure.retryBtnText | Default: "Retry" |
|
|
330
|
+
| failure.exitBtnText | Default: "Exit" |
|
|
326
331
|
|
|
327
332
|
**Example**
|
|
328
333
|
|
|
@@ -336,6 +341,7 @@ IDmissionSDK.renderFaceValidation('#target-element', {
|
|
|
336
341
|
alert('Your face realness could not be validated, you shall not pass!')
|
|
337
342
|
},
|
|
338
343
|
});
|
|
344
|
+
|
|
339
345
|
```
|
|
340
346
|
|
|
341
347
|
### IdAndFaceValidation
|
|
@@ -344,73 +350,72 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
|
|
|
344
350
|
|
|
345
351
|
**Props**
|
|
346
352
|
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
</table>
|
|
353
|
+
| sessionId | a session id generated with your IDmission credentials, or an async function that resolves to one. |
|
|
354
|
+
| --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
355
|
+
| authUrl (optional) | URL to authenticate against. Default: https://portal-api.idmission.com |
|
|
356
|
+
| submissionUrl (optional) | URL to submit data to. Default: https://portal-api.idmission.com/swagger |
|
|
357
|
+
| documentServiceUrl (optional) | URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/ |
|
|
358
|
+
| onBeforeDocumentUpload (optional) | callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. |
|
|
359
|
+
| onDocumentUploadProgress (optional) | callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. |
|
|
360
|
+
| onDocumentUploaded (optional) | callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. |
|
|
361
|
+
| onDocumentUploadFailed (optional) | callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. |
|
|
362
|
+
| onBeforeLivenessCheck (optional) | callback function that fires immediately prior to liveness check, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The liveness check request is passed in as a parameter and a promise resolving to the updated request should be returned. |
|
|
363
|
+
| onBeforeSubmit (optional) | callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. |
|
|
364
|
+
| onComplete (optional) | callback function that fires when the user has completed both flows. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. |
|
|
365
|
+
| onApproved (optional) | callback function that fires when the user completes both flows with a valid ID and passes the realness check. Arguments: same as onComplete. |
|
|
366
|
+
| onDenied (optional) | callback function that fires when the user completes both flows with an invalid ID or fails the realness check. Arguments: same as onComplete. |
|
|
367
|
+
| onExitCapture (optional) | callback function that fires when the user clicks the X button during capture. |
|
|
368
|
+
| onExitAfterFailure (optional) | callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. |
|
|
369
|
+
| onUserCancel (optional) | callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. |
|
|
370
|
+
| onCameraAccessDenied (optional) | callback function that fires when camera access is denied or lost. |
|
|
371
|
+
| captureSignature (optional) | boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false. |
|
|
372
|
+
| captureSignatureVideo (optional) | boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false. |
|
|
373
|
+
| captureAdditionalDocuments (optional) | array of additional documents to be captured, for available options consult the Additional Document Properties table below. |
|
|
374
|
+
| lang (optional) | language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. |
|
|
375
|
+
| precapturedDocuments (optional) | object to allow documents that have been previously captured to be submitted. Valid keys: idCardFront, idCardBack, passport. |
|
|
376
|
+
| idCaptureLoadingOverlayMode (optional) | string indicating which ID capture loading overlay screen should be used. Supported values: default and legacy. Defaults to default. |
|
|
377
|
+
| idCaptureRequirement (optional) | string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport. |
|
|
378
|
+
| idAutoCaptureEnabled (optional) | boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is true. |
|
|
379
|
+
| idCardAutoCaptureScoreThreshold (optional) | number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8. |
|
|
380
|
+
| passportAutoCaptureScoreThreshold (optional) | number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. |
|
|
381
|
+
| idCardFocusScoreThreshold (optional) | number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. Defaults to 0.3. |
|
|
382
|
+
| passportFocusScoreThreshold (optional) | number between 0 and 1 at which focus guidance score condition is considered to be met for passports. Defaults to 0.3. |
|
|
383
|
+
| faceLivenessLoadingOverlayMode (optional) | string indicating which face liveness loading overlay screen should be used. Supported values: default and legacy. Defaults to default. |
|
|
384
|
+
| faceLivenessTimeoutDurationMs (optional) | the duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000 (15 seconds). |
|
|
385
|
+
| skipSuccessScreen (optional) | boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false. |
|
|
386
|
+
| idCaptureInstructions (optional) | React element or string to render on the instructions screen. |
|
|
387
|
+
| idCaptureGuideType (optional) | string to indicate what type of guides to use during capture. Using fit is highly recommended in order to capture the best quality image. Valid values: fit, overlay. Defaults to fit. |
|
|
388
|
+
| idCapturePortraitGuidesOnMobile (optional) | boolean to indicate whether guide images should be rotated on mobile. Defaults to false. |
|
|
389
|
+
| idCaptureRotateLoadingOverlayImageWhenPortrait (optional) | boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to true. |
|
|
390
|
+
| companyId (optional) | company identifier to include with submission. |
|
|
391
|
+
| needImmediateResponse (optional) | boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. |
|
|
392
|
+
| manualReviewRequired (optional) | boolean flag to indicate whether responses should always be reviewed by a human. Defaults to false. |
|
|
393
|
+
| idBackImageRequired (optional) | boolean flag to indicate whether the back of the ID card image will be considered in processing decisions. Defaults to true. |
|
|
394
|
+
| idImageResolutionCheck (optional) | boolean to indicate if validation of the minimum resolution for an ID (x) document image should be triggeredDefaults to false. |
|
|
395
|
+
| verifyIdWithExternalDatabases (optional) | boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc. Defaults to false. |
|
|
396
|
+
| bypassAgeValidation (optional) | boolean to indicate whether end-users under the age of 18 should be allowed through validation. Defaults to false. |
|
|
397
|
+
| bypassNameMatching (optional) | boolean to indicate if matching the name in the request against the name extracted from the ID should be bypassed. Defaults to true. |
|
|
398
|
+
| personalData (optional) | object of personal data to store with the submitted ID. Valid keys: uniqueNumber, name, phone, phoneCountryCode, email, dob, gender, addressLine1, addressLine2, city, district, postalCode, country. |
|
|
399
|
+
| cardData (optional) | object of credit/debit card data to store with the submitted ID. Valid keys: cardToken, cardLast4, cardExpDate, nameOnCard. |
|
|
400
|
+
| webhooksEnabled (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked after submission. Defaults to false. |
|
|
401
|
+
| webhooksClientTraceId (optional) | a customer provided trace id to use when invoking customer-configured webhooks. |
|
|
402
|
+
| webhooksStripSpecialCharacters (optional) | boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true. |
|
|
403
|
+
| webhooksSendInputImages (optional) | boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
404
|
+
| webhooksSendProcessedImages (optional) | boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
405
|
+
| webhooksFireOnReview (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. Defaults to false. |
|
|
406
|
+
| sendBase64DocumentsInSwaggerProxy (optional) | boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. |
|
|
407
|
+
| theme (optional) | name of an included theme or object containing theme properties. |
|
|
408
|
+
| assets.idCapture (optional) | object containing any asset overrides, for available options consult the ID Capture Assets table above. |
|
|
409
|
+
| assets.faceLiveness (optional) | object containing any asset overrides, for available options consult the Face Liveness Assets table above. |
|
|
410
|
+
| colors.idCapture (optional) | object containing any color overrides, for available options consult the ID Capture Colors table above. |
|
|
411
|
+
| colors.faceLiveness (optional) | object containing any color overrides, for available options consult the Face Liveness Colors table above. |
|
|
412
|
+
| verbiage.idCapture (optional) | object containing any verbiage overrides, for available options consult the ID Capture Verbiage table above. |
|
|
413
|
+
| verbiage.faceLiveness (optional) | object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above. |
|
|
414
|
+
| verbiage.additionalDocumentCapture (optional) | object containing any verbiage overrides, for available options consult the additionalDocumentCapture fields in the ID Capture Verbiage table above. |
|
|
415
|
+
| verbiage.signatureCapture (optional) | object containing any verbiage overrides, for available options consult the signatureCapture fields in the ID Capture Verbiage table above. |
|
|
416
|
+
| geolocationEnabled (optional) | boolean flag to indicate whether users should be prompted to share their location. Defaults to true. |
|
|
417
|
+
| geolocationRequired (optional) | boolean flag to indicate whether users should be blocked from proceeding if they block location access. Defaults to false. |
|
|
418
|
+
| debugMode (optional) | boolean flag to enable on-screen prediction information output. Defaults to false. |
|
|
414
419
|
|
|
415
420
|
**Example**
|
|
416
421
|
|
|
@@ -424,6 +429,7 @@ IDmissionSDK.renderIdAndFaceValidation('#target-element', {
|
|
|
424
429
|
alert('Your ID or face realness could not be validated, you shall not pass!')
|
|
425
430
|
},
|
|
426
431
|
});
|
|
432
|
+
|
|
427
433
|
```
|
|
428
434
|
|
|
429
435
|
### CustomerIdAndBiometricsEnrollment
|
|
@@ -432,76 +438,75 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
|
|
|
432
438
|
|
|
433
439
|
**Props**
|
|
434
440
|
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
</table>
|
|
441
|
+
| sessionId | a session id generated with your IDmission credentials, or an async function that resolves to one. |
|
|
442
|
+
| --------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
443
|
+
| authUrl (optional) | URL to authenticate against. Default: https://portal-api.idmission.com |
|
|
444
|
+
| submissionUrl (optional) | URL to submit data to. Default: https://portal-api.idmission.com/swagger |
|
|
445
|
+
| documentServiceUrl (optional) | URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/ |
|
|
446
|
+
| onBeforeDocumentUpload (optional) | callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. |
|
|
447
|
+
| onDocumentUploadProgress (optional) | callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. |
|
|
448
|
+
| onDocumentUploaded (optional) | callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. |
|
|
449
|
+
| onDocumentUploadFailed (optional) | callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. |
|
|
450
|
+
| enrollmentId | the unique identifier to use for the customer to be enrolled. Overrides personalData.uniqueNumber if both are specified. |
|
|
451
|
+
| onBeforeSubmit (optional) | callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. |
|
|
452
|
+
| onComplete (optional) | callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. |
|
|
453
|
+
| onEnrolled (optional) | callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow successfully. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. |
|
|
454
|
+
| onDenied (optional) | callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow but could not be enrolled. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. |
|
|
455
|
+
| onExitCapture (optional) | callback function that fires when the user clicks the X button during capture. |
|
|
456
|
+
| onExitAfterFailure (optional) | callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. |
|
|
457
|
+
| onUserCancel (optional) | callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. |
|
|
458
|
+
| onCameraAccessDenied (optional) | callback function that fires when camera access is denied or lost. |
|
|
459
|
+
| captureSignature (optional) | boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false. |
|
|
460
|
+
| captureSignatureVideo (optional) | boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false. |
|
|
461
|
+
| captureAdditionalDocuments (optional) | array of additional documents to be captured, for available options consult the Additional Document Properties table below. |
|
|
462
|
+
| lang (optional) | language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. |
|
|
463
|
+
| idCaptureLoadingOverlayMode (optional) | string indicating which ID capture loading overlay screen should be used. Supported values: default and legacy. Defaults to default. |
|
|
464
|
+
| idCaptureRequirement (optional) | string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport. |
|
|
465
|
+
| idAutoCaptureEnabled (optional) | boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is true. |
|
|
466
|
+
| idCardAutoCaptureScoreThreshold (optional) | number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8. |
|
|
467
|
+
| passportAutoCaptureScoreThreshold (optional) | number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. |
|
|
468
|
+
| idCardFocusScoreThreshold (optional) | number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. Defaults to 0.3. |
|
|
469
|
+
| passportFocusScoreThreshold (optional) | number between 0 and 1 at which focus guidance score condition is considered to be met for passports. Defaults to 0.3. |
|
|
470
|
+
| faceLivenessLoadingOverlayMode (optional) | string indicating which face liveness loading overlay screen should be used. Supported values: default and legacy. Defaults to default. |
|
|
471
|
+
| faceLivenessTimeoutDurationMs (optional) | the duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000 (15 seconds). |
|
|
472
|
+
| skipSuccessScreen (optional) | boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false. |
|
|
473
|
+
| idCaptureInstructions (optional) | React element or string to render on the instructions screen. |
|
|
474
|
+
| idCaptureGuideType (optional) | string to indicate what type of guides to use during capture. Using fit is highly recommended in order to capture the best quality image. Valid values: fit, overlay. Defaults to fit. |
|
|
475
|
+
| idCapturePortraitGuidesOnMobile (optional) | boolean to indicate whether guide images should be rotated on mobile. Defaults to false. |
|
|
476
|
+
| idCaptureRotateLoadingOverlayImageWhenPortrait (optional) | boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to true. |
|
|
477
|
+
| companyId (optional) | company identifier to include with submission. |
|
|
478
|
+
| needImmediateResponse (optional) | boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. |
|
|
479
|
+
| manualReviewRequired (optional) | boolean flag to indicate whether responses should always be reviewed by a human. Defaults to false. |
|
|
480
|
+
| idBackImageRequired (optional) | boolean flag to indicate whether the back of the ID card image will be considered in processing decisions. Default is true |
|
|
481
|
+
| idImageResolutionCheck (optional) | boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Default is false |
|
|
482
|
+
| verifyIdWithExternalDatabases (optional) | boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc. Defaults to false. |
|
|
483
|
+
| bypassAgeValidation (optional) | boolean to indicate whether end-users under the age of 18 should be allowed through validation. Defaults to false. |
|
|
484
|
+
| bypassNameMatching (optional) | boolean to indicate if matching the name in the request against the name extracted from the ID should be bypassed. Defaults to true. |
|
|
485
|
+
| personalData (optional) | object of personal data to store with the submitted ID. Valid keys: uniqueNumber, name, phone, phoneCountryCode, email, dob, gender, addressLine1, addressLine2, city, district, postalCode, country. |
|
|
486
|
+
| cardData (optional) | object of credit/debit card data to store with the submitted ID. Valid keys: cardToken, cardLast4, cardExpDate, nameOnCard. |
|
|
487
|
+
| deduplicationEnabled (optional) | boolean flag indicating whether submissions from the same user should be de-duplicated. |
|
|
488
|
+
| deduplicationSynchronous (optional) | boolean flag indicating whether to wait for de-duplication to complete before allowing the user to proceed. |
|
|
489
|
+
| webhooksEnabled (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked after submission. Defaults to false. |
|
|
490
|
+
| webhooksClientTraceId (optional) | a customer provided trace id to use when invoking customer-configured webhooks. |
|
|
491
|
+
| webhooksStripSpecialCharacters (optional) | boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true. |
|
|
492
|
+
| webhooksSendInputImages (optional) | boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
493
|
+
| webhooksSendProcessedImages (optional) | boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
494
|
+
| webhooksFireOnReview (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. Defaults to false. |
|
|
495
|
+
| sendBase64DocumentsInSwaggerProxy (optional) | boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. |
|
|
496
|
+
| theme (optional) | name of an included theme or object containing theme properties. |
|
|
497
|
+
| assets.idCapture (optional) | object containing any asset overrides, for available options consult the ID Capture Assets table above. |
|
|
498
|
+
| assets.faceLiveness (optional) | object containing any asset overrides, for available options consult the Face Liveness Assets table above. |
|
|
499
|
+
| colors.idCapture (optional) | object containing any color overrides, for available options consult the ID Capture Colors table above. |
|
|
500
|
+
| colors.faceLiveness (optional) | object containing any color overrides, for available options consult the Face Liveness Colors table above. |
|
|
501
|
+
| colors.videoSignatureCapture (optional) | object containing any color overrides, for available options consult the videoSignatureCapture fields in the ID Capture Colors table above. |
|
|
502
|
+
| verbiage.idCapture (optional) | object containing any verbiage overrides, for available options consult the ID Capture Verbiage table above. |
|
|
503
|
+
| verbiage.faceLiveness (optional) | object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above. |
|
|
504
|
+
| verbiage.additionalDocumentCapture (optional) | object containing any verbiage overrides, for available options consult the additionalDocumentCapture fields in the ID Capture Verbiage table above. |
|
|
505
|
+
| verbiage.signatureCapture (optional) | object containing any verbiage overrides, for available options consult the signatureCapture fields in the ID Capture Verbiage table above. |
|
|
506
|
+
| verbiage.videoSignatureCapture (optional) | object containing any verbiage overrides, for available options consult the videoSignatureCapture fields in the ID Capture Verbiage table above. |
|
|
507
|
+
| geolocationEnabled (optional) | boolean flag to indicate whether users should be prompted to share their location. Defaults to true. |
|
|
508
|
+
| geolocationRequired (optional) | boolean flag to indicate whether users should be blocked from proceeding if they block location access. Defaults to false. |
|
|
509
|
+
| debugMode (optional) | boolean flag to enable on-screen prediction information output. Defaults to false. |
|
|
505
510
|
|
|
506
511
|
**Example**
|
|
507
512
|
|
|
@@ -510,6 +515,7 @@ IDmissionSDK.renderCustomerIdAndBiometricsEnrollment('#target-element', {
|
|
|
510
515
|
sessionId: 'my-idmission-session-id',
|
|
511
516
|
enrollmentId: 'some-guy',
|
|
512
517
|
});
|
|
518
|
+
|
|
513
519
|
```
|
|
514
520
|
|
|
515
521
|
### CustomerBiometricsEnrollment
|
|
@@ -518,53 +524,52 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
|
|
|
518
524
|
|
|
519
525
|
**Props**
|
|
520
526
|
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
</table>
|
|
527
|
+
| sessionId | a session id generated with your IDmission credentials, or an async function that resolves to one. |
|
|
528
|
+
| --------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
529
|
+
| authUrl (optional) | URL to authenticate against. Default: https://portal-api.idmission.com |
|
|
530
|
+
| submissionUrl (optional) | URL to submit data to. Default: https://portal-api.idmission.com/swagger |
|
|
531
|
+
| documentServiceUrl (optional) | URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/ |
|
|
532
|
+
| onBeforeDocumentUpload (optional) | callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. |
|
|
533
|
+
| onDocumentUploadProgress (optional) | callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. |
|
|
534
|
+
| onDocumentUploaded (optional) | callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. |
|
|
535
|
+
| onDocumentUploadFailed (optional) | callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. |
|
|
536
|
+
| enrollmentId | the unique identifier to use for the customer to be enrolled. Overrides personalData.uniqueNumber if both are specified. |
|
|
537
|
+
| onBeforeSubmit (optional) | callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. |
|
|
538
|
+
| onComplete (optional) | callback function that fires when the user has completed the CustomerBiometricsEnrollment flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. |
|
|
539
|
+
| onEnrolled (optional) | callback function that fires when the user has completed the CustomerBiometricsEnrollment flow successfully. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. |
|
|
540
|
+
| onDenied (optional) | callback function that fires when the user has completed the CustomerBiometricsEnrollment flow but could not be enrolled. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. |
|
|
541
|
+
| onExitCapture (optional) | callback function that fires when the user clicks the X button during capture. |
|
|
542
|
+
| onExitAfterFailure (optional) | callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. |
|
|
543
|
+
| onUserCancel (optional) | callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. |
|
|
544
|
+
| onCameraAccessDenied (optional) | callback function that fires when camera access is denied or lost. |
|
|
545
|
+
| captureSignature (optional) | boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false. |
|
|
546
|
+
| captureSignatureVideo (optional) | boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false. |
|
|
547
|
+
| captureAdditionalDocuments (optional) | array of additional documents to be captured, for available options consult the Additional Document Properties table below. |
|
|
548
|
+
| lang (optional) | language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. |
|
|
549
|
+
| loadingOverlayMode (optional) | string indicating which loading overlay screen should be used. Supported values: default and legacy. Defaults to default. |
|
|
550
|
+
| timeoutDurationMs (optional) | the duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000 (15 seconds). |
|
|
551
|
+
| skipSuccessScreen (optional) | boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false. |
|
|
552
|
+
| companyId (optional) | company identifier to include with submission. |
|
|
553
|
+
| needImmediateResponse (optional) | boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. |
|
|
554
|
+
| deduplicationEnabled (optional) | boolean flag indicating whether submissions from the same user should be de-duplicated. |
|
|
555
|
+
| deduplicationSynchronous (optional) | boolean flag indicating whether to wait for de-duplication to complete before allowing the user to proceed. |
|
|
556
|
+
| webhooksEnabled (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked after submission. Defaults to false. |
|
|
557
|
+
| webhooksClientTraceId (optional) | a customer provided trace id to use when invoking customer-configured webhooks. |
|
|
558
|
+
| webhooksStripSpecialCharacters (optional) | boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true. |
|
|
559
|
+
| webhooksSendInputImages (optional) | boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
560
|
+
| webhooksSendProcessedImages (optional) | boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
561
|
+
| sendBase64DocumentsInSwaggerProxy (optional) | boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. |
|
|
562
|
+
| theme (optional) | name of an included theme or object containing theme properties. |
|
|
563
|
+
| assets.faceLiveness (optional) | object containing any asset overrides, for available options consult the Face Liveness Assets table above. |
|
|
564
|
+
| colors.faceLiveness (optional) | object containing any color overrides, for available options consult the Face Liveness Colors table above. |
|
|
565
|
+
| colors.videoSignatureCapture (optional) | object containing any color overrides, for available options consult the videoSignatureCapture fields in the ID Capture Colors table above. |
|
|
566
|
+
| verbiage.faceLiveness (optional) | object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above. |
|
|
567
|
+
| verbiage.additionalDocumentCapture (optional) | object containing any verbiage overrides, for available options consult the additionalDocumentCapture fields in the ID Capture Verbiage table above. |
|
|
568
|
+
| verbiage.signatureCapture (optional) | object containing any verbiage overrides, for available options consult the signatureCapture fields in the ID Capture Verbiage table above. |
|
|
569
|
+
| verbiage.videoSignatureCapture (optional) | object containing any verbiage overrides, for available options consult the videoSignatureCapture fields in the ID Capture Verbiage table above. |
|
|
570
|
+
| geolocationEnabled (optional) | boolean flag to indicate whether users should be prompted to share their location. Defaults to true. |
|
|
571
|
+
| geolocationRequired (optional) | boolean flag to indicate whether users should be blocked from proceeding if they block location access. Defaults to false. |
|
|
572
|
+
| debugMode (optional) | boolean flag to enable on-screen prediction information output. Defaults to false. |
|
|
568
573
|
|
|
569
574
|
**Example**
|
|
570
575
|
|
|
@@ -573,6 +578,7 @@ IDmissionSDK.renderCustomerBiometricsEnrollment('#target-element', {
|
|
|
573
578
|
sessionId: 'my-idmission-session-id',
|
|
574
579
|
enrollmentId: 'some-guy',
|
|
575
580
|
});
|
|
581
|
+
|
|
576
582
|
```
|
|
577
583
|
|
|
578
584
|
### CustomerVerification
|
|
@@ -581,44 +587,43 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
581
587
|
|
|
582
588
|
**Props**
|
|
583
589
|
|
|
584
|
-
|
|
585
|
-
|
|
586
|
-
|
|
587
|
-
|
|
588
|
-
|
|
589
|
-
|
|
590
|
-
|
|
591
|
-
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
|
|
595
|
-
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
602
|
-
|
|
603
|
-
|
|
604
|
-
|
|
605
|
-
|
|
606
|
-
|
|
607
|
-
|
|
608
|
-
|
|
609
|
-
|
|
610
|
-
|
|
611
|
-
|
|
612
|
-
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
617
|
-
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
|
|
621
|
-
</table>
|
|
590
|
+
| sessionId | a session id generated with your IDmission credentials, or an async function that resolves to one. |
|
|
591
|
+
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
592
|
+
| authUrl (optional) | URL to authenticate against. Default: https://portal-api.idmission.com |
|
|
593
|
+
| submissionUrl (optional) | URL to submit data to. Default: https://portal-api.idmission.com/swagger |
|
|
594
|
+
| documentServiceUrl (optional) | URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/ |
|
|
595
|
+
| onBeforeDocumentUpload (optional) | callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. |
|
|
596
|
+
| onDocumentUploadProgress (optional) | callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. |
|
|
597
|
+
| onDocumentUploaded (optional) | callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. |
|
|
598
|
+
| onDocumentUploadFailed (optional) | callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. |
|
|
599
|
+
| enrollmentId | the unique identifier to match from previously enrolled customers. |
|
|
600
|
+
| onBeforeSubmit (optional) | callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. |
|
|
601
|
+
| onComplete (optional) | callback function that fires when the user has completed the CustomerVerification flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. |
|
|
602
|
+
| onCustomerMatched (optional) | callback function that fires when the user has completed the CustomerVerification flow and matches the specified customer enrollmentId. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. |
|
|
603
|
+
| onCustomerNotMatched (optional) | callback function that fires when the user has completed the CustomerVerification flow but does not match the specified customer enrollmentId. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. |
|
|
604
|
+
| onExitCapture (optional) | callback function that fires when the user clicks the X button during capture. |
|
|
605
|
+
| onExitAfterFailure (optional) | callback function that fires when the user clicks the exit button after failing the realness check. |
|
|
606
|
+
| onUserCancel (optional) | callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. |
|
|
607
|
+
| onCameraAccessDenied (optional) | callback function that fires when camera access is denied or lost. |
|
|
608
|
+
| lang (optional) | language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. |
|
|
609
|
+
| loadingOverlayMode (optional) | string indicating which loading overlay screen should be used. Supported values: default and legacy. Defaults to default. |
|
|
610
|
+
| timeoutDurationMs (optional) | the duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000 (15 seconds). |
|
|
611
|
+
| skipSuccessScreen (optional) | boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false. |
|
|
612
|
+
| companyId (optional) | company identifier to include with submission. |
|
|
613
|
+
| needImmediateResponse (optional) | boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. |
|
|
614
|
+
| webhooksEnabled (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked after submission. Defaults to false. |
|
|
615
|
+
| webhooksClientTraceId (optional) | a customer provided trace id to use when invoking customer-configured webhooks. |
|
|
616
|
+
| webhooksStripSpecialCharacters (optional) | boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true. |
|
|
617
|
+
| webhooksSendInputImages (optional) | boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
618
|
+
| webhooksSendProcessedImages (optional) | boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
619
|
+
| sendBase64DocumentsInSwaggerProxy (optional) | boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. |
|
|
620
|
+
| theme (optional) | name of an included theme or object containing theme properties. |
|
|
621
|
+
| assets (optional) | object containing any asset overrides, for available options consult the Face Liveness Assets table above. |
|
|
622
|
+
| colors (optional) | object containing any color overrides, for available options consult the Face Liveness Colors table above. |
|
|
623
|
+
| verbiage (optional) | object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above. |
|
|
624
|
+
| geolocationEnabled (optional) | boolean flag to indicate whether users should be prompted to share their location. Defaults to true. |
|
|
625
|
+
| geolocationRequired (optional) | boolean flag to indicate whether users should be blocked from proceeding if they block location access. Defaults to false. |
|
|
626
|
+
| debugMode (optional) | boolean flag to enable on-screen prediction information output. Defaults to false. |
|
|
622
627
|
|
|
623
628
|
**Example**
|
|
624
629
|
|
|
@@ -627,6 +632,7 @@ IDmissionSDK.renderCustomerVerification('#target-element', {
|
|
|
627
632
|
sessionId: 'my-idmission-session-id',
|
|
628
633
|
enrollmentId: 'some-guy',
|
|
629
634
|
});
|
|
635
|
+
|
|
630
636
|
```
|
|
631
637
|
|
|
632
638
|
### CustomerIdentification
|
|
@@ -635,107 +641,104 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
635
641
|
|
|
636
642
|
**Props**
|
|
637
643
|
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
|
|
644
|
-
|
|
645
|
-
|
|
646
|
-
|
|
647
|
-
|
|
648
|
-
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
652
|
-
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
|
|
663
|
-
|
|
664
|
-
|
|
665
|
-
|
|
666
|
-
|
|
667
|
-
|
|
668
|
-
|
|
669
|
-
|
|
670
|
-
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
</table>
|
|
644
|
+
| sessionId | a session id generated with your IDmission credentials, or an async function that resolves to one. |
|
|
645
|
+
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
646
|
+
| authUrl (optional) | URL to authenticate against. Default: https://portal-api.idmission.com |
|
|
647
|
+
| submissionUrl (optional) | URL to submit data to. Default: https://portal-api.idmission.com/swagger |
|
|
648
|
+
| documentServiceUrl (optional) | URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/ |
|
|
649
|
+
| onBeforeDocumentUpload (optional) | callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. |
|
|
650
|
+
| onDocumentUploadProgress (optional) | callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. |
|
|
651
|
+
| onDocumentUploaded (optional) | callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. |
|
|
652
|
+
| onDocumentUploadFailed (optional) | callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. |
|
|
653
|
+
| onBeforeSubmit (optional) | callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. |
|
|
654
|
+
| onComplete (optional) | callback function that fires when the user has completed the CustomerIdentification flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. |
|
|
655
|
+
| onCustomerMatched (optional) | callback function that fires when the user has completed the CustomerIdentification flow and matches a pre-registered customer enrollmentId in IDmission's database. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. |
|
|
656
|
+
| onCustomerNotMatched (optional) | callback function that fires when the user has completed the CustomerIdentification flow but does not match any registered customer. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. |
|
|
657
|
+
| onExitCapture (optional) | callback function that fires when the user clicks the X button during capture. |
|
|
658
|
+
| onExitAfterFailure (optional) | callback function that fires when the user clicks the exit button after failing the realness check. |
|
|
659
|
+
| onUserCancel (optional) | callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. |
|
|
660
|
+
| onCameraAccessDenied (optional) | callback function that fires when camera access is denied or lost. |
|
|
661
|
+
| loadingOverlayMode (optional) | string indicating which loading overlay screen should be used. Supported values: default and legacy. Defaults to default. |
|
|
662
|
+
| timeoutDurationMs (optional) | the duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000 (15 seconds). |
|
|
663
|
+
| skipSuccessScreen (optional) | boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false. |
|
|
664
|
+
| lang (optional) | language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. |
|
|
665
|
+
| companyId (optional) | company identifier to include with submission. |
|
|
666
|
+
| needImmediateResponse (optional) | boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. |
|
|
667
|
+
| webhooksEnabled (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked after submission. Defaults to false. |
|
|
668
|
+
| webhooksClientTraceId (optional) | a customer provided trace id to use when invoking customer-configured webhooks. |
|
|
669
|
+
| webhooksStripSpecialCharacters (optional) | boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true. |
|
|
670
|
+
| webhooksSendInputImages (optional) | boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
671
|
+
| webhooksSendProcessedImages (optional) | boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
672
|
+
| sendBase64DocumentsInSwaggerProxy (optional) | boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. |
|
|
673
|
+
| theme (optional) | name of an included theme or object containing theme properties. |
|
|
674
|
+
| assets (optional) | object containing any asset overrides, for available options consult the Assets table below. |
|
|
675
|
+
| colors (optional) | object containing any asset overrides, for available options consult the Colors table below. |
|
|
676
|
+
| verbiage (optional) | object containing any verbiage overrides, for available options consult the Verbiage table below. |
|
|
677
|
+
| geolocationEnabled (optional) | boolean flag to indicate whether users should be prompted to share their location. Defaults to true. |
|
|
678
|
+
| geolocationRequired (optional) | boolean flag to indicate whether users should be blocked from proceeding if they block location access. Defaults to false. |
|
|
679
|
+
| debugMode (optional) | boolean flag to enable on-screen prediction information output. Defaults to false. |
|
|
675
680
|
|
|
676
681
|
**Customer Identification Assets**
|
|
677
682
|
|
|
678
|
-
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
</table>
|
|
683
|
+
| loadingOverlay.instructionImageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png |
|
|
684
|
+
| ------------------------------------------ | ---------------------------------------------------------------------------- |
|
|
685
|
+
| loadingOverlay.cameraAccessDenied.imageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png |
|
|
686
|
+
| failure.imageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/manual\_capture.png |
|
|
683
687
|
|
|
684
688
|
**Customer Identification Colors**
|
|
685
689
|
|
|
686
|
-
|
|
687
|
-
|
|
688
|
-
|
|
689
|
-
|
|
690
|
-
|
|
691
|
-
|
|
692
|
-
|
|
693
|
-
|
|
694
|
-
|
|
695
|
-
|
|
696
|
-
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
701
|
-
|
|
702
|
-
|
|
703
|
-
|
|
704
|
-
|
|
705
|
-
|
|
706
|
-
|
|
707
|
-
</table>
|
|
690
|
+
| loadingOverlay.continueBtn.backgroundColor | Default: #16a085 |
|
|
691
|
+
| ---------------------------------------------------------- | ---------------- |
|
|
692
|
+
| loadingOverlay.continueBtn.textColor | Default: white |
|
|
693
|
+
| loadingOverlay.continueBtn.loadingBackgroundColor | Default: gray |
|
|
694
|
+
| loadingOverlay.continueBtn.loadingTextColor | Default: white |
|
|
695
|
+
| loadingOverlay.cameraAccessDenied.retryBtn.backgroundColor | Default: #ea8557 |
|
|
696
|
+
| loadingOverlay.cameraAccessDenied.retryBtn.textColor | Default: white |
|
|
697
|
+
| guidesUnsatisfiedColor | Default: white |
|
|
698
|
+
| guidesSatisfiedColor | Default: green |
|
|
699
|
+
| guidanceMessagesSatisfiedBackgroundColor | Default: green |
|
|
700
|
+
| guidanceMessagesUnsatisfiedBackgroundColor | Default: red |
|
|
701
|
+
| guidanceMessagesSatisfiedTextColor | Default: white |
|
|
702
|
+
| guidanceMessagesUnsatisfiedTextColor | Default: white |
|
|
703
|
+
| success.doneBtn.backgroundColor | Default: #16a085 |
|
|
704
|
+
| success.doneBtn.textColor | Default: white |
|
|
705
|
+
| success.retryBtn.backgroundColor | Default: #ea8557 |
|
|
706
|
+
| success.retryBtn.textColor | Default: white |
|
|
707
|
+
| failure.retryBtn.backgroundColor | Default: #ea8557 |
|
|
708
|
+
| failure.retryBtn.textColor | Default: white |
|
|
709
|
+
| failure.exitBtn.backgroundColor | Default: #666 |
|
|
710
|
+
| failure.exitBtn.textColor | Default: white |
|
|
708
711
|
|
|
709
712
|
**Customer Identification Verbiage**
|
|
710
713
|
|
|
711
|
-
|
|
712
|
-
|
|
713
|
-
|
|
714
|
-
|
|
715
|
-
|
|
716
|
-
|
|
717
|
-
|
|
718
|
-
|
|
719
|
-
|
|
720
|
-
|
|
721
|
-
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
733
|
-
</table>
|
|
714
|
+
| loadingOverlay.headingText | Default: "Use your device camera to capture your face" |
|
|
715
|
+
| ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
716
|
+
| loadingOverlay.removeEyeCoveringsText | Default: "Remove Sunglasses & Hat" |
|
|
717
|
+
| loadingOverlay.avoidExcessiveBacklightingText | Default: "Avoid Excessive Backlighting" |
|
|
718
|
+
| loadingOverlay.continueText | Default: "Continue" |
|
|
719
|
+
| loadingOverlay.cameraInitializingText | Default: "Camera initializing..." |
|
|
720
|
+
| loadingOverlay.modelsWarmingUpText | Default: "Models warming up..." |
|
|
721
|
+
| loadingOverlay.cameraAccessDenied.headingText | Default: "Your camera permission is disabled" |
|
|
722
|
+
| loadingOverlay.cameraAccessDenied.descriptionText | Default: "This application requires access to your camera to continue. Please accept the permission once prompted by the browser. If the browser does not prompt for camera permissions, you must go to settings and provide camera access to the current browser." |
|
|
723
|
+
| loadingOverlay.cameraAccessDenied.retryBtnText | Default: "Retry" |
|
|
724
|
+
| guidanceHoldStillText | Default: "Hold still for a few seconds..." |
|
|
725
|
+
| guidanceLookStraightText | Default: "Look straight into the camera..." |
|
|
726
|
+
| guidanceMoveBackText | Default: "Move back..." |
|
|
727
|
+
| guidanceMoveForwardText | Default: "Move forward..." |
|
|
728
|
+
| guidanceMoveToCenterText | Default: "Move to the center..." |
|
|
729
|
+
| progressPreviewText | Default: "Processing..." |
|
|
730
|
+
| success.headingText | Default: "Customer has been identified!" |
|
|
731
|
+
| success.retryBtnText | Default: "Retry" |
|
|
732
|
+
| success.doneBtnText | Default: "Done" |
|
|
733
|
+
| failure.headingText | Default: "Customer not found" |
|
|
734
|
+
| failure.retryBtnText | Default: "Retry" |
|
|
735
|
+
| failure.exitBtnText | Default: "Exit" |
|
|
734
736
|
|
|
735
737
|
**Example**
|
|
736
738
|
|
|
737
739
|
```js
|
|
738
740
|
IDmissionSDK.renderCustomerIdentification('#target-element', { sessionId: 'my-idmission-session-id' });
|
|
741
|
+
|
|
739
742
|
```
|
|
740
743
|
|
|
741
744
|
### VideoIdValidation
|
|
@@ -744,114 +747,111 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
|
|
|
744
747
|
|
|
745
748
|
**Props**
|
|
746
749
|
|
|
747
|
-
|
|
748
|
-
|
|
749
|
-
|
|
750
|
-
|
|
751
|
-
|
|
752
|
-
|
|
753
|
-
|
|
754
|
-
|
|
755
|
-
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
|
|
762
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
769
|
-
|
|
770
|
-
|
|
771
|
-
|
|
772
|
-
|
|
773
|
-
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
784
|
-
|
|
785
|
-
|
|
786
|
-
|
|
787
|
-
|
|
788
|
-
|
|
789
|
-
|
|
790
|
-
|
|
791
|
-
|
|
792
|
-
|
|
793
|
-
|
|
794
|
-
|
|
795
|
-
|
|
796
|
-
|
|
797
|
-
|
|
798
|
-
|
|
799
|
-
|
|
800
|
-
|
|
801
|
-
|
|
802
|
-
|
|
803
|
-
|
|
804
|
-
|
|
805
|
-
|
|
806
|
-
|
|
807
|
-
|
|
808
|
-
|
|
809
|
-
|
|
810
|
-
</table>
|
|
750
|
+
| sessionId | a session id generated with your IDmission credentials, or an async function that resolves to one. |
|
|
751
|
+
| --------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
752
|
+
| authUrl (optional) | URL to authenticate against. Default: https://portal-api.idmission.com |
|
|
753
|
+
| submissionUrl (optional) | URL to submit data to. Default: https://portal-api.idmission.com/swagger |
|
|
754
|
+
| documentServiceUrl (optional) | URL to upload image/video/audio assets to via [tus](https://tus.io/). Default: https://portal-api.idmission.com/files/ |
|
|
755
|
+
| onBeforeDocumentUpload (optional) | callback function that fires immediately prior to each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document contents before it is exchanged for a document token. The document content and metadata are passed in as parameters and a promise resolving to void or false should be returned. If the returned promise resolves to false, the document will not be uploaded. |
|
|
756
|
+
| onDocumentUploadProgress (optional) | callback function that fires when progress information is available for a document upload. The progress info and metadata are passed in as parameters. |
|
|
757
|
+
| onDocumentUploaded (optional) | callback function that fires immediately after each document upload, giving the client application an opportunity to specify custom asynchronous logic that captures the document token. The document token and metadata are passed in as parameters. |
|
|
758
|
+
| onDocumentUploadFailed (optional) | callback function that fires when a document failed to upload. The error and metadata are passed in as parameters. |
|
|
759
|
+
| onBeforeSubmit (optional) | callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. |
|
|
760
|
+
| onSubmit (optional) | callback function that fires when the user has completed the flow instead of making a call to IDmission's servers, allowing customers to specify their own submission logic. Arguments: the request payload that would have been dispatched to IDmission's API, which contains the images/documents/video submitted by the user. Note that when this parameter is supplied, onComplete will never fire, and the customer will need to implement their own error handling/retry logic. Use at your own risk! |
|
|
761
|
+
| onComplete (optional) | callback function that fires when the user has completed the VideoIdValidation flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. |
|
|
762
|
+
| onExitCapture (optional) | callback function that fires when the user clicks the X button during capture. |
|
|
763
|
+
| onExitAfterFailure (optional) | callback function that fires when the user clicks the exit button after failing the realness check. |
|
|
764
|
+
| onUserCancel (optional) | callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. |
|
|
765
|
+
| onCameraAccessDenied (optional) | callback function that fires when camera access is denied or lost. |
|
|
766
|
+
| onMicrophoneAccessDenied (optional) | callback function that fires when microphone access is denied or lost. |
|
|
767
|
+
| lang (optional) | language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. |
|
|
768
|
+
| captureSignature (optional) | boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false. |
|
|
769
|
+
| captureSignatureVideo (optional) | boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false. |
|
|
770
|
+
| captureAdditionalDocuments (optional) | array of additional documents to be captured, for available options consult the Additional Document Properties table below. |
|
|
771
|
+
| companyId (optional) | company identifier to include with submission. |
|
|
772
|
+
| needImmediateResponse (optional) | boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true. |
|
|
773
|
+
| manualReviewRequired (optional) | boolean flag to indicate whether responses should always be reviewed by a human. Defaults to false. |
|
|
774
|
+
| idBackImageRequired (optional) | boolean flag to indicate whether the back of the ID card image will be considered in processing decisions. Defaults to true. |
|
|
775
|
+
| idImageResolutionCheck (optional) | boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Default is true. |
|
|
776
|
+
| verifyIdWithExternalDatabases (optional) | boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc. Defaults to false. |
|
|
777
|
+
| bypassAgeValidation (optional) | boolean to indicate whether end-users under the age of 18 should be allowed through validation. Defaults to false. |
|
|
778
|
+
| bypassNameMatching (optional) | boolean to indicate if matching the name in the request against the name extracted from the ID should be bypassed. Defaults to true. |
|
|
779
|
+
| personalData (optional) | object of personal data to store with the submitted ID. Valid keys: uniqueNumber, name, phone, phoneCountryCode, email, dob, gender, addressLine1, addressLine2, city, district, postalCode, country. |
|
|
780
|
+
| cardData (optional) | object of credit/debit card data to store with the submitted ID. Valid keys: cardToken, cardLast4, cardExpDate, nameOnCard. |
|
|
781
|
+
| webhooksEnabled (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked after submission. Defaults to false. |
|
|
782
|
+
| webhooksClientTraceId (optional) | a customer provided trace id to use when invoking customer-configured webhooks. |
|
|
783
|
+
| webhooksStripSpecialCharacters (optional) | boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. Defaults to true. |
|
|
784
|
+
| webhooksSendInputImages (optional) | boolean flag to indicate whether raw user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
785
|
+
| webhooksSendProcessedImages (optional) | boolean flag to indicate whether processed user-captured images should be included in the submission data when customer-configured webhooks are invoked. Defaults to false. |
|
|
786
|
+
| webhooksFireOnReview (optional) | boolean flag to indicate whether customer-configured webhooks should be invoked upon ID being marked for manual review. Defaults to false. |
|
|
787
|
+
| idCaptureProps (optional) | object containing any overrides for IDValidation. |
|
|
788
|
+
| faceLivenessProps (optional) | object containing any overrides for IDValidation. |
|
|
789
|
+
| idCardFrontDetectionThreshold (optional) | number between 0 and 1 at which document detection guidance score condition is considered to be met for the ID card front during video capture. Defaults to 0.48. |
|
|
790
|
+
| idCardFrontFocusThreshold (optional) | number between 0 and 1 at which focus guidance score condition is considered to be met for the ID card front during video capture. Defaults to 0.15. |
|
|
791
|
+
| goodIdCardFrontFramesThreshold (optional) | number of good frames of the ID card front that must be captured before moving on during video capture. Defaults to 3. |
|
|
792
|
+
| showIdCardBackDurationMs (optional) | the duration of time in milliseconds that the user is instructed to show the back of their ID card during video capture. Defaults to 5000ms. |
|
|
793
|
+
| readTextPrompt (optional) | an optional text prompt to display on screen for the user to read during video capture after the ID card has been shown. Leave blank to skip the read text screen. |
|
|
794
|
+
| readTextTimeoutDurationMs (optional) | the duration of time in milliseconds that the user is allowed to spend reading the readTextPrompt. Defaults to 15000 (15 seconds). |
|
|
795
|
+
| readTextMinReadingMs (optional) | the duration of time in milliseconds that the user is forced to spend reading the readTextPrompt before they can click the Done button. Defaults to 10000 (10 seconds). |
|
|
796
|
+
| skipSuccessScreen (optional) | boolean or async function to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false. |
|
|
797
|
+
| skipIdCapture (optional) | boolean to indicate whether to skip the initial ID capture flow. Note that when this flag is set, submission to IDmission's servers will not be attempted; it should be used in tandem with onSubmit. Defaults to false. |
|
|
798
|
+
| skipShowIdCardBack (optional) | boolean or async function to indicate whether to instruct the user to show the back of their ID card during video capture. If an async function is supplied returning a boolean, it will be evaluated at the time of ID front video capture completion. Defaults to false. |
|
|
799
|
+
| idCaptureLoadingOverlayMode (optional) | string indicating which ID capture loading overlay screen should be used. Supported values: default and legacy. Defaults to default. |
|
|
800
|
+
| idCaptureGuideType (optional) | string to indicate what type of guides to use during capture. Using fit is highly recommended in order to capture the best quality image. Valid values: fit, overlay. Defaults to fit. |
|
|
801
|
+
| idCapturePortraitGuidesOnMobile (optional) | boolean to indicate whether guide images should be rotated on mobile. Defaults to false. |
|
|
802
|
+
| idCaptureRotateLoadingOverlayImageWhenPortrait (optional) | boolean to indicate whether loading overlay image should be rotated on when mobile guides are rotated. Defaults to true. |
|
|
803
|
+
| faceLivenessLoadingOverlayMode (optional) | string indicating which face liveness loading overlay screen should be used. Supported values: default and legacy. Defaults to default. |
|
|
804
|
+
| sendBase64DocumentsInSwaggerProxy (optional) | boolean flag to enable download and replace behavior for documents in the Swagger Proxy API. Defaults to false. |
|
|
805
|
+
| mergeAVStreams (optional) | boolean flag to indicate whether recorded audio should be merged onto the recorded video stream before submission. Defaults to false. |
|
|
806
|
+
| theme (optional) | name of an included theme or object containing theme properties. |
|
|
807
|
+
| assets (optional) | object containing any asset overrides, for available options consult the Assets table below. |
|
|
808
|
+
| colors (optional) | object containing any asset overrides, for available options consult the Colors table below. |
|
|
809
|
+
| verbiage (optional) | object containing any verbiage overrides, for available options consult the Verbiage table below. |
|
|
810
|
+
| geolocationEnabled (optional) | boolean flag to indicate whether users should be prompted to share their location. Defaults to true. |
|
|
811
|
+
| geolocationRequired (optional) | boolean flag to indicate whether users should be blocked from proceeding if they block location access. Defaults to false. |
|
|
812
|
+
| debugMode (optional) | boolean flag to enable on-screen prediction information output. Defaults to false. |
|
|
811
813
|
|
|
812
814
|
**Video ID Validation Assets**
|
|
813
815
|
|
|
814
|
-
|
|
815
|
-
|
|
816
|
-
|
|
817
|
-
|
|
818
|
-
|
|
819
|
-
</table>
|
|
816
|
+
| idCapture (optional) | object containing any asset overrides, for available options consult the ID Capture Assets table above. |
|
|
817
|
+
| ----------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
818
|
+
| faceLiveness (optional) | object containing any asset overrides, for available options consult the Face Liveness Assets table above. |
|
|
819
|
+
| videoIdCapture.guides.frontImageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Front-SVG-Landscape-2.svg |
|
|
820
|
+
| videoIdCapture.guides.backImageUrl | Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Back-SVG-Landscape-2.svg |
|
|
820
821
|
|
|
821
822
|
**Video ID Validation Colors**
|
|
822
823
|
|
|
823
|
-
|
|
824
|
-
|
|
825
|
-
|
|
826
|
-
|
|
827
|
-
|
|
828
|
-
|
|
829
|
-
|
|
830
|
-
|
|
831
|
-
|
|
832
|
-
|
|
833
|
-
|
|
834
|
-
</table>
|
|
824
|
+
| idCapture (optional) | object containing any color overrides, for available options consult the ID Capture Colors table above. |
|
|
825
|
+
| ---------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
|
|
826
|
+
| faceLiveness (optional) | object containing any color overrides, for available options consult the Face Liveness Colors table above. |
|
|
827
|
+
| idVideoCapture.guidesSatisfiedColor | Default: green |
|
|
828
|
+
| idVideoCapture.guidesUnsatisfiedColor | Default: white |
|
|
829
|
+
| idVideoCapture.readTextDoneBtn.backgroundColor | Default: #16a085 |
|
|
830
|
+
| idVideoCapture.readTextDoneBtn.textColor | Default: white |
|
|
831
|
+
| success.doneBtn.backgroundColor | Default: #16a085 |
|
|
832
|
+
| success.doneBtn.textColor | Default: white |
|
|
833
|
+
| success.retryBtn.backgroundColor | Default: #ea8557 |
|
|
834
|
+
| success.retryBtn.textColor | Default: white |
|
|
835
835
|
|
|
836
836
|
**Video ID Validation Verbiage**
|
|
837
837
|
|
|
838
|
-
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
|
|
849
|
-
</table>
|
|
838
|
+
| idCapture (optional) | object containing any verbiage overrides, for available options consult the ID Capture Verbiage table above. |
|
|
839
|
+
| -------------------------------------------- | --------------------------------------------------------------------------------------------------------------- |
|
|
840
|
+
| faceLiveness (optional) | object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above. |
|
|
841
|
+
| idVideoCapture.guides.idFrontInstructionText | Default: "Display the front of your ID card..." |
|
|
842
|
+
| idVideoCapture.guides.idBackInstructionText | Default: "Display the back of your ID card..." |
|
|
843
|
+
| idVideoCapture.guides.flipIdInstructionText | Default: "Please flip your ID card..." |
|
|
844
|
+
| idVideoCapture.readTextHeading | Default: "Please read the following text aloud" |
|
|
845
|
+
| idVideoCapture.readTextDoneBtnText | Default: "Done" |
|
|
846
|
+
| success.headingText | Default: "Video ID has been successfully captured!" |
|
|
847
|
+
| success.retryBtnText | Default: "Retry" |
|
|
848
|
+
| success.doneBtnText | Default: "Done" |
|
|
850
849
|
|
|
851
850
|
**Example**
|
|
852
851
|
|
|
853
852
|
```js
|
|
854
853
|
IDmissionSDK.renderVideoIdValidation('#target-element', { sessionId: 'my-idmission-session-id' });
|
|
854
|
+
|
|
855
855
|
```
|
|
856
856
|
|
|
857
857
|
## Other Functionality
|
|
@@ -868,26 +868,31 @@ You can also capture this information from the event fired at load time via `e.d
|
|
|
868
868
|
console.log('web sdk version:', e.detail.webSdkVersion)
|
|
869
869
|
})
|
|
870
870
|
</script>
|
|
871
|
+
|
|
871
872
|
```
|
|
872
873
|
|
|
873
874
|
### Preloading the models
|
|
874
875
|
|
|
875
|
-
If you would like to programmatically issue a command to begin downloading and preparing the models on the client's browser
|
|
876
|
+
If you would like to programmatically issue a command to begin downloading and preparing the models on the client's browser _before_ they enter a customer flow, the following method is available:
|
|
877
|
+
|
|
876
878
|
```html
|
|
877
879
|
<script type="module">
|
|
878
880
|
document.addEventListener('idmission-web-sdk.ready', (e) => {
|
|
879
881
|
IDmissionSDK.preloadModels()
|
|
880
882
|
})
|
|
881
883
|
</script>
|
|
884
|
+
|
|
882
885
|
```
|
|
883
886
|
|
|
884
887
|
You may specify which models should be loaded and which should be skipped by supplying an object argument, like so:
|
|
888
|
+
|
|
885
889
|
```js
|
|
886
890
|
IDmissionSDK.preloadModels({
|
|
887
891
|
documentDetectionModel: true,
|
|
888
892
|
focusModel: true,
|
|
889
893
|
faceDetectionModel: false,
|
|
890
894
|
})
|
|
895
|
+
|
|
891
896
|
```
|
|
892
897
|
|
|
893
898
|
This can be useful if, for example, you know you won't need any flows that depend on face detection.
|
|
@@ -903,6 +908,7 @@ onBeforeSubmit: () => new Promise((resolve) => {
|
|
|
903
908
|
// do whatever you want in here, websdk will delay submission until you call:
|
|
904
909
|
resolve()
|
|
905
910
|
})
|
|
911
|
+
|
|
906
912
|
```
|
|
907
913
|
|
|
908
914
|
Calling `resolve()` without an argument as shown above will result in no modification being made to the request that will be sent to IDmission's servers.
|
|
@@ -914,6 +920,7 @@ onBeforeSubmit: (req) => new Promise((resolve) => {
|
|
|
914
920
|
req.myRandomExtraThing = '123'
|
|
915
921
|
resolve(req)
|
|
916
922
|
})
|
|
923
|
+
|
|
917
924
|
```
|
|
918
925
|
|
|
919
926
|
Note that you will receive the request as a parameter to `onBeforeSubmit`, and must `resolve` with the altered version in order for your changes to be committed.
|
|
@@ -938,6 +945,7 @@ verbiage: {
|
|
|
938
945
|
}
|
|
939
946
|
}
|
|
940
947
|
}
|
|
948
|
+
|
|
941
949
|
```
|
|
942
950
|
|
|
943
951
|
Leaving a locale out of your translation object will result in the default text being shown for that locale, with the rest of your provided translations being honored. This functionality can be leveraged to define translations for languages that the IDmission Web SDK does not yet support. If you end up creating full translations for new languages, feel free to send your translations our way at https://www.idmission.com/company/contact-us/, and we will try to get them added to the main SDK translation set!
|
|
@@ -950,17 +958,10 @@ Many customer flow documented above include a `captureAdditionalDocuments` prope
|
|
|
950
958
|
|
|
951
959
|
**Additional Document Properties**
|
|
952
960
|
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
<tr>
|
|
961
|
-
<td><code>skip</code> (optional)</td><td>async function that may return a boolean indicating whether this document should be skipped</td>
|
|
962
|
-
</tr>
|
|
963
|
-
<tr>
|
|
964
|
-
<td><code>processAsPOA</code> (optional)</td><td>boolean indicating whether the document should be treated as a proof of address -- when true, the document will be processed and validated on the server.</td>
|
|
965
|
-
</tr>
|
|
966
|
-
</table>
|
|
961
|
+
| name | string indicating the name of document to be captured |
|
|
962
|
+
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
|
963
|
+
| description (optional) | string describing to the user anything extra about the document that they should know |
|
|
964
|
+
| skip (optional) | async function that may return a boolean indicating whether this document should be skipped |
|
|
965
|
+
| processAsPOA (optional) | boolean indicating whether the document should be treated as a proof of address -- when true, the document will be processed and validated on the server. |
|
|
966
|
+
|
|
967
|
+
# HELLO
|