idmission-web-sdk 0.0.55 → 0.0.57
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 +151 -75
- package/dist/components/CompositeWizard.d.ts +4 -4
- package/dist/components/additional_document_capture/AdditionalDocumentCaptureWizard.d.ts +0 -4
- package/dist/components/camera/CameraAccessDeniedOverlay.d.ts +18 -3
- package/dist/components/common/LoaderButton.d.ts +16 -0
- package/dist/components/customer_flows/CustomerBiometricsEnrollment.d.ts +21 -8
- package/dist/components/customer_flows/CustomerIdAndBiometricsEnrollment.d.ts +25 -11
- package/dist/components/customer_flows/IdAndFaceValidation.d.ts +21 -10
- package/dist/components/customer_flows/IdValidation.d.ts +15 -7
- package/dist/components/customer_flows/SignatureKYC.d.ts +3 -3
- package/dist/components/customer_identification/CustomerIdentificationFailure.d.ts +15 -3
- package/dist/components/customer_identification/CustomerIdentificationSuccess.d.ts +12 -3
- package/dist/components/customer_identification/CustomerIdentificationWizard.d.ts +13 -15
- package/dist/components/customer_verification/CustomerVerificationFailure.d.ts +15 -3
- package/dist/components/customer_verification/CustomerVerificationSuccess.d.ts +12 -3
- package/dist/components/customer_verification/CustomerVerificationWizard.d.ts +13 -14
- package/dist/components/face_liveness/FaceLivenessFailure.d.ts +15 -3
- package/dist/components/face_liveness/FaceLivenessSuccess.d.ts +11 -2
- package/dist/components/face_liveness/FaceLivenessWizard.d.ts +13 -15
- package/dist/components/id_capture/FlipIdPrompt.d.ts +12 -6
- package/dist/components/id_capture/IdCaptureLoadingOverlay.d.ts +18 -5
- package/dist/components/id_capture/IdCaptureSuccess.d.ts +15 -6
- package/dist/components/id_capture/IdCaptureWizard.d.ts +21 -33
- package/dist/components/selfie_capture/SelfieCaptureLoadingOverlay.d.ts +18 -3
- package/dist/components/signature_capture/SignatureCapture.d.ts +0 -5
- package/dist/components/{signature_capture → video_signature_capture}/VideoSignatureCapture.d.ts +4 -3
- package/dist/components/video_signature_capture/VideoSignatureLoadingOverlay.d.ts +8 -0
- package/dist/components/video_signature_capture/VideoSignatureSuccess.d.ts +19 -0
- package/dist/components/video_signature_capture/VideoSignatureWizard.d.ts +28 -0
- package/dist/lib/locales/es/translation.d.ts +1 -1
- package/dist/lib/locales/index.d.ts +1 -1
- package/dist/sdk2.cjs.development.js +694 -811
- package/dist/sdk2.cjs.development.js.map +1 -1
- package/dist/sdk2.cjs.production.js +1 -1
- package/dist/sdk2.cjs.production.js.map +1 -1
- package/dist/sdk2.esm.js +695 -812
- package/dist/sdk2.esm.js.map +1 -1
- package/dist/sdk2.umd.development.js +694 -811
- 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/stories/SignatureCapture/VideoSignatureCapture.stories.d.ts +1 -1
- package/package.json +1 -1
- package/dist/components/id_capture/IdCaptureSubmitBtn.d.ts +0 -7
- package/dist/components/signature_kyc/SignatureKYCLoadingOverlay.d.ts +0 -12
- package/dist/components/signature_kyc/SignatureKYCSuccess.d.ts +0 -10
- package/dist/components/signature_kyc/SignatureKYCWizard.d.ts +0 -26
package/README.md
CHANGED
|
@@ -79,49 +79,79 @@ Render a fullscreen ID capture component that instructs the user to photograph b
|
|
|
79
79
|
<table>
|
|
80
80
|
<tr><td><code>documentDetectionModelUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/models/documentdetection448/model.json</td></tr>
|
|
81
81
|
<tr><td><code>focusModelUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/models/focus/model.json</td></tr>
|
|
82
|
-
<tr><td><code>
|
|
83
|
-
<tr><td><code>
|
|
84
|
-
<tr><td><code>
|
|
85
|
-
<tr><td><code>
|
|
86
|
-
<tr><td><code>
|
|
87
|
-
<tr><td><code>
|
|
88
|
-
<tr><td><code>
|
|
82
|
+
<tr><td><code>loadingOverlay.instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/WebSDK-Instruction-DL-Capture-3-Portrait.png</td></tr>
|
|
83
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.imageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png</td></tr>
|
|
84
|
+
<tr><td><code>idCardFront.portraitGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Front-SVG-Portrait-2.svg</td></tr>
|
|
85
|
+
<tr><td><code>idCardFront.landscapeGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Landscape-SVG-Portrait-2.svg</td></tr>
|
|
86
|
+
<tr><td><code>idCardBack.portraitGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Back-SVG-Portrait-2.svg</td></tr>
|
|
87
|
+
<tr><td><code>idCardBack.landscapeGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Back-SVG-Landscape-2.svg</td></tr>
|
|
88
|
+
<tr><td><code>passport.portraitGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-Passport-Front-SVG-Portrait-2.svg</td></tr>
|
|
89
|
+
<tr><td><code>passport.landscapeGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-Passport-Front-SVG-Landscape-2.svg</td></tr>
|
|
90
|
+
<tr><td><code>flipIdPrompt.frontPortraitGuidesImageUrl</code></td><td>Default: value of idCardFront.portraitGuidesImageUrl</td></tr>
|
|
91
|
+
<tr><td><code>flipIdPrompt.frontLandscapeGuidesImageUrl</code></td><td>Default: value of idCardFront.landscapeGuidesImageUrl</td></tr>
|
|
92
|
+
<tr><td><code>flipIdPrompt.backPortraitGuidesImageUrl</code></td><td>Default: value of idCardBack.portraitGuidesImageUrl</td></tr>
|
|
93
|
+
<tr><td><code>flipIdPrompt.backLandscapeGuidesImageUrl</code></td><td>Default: value of idCardBack.landscapeGuidesImageUrl</td></tr>
|
|
89
94
|
</table>
|
|
90
95
|
|
|
91
96
|
**ID Capture Colors**
|
|
92
97
|
<table>
|
|
98
|
+
<tr><td><code>loadingOverlay.continueBtn.backgroundColor</code></td><td>Default: #16a085</td></tr>
|
|
99
|
+
<tr><td><code>loadingOverlay.continueBtn.textColor</code></td><td>Default: white</td></tr>
|
|
100
|
+
<tr><td><code>loadingOverlay.continueBtn.loadingBackgroundColor</code></td><td>Default: gray</td></tr>
|
|
101
|
+
<tr><td><code>loadingOverlay.continueBtn.loadingTextColor</code></td><td>Default: white</td></tr>
|
|
102
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.retryBtn.backgroundColor</code></td><td>Default: #ea8557</td></tr>
|
|
103
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.retryBtn.textColor</code></td><td>Default: white</td></tr>
|
|
93
104
|
<tr><td><code>guideBoxUnsatisfiedColor</code></td><td>Default: white</td></tr>
|
|
94
105
|
<tr><td><code>guideBoxSatisfiedColor</code></td><td>Default: green</td></tr>
|
|
106
|
+
<tr><td><code>videoSignatureCapture.success.retryBtn.backgroundColor</code></td><td>Default: #ea8557</td></tr>
|
|
107
|
+
<tr><td><code>videoSignatureCapture.success.retryBtn.textColor</code></td><td>Default: white</td></tr>
|
|
108
|
+
<tr><td><code>success.doneBtn.backgroundColor</code></td><td>Default: #16a085</td></tr>
|
|
109
|
+
<tr><td><code>success.doneBtn.textColor</code></td><td>Default: white</td></tr>
|
|
110
|
+
<tr><td><code>success.retryBtn.backgroundColor</code></td><td>Default: #ea8557</td></tr>
|
|
111
|
+
<tr><td><code>success.retryBtn.textColor</code></td><td>Default: white</td></tr>
|
|
95
112
|
</table>
|
|
96
113
|
|
|
97
114
|
**ID Capture Verbiage**
|
|
98
115
|
|
|
99
116
|
<table>
|
|
100
|
-
<tr><td><code>
|
|
101
|
-
<tr><td><code>
|
|
102
|
-
<tr><td><code>
|
|
103
|
-
<tr><td><code>
|
|
104
|
-
<tr><td><code>
|
|
105
|
-
<tr><td><code>
|
|
106
|
-
<tr><td><code>
|
|
107
|
-
<tr><td><code>
|
|
108
|
-
<tr><td><code>
|
|
109
|
-
<tr><td><code>
|
|
110
|
-
<tr><td><code>
|
|
111
|
-
<tr><td><code>
|
|
112
|
-
<tr><td><code>
|
|
113
|
-
<tr><td><code>
|
|
114
|
-
<tr><td><code>
|
|
115
|
-
<tr><td><code>
|
|
116
|
-
<tr><td><code>
|
|
117
|
-
<tr><td><code>
|
|
118
|
-
<tr><td><code>
|
|
119
|
-
<tr><td><code>
|
|
120
|
-
<tr><td><code>
|
|
121
|
-
<tr><td><code>
|
|
122
|
-
<tr><td><code>
|
|
123
|
-
<tr><td><code>
|
|
124
|
-
<tr><td><code>
|
|
117
|
+
<tr><td><code>loadingOverlay.headingText</code></td><td>Default: "Use your device camera to capture your ID"</td></tr>
|
|
118
|
+
<tr><td><code>loadingOverlay.useContinuityCameraText</code></td><td>Default: "Use your iPhone as a webcam"</td></tr>
|
|
119
|
+
<tr><td><code>loadingOverlay.modelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
|
|
120
|
+
<tr><td><code>loadingOverlay.cameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
|
|
121
|
+
<tr><td><code>loadingOverlay.continueText</code></td><td>Default: "Continue"</td></tr>
|
|
122
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.headingText</code></td><td>Default: "Your camera permission is disabled"</td></tr>
|
|
123
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.descriptionText</code></td><td>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."</td></tr>
|
|
124
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.retryBtnText</code></td><td>Default: "Retry"</td></tr>
|
|
125
|
+
<tr><td><code>idCardFront.instructionText</code></td><td>Default: "Scan the front of ID"</td></tr>
|
|
126
|
+
<tr><td><code>idCardFront.capturingText</code></td><td>Default: "Capturing..."</td></tr>
|
|
127
|
+
<tr><td><code>idCardFront.captureFailedText</code></td><td>Default: "Capture failed!"</td></tr>
|
|
128
|
+
<tr><td><code>idCardBack.instructionText</code></td><td>Default: "Scan the back of ID"</td></tr>
|
|
129
|
+
<tr><td><code>idCardBack.capturingText</code></td><td>Default: "Capturing..."</td></tr>
|
|
130
|
+
<tr><td><code>idCardBack.captureFailedText</code></td><td>Default: "Capture failed!"</td></tr>
|
|
131
|
+
<tr><td><code>passport.instructionText</code></td><td>Default: "Scan the ID page of passport"</td></tr>
|
|
132
|
+
<tr><td><code>passport.capturingText</code></td><td>Default: "Capturing..."</td></tr>
|
|
133
|
+
<tr><td><code>passport.captureFailedText</code></td><td>Default: "Capture failed!"</td></tr>
|
|
134
|
+
<tr><td><code>flipIdPrompt.instructionText</code></td><td>Default: "Please flip your ID card..."</td></tr>
|
|
135
|
+
<tr><td><code>additionalDocumentCapture.headingText</code></td><td>Default: "Additional document capture"</td></tr>
|
|
136
|
+
<tr><td><code>additionalDocumentCapture.nextBtnText</code></td><td>Default: "Next"</td></tr>
|
|
137
|
+
<tr><td><code>signatureCapture.headingText</code></td><td>Default: "Please sign the box below"</td></tr>
|
|
138
|
+
<tr><td><code>signatureCapture.acceptBtnText</code></td><td>Default: "Accept"</td></tr>
|
|
139
|
+
<tr><td><code>signatureCapture.clearBtnText</code></td><td>Default: "Clear"</td></tr>
|
|
140
|
+
<tr><td><code>videoSignatureCapture.faceLiveness</code></td><td>Default: see Face Liveness Verbiage section below</td></tr>
|
|
141
|
+
<tr><td><code>videoSignatureCapture.guidanceMessageText</code></td><td>Default: "Please sign the box below"</td></tr>
|
|
142
|
+
<tr><td><code>videoSignatureCapture.acceptBtnText</code></td><td>Default: "Accept"</td></tr>
|
|
143
|
+
<tr><td><code>videoSignatureCapture.clearBtnText</code></td><td>Default: "Clear"</td></tr>
|
|
144
|
+
<tr><td><code>videoSignatureCapture.success.headingText</code></td><td>Default: "Video signature has been successfully captured!"</td></tr>
|
|
145
|
+
<tr><td><code>videoSignatureCapture.success.doneBtnText</code></td><td>Default: "Done"</td></tr>
|
|
146
|
+
<tr><td><code>videoSignatureCapture.success.retryBtnText</code></td><td>Default: "Retry"</td></tr>
|
|
147
|
+
<tr><td><code>success.headingText</code></td><td>Default: "ID Capture Successful"</td></tr>
|
|
148
|
+
<tr><td><code>success.idCardFrontText</code></td><td>Default: "ID Card Front"</td></tr>
|
|
149
|
+
<tr><td><code>success.idCardBackText</code></td><td>Default: "ID Card Back"</td></tr>
|
|
150
|
+
<tr><td><code>success.passportText</code></td><td>Default: "Passport"</td></tr>
|
|
151
|
+
<tr><td><code>success.instructionText</code></td><td>Default: "Verify the entire ID was captured clearly with no glare."</td></tr>
|
|
152
|
+
<tr><td><code>success.retryText</code></td><td>Default: "Retry"</td></tr>
|
|
153
|
+
<tr><td><code>success.submittingText</code></td><td>Default: "Submitting..."</td></tr>
|
|
154
|
+
<tr><td><code>success.submitText</code></td><td>Default: "Submit"</td></tr>
|
|
125
155
|
</table>
|
|
126
156
|
|
|
127
157
|
**Example**
|
|
@@ -171,30 +201,48 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
171
201
|
**Face Liveness Assets**
|
|
172
202
|
|
|
173
203
|
<table>
|
|
174
|
-
<tr><td><code>instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png</td></tr>
|
|
175
|
-
<tr><td><code>
|
|
204
|
+
<tr><td><code>loadingOverlay.instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png</td></tr>
|
|
205
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.imageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png</td></tr>
|
|
206
|
+
<tr><td><code>failure.imageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/manual_capture.png</td></tr>
|
|
176
207
|
</table>
|
|
177
208
|
|
|
178
209
|
**Face Liveness Colors**
|
|
179
210
|
|
|
180
211
|
<table>
|
|
212
|
+
<tr><td><code>loadingOverlay.continueBtn.backgroundColor</code></td><td>Default: #16a085</td></tr>
|
|
213
|
+
<tr><td><code>loadingOverlay.continueBtn.textColor</code></td><td>Default: white</td></tr>
|
|
214
|
+
<tr><td><code>loadingOverlay.continueBtn.loadingBackgroundColor</code></td><td>Default: gray</td></tr>
|
|
215
|
+
<tr><td><code>loadingOverlay.continueBtn.loadingTextColor</code></td><td>Default: white</td></tr>
|
|
216
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.retryBtn.backgroundColor</code></td><td>Default: #ea8557</td></tr>
|
|
217
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.retryBtn.textColor</code></td><td>Default: white</td></tr>
|
|
181
218
|
<tr><td><code>guidesUnsatisfiedColor</code></td><td>Default: white</td></tr>
|
|
182
219
|
<tr><td><code>guidesSatisfiedColor</code></td><td>Default: green</td></tr>
|
|
183
220
|
<tr><td><code>guidanceMessagesSatisfiedBackgroundColor</code></td><td>Default: green</td></tr>
|
|
184
221
|
<tr><td><code>guidanceMessagesUnsatisfiedBackgroundColor</code></td><td>Default: red</td></tr>
|
|
185
222
|
<tr><td><code>guidanceMessagesSatisfiedTextColor</code></td><td>Default: white</td></tr>
|
|
186
223
|
<tr><td><code>guidanceMessagesUnsatisfiedTextColor</code></td><td>Default: white</td></tr>
|
|
224
|
+
<tr><td><code>success.doneBtn.backgroundColor</code></td><td>Default: #16a085</td></tr>
|
|
225
|
+
<tr><td><code>success.doneBtn.textColor</code></td><td>Default: white</td></tr>
|
|
226
|
+
<tr><td><code>success.retryBtn.backgroundColor</code></td><td>Default: #ea8557</td></tr>
|
|
227
|
+
<tr><td><code>success.retryBtn.textColor</code></td><td>Default: white</td></tr>
|
|
228
|
+
<tr><td><code>failure.retryBtn.backgroundColor</code></td><td>Default: #ea8557</td></tr>
|
|
229
|
+
<tr><td><code>failure.retryBtn.textColor</code></td><td>Default: white</td></tr>
|
|
230
|
+
<tr><td><code>failure.exitBtn.backgroundColor</code></td><td>Default: #666</td></tr>
|
|
231
|
+
<tr><td><code>failure.exitBtn.textColor</code></td><td>Default: white</td></tr>
|
|
187
232
|
</table>
|
|
188
233
|
|
|
189
234
|
**Face Liveness Verbiage**
|
|
190
235
|
|
|
191
236
|
<table>
|
|
192
|
-
<tr><td><code>
|
|
193
|
-
<tr><td><code>
|
|
194
|
-
<tr><td><code>
|
|
195
|
-
<tr><td><code>
|
|
196
|
-
<tr><td><code>
|
|
197
|
-
<tr><td><code>
|
|
237
|
+
<tr><td><code>loadingOverlay.headingText</code></td><td>Default: "Use your device camera to capture your face"</td></tr>
|
|
238
|
+
<tr><td><code>loadingOverlay.removeEyeCoveringsText</code></td><td>Default: "Remove Sunglasses & Hat"</td></tr>
|
|
239
|
+
<tr><td><code>loadingOverlay.avoidExcessiveBacklightingText</code></td><td>Default: "Avoid Excessive Backlighting"</td></tr>
|
|
240
|
+
<tr><td><code>loadingOverlay.continueText</code></td><td>Default: "Continue"</td></tr>
|
|
241
|
+
<tr><td><code>loadingOverlay.cameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
|
|
242
|
+
<tr><td><code>loadingOverlay.modelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
|
|
243
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.headingText</code></td><td>Default: "Your camera permission is disabled"</td></tr>
|
|
244
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.descriptionText</code></td><td>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."</td></tr>
|
|
245
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.retryBtnText</code></td><td>Default: "Retry"</td></tr>
|
|
198
246
|
<tr><td><code>guidanceHoldStillText</code></td><td>Default: "Hold still for a few seconds..."</td></tr>
|
|
199
247
|
<tr><td><code>guidanceLookStraightText</code></td><td>Default: "Look straight into the camera..."</td></tr>
|
|
200
248
|
<tr><td><code>guidanceMoveBackText</code></td><td>Default: "Move back..."</td></tr>
|
|
@@ -203,12 +251,12 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
203
251
|
<tr><td><code>guidanceRemoveEyeCoveringsText</code></td><td>Default: "Please remove your eye coverings (sunglasses, eye patch, etc.)..."</td></tr>
|
|
204
252
|
<tr><td><code>guidanceRemoveHeadCoveringsText</code></td><td>Default: "Please remove your head coverings (hat, scarf, etc.)..."</td></tr>
|
|
205
253
|
<tr><td><code>guidanceRemoveMaskText</code></td><td>Default: "Please remove your mask..."</td></tr>
|
|
206
|
-
<tr><td><code>
|
|
207
|
-
<tr><td><code>
|
|
208
|
-
<tr><td><code>
|
|
209
|
-
<tr><td><code>
|
|
210
|
-
<tr><td><code>
|
|
211
|
-
<tr><td><code>
|
|
254
|
+
<tr><td><code>success.headingText</code></td><td>Default: "Face liveness has been verified!"</td></tr>
|
|
255
|
+
<tr><td><code>success.retryBtnText</code></td><td>Default: "Retry"</td></tr>
|
|
256
|
+
<tr><td><code>success.doneBtnText</code></td><td>Default: "Done"</td></tr>
|
|
257
|
+
<tr><td><code>failure.headingText</code></td><td>Default: "Live face not detected, please try again"</td></tr>
|
|
258
|
+
<tr><td><code>failure.retryBtnText</code></td><td>Default: "Retry"</td></tr>
|
|
259
|
+
<tr><td><code>failure.exitBtnText</code></td><td>Default: "Exit"</td></tr>
|
|
212
260
|
</table>
|
|
213
261
|
|
|
214
262
|
**Example**
|
|
@@ -257,12 +305,14 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
|
|
|
257
305
|
<tr><td><code>webhooksEnabled</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked after submission.</td></tr>
|
|
258
306
|
<tr><td><code>webhooksClientTraceId</code> (optional)</td><td>a customer provided trace id to use when invoking customer-configured webhooks.</td></tr>
|
|
259
307
|
<tr><td><code>webhooksStripSpecialCharacters</code> (optional)</td><td>boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked.</td></tr>
|
|
260
|
-
<tr><td><code>
|
|
261
|
-
<tr><td><code>
|
|
262
|
-
<tr><td><code>
|
|
263
|
-
<tr><td><code>
|
|
264
|
-
<tr><td><code>
|
|
265
|
-
<tr><td><code>
|
|
308
|
+
<tr><td><code>assets.idCapture</code> (optional)</td><td>object containing any asset overrides, for available options consult the ID Capture Assets table above.</td></tr>
|
|
309
|
+
<tr><td><code>assets.faceLiveness</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
|
|
310
|
+
<tr><td><code>colors.idCapture</code> (optional)</td><td>object containing any color overrides, for available options consult the ID Capture Colors table above.</td></tr>
|
|
311
|
+
<tr><td><code>colors.faceLiveness</code> (optional)</td><td>object containing any color overrides, for available options consult the Face Liveness Colors table above.</td></tr>
|
|
312
|
+
<tr><td><code>verbiage.idCapture</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the ID Capture Verbiage table above.</td></tr>
|
|
313
|
+
<tr><td><code>verbiage.faceLiveness</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above.</td></tr>
|
|
314
|
+
<tr><td><code>verbiage.additionalDocumentCapture</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the additionalDocumentCapture fields in the ID Capture Verbiage table above.</td></tr>
|
|
315
|
+
<tr><td><code>verbiage.signatureCapture</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the signatureCapture fields in the ID Capture Verbiage table above.</td></tr>
|
|
266
316
|
<tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Default is `true`.</td></tr>
|
|
267
317
|
<tr><td><code>geolocationRequired</code> (optional)</td><td>boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`.</td></tr>
|
|
268
318
|
<tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Default is `false`.</td></tr>
|
|
@@ -317,12 +367,16 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
|
|
|
317
367
|
<tr><td><code>webhooksEnabled</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked after submission.</td></tr>
|
|
318
368
|
<tr><td><code>webhooksClientTraceId</code> (optional)</td><td>a customer provided trace id to use when invoking customer-configured webhooks.</td></tr>
|
|
319
369
|
<tr><td><code>webhooksStripSpecialCharacters</code> (optional)</td><td>boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked.</td></tr>
|
|
320
|
-
<tr><td><code>
|
|
321
|
-
<tr><td><code>
|
|
322
|
-
<tr><td><code>
|
|
323
|
-
<tr><td><code>
|
|
324
|
-
<tr><td><code>
|
|
325
|
-
<tr><td><code>
|
|
370
|
+
<tr><td><code>assets.idCapture</code> (optional)</td><td>object containing any asset overrides, for available options consult the ID Capture Assets table above.</td></tr>
|
|
371
|
+
<tr><td><code>assets.faceLiveness</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
|
|
372
|
+
<tr><td><code>colors.idCapture</code> (optional)</td><td>object containing any color overrides, for available options consult the ID Capture Colors table above.</td></tr>
|
|
373
|
+
<tr><td><code>colors.faceLiveness</code> (optional)</td><td>object containing any color overrides, for available options consult the Face Liveness Colors table above.</td></tr>
|
|
374
|
+
<tr><td><code>colors.videoSignatureCapture</code> (optional)</td><td>object containing any color overrides, for available options consult the videoSignatureCapture fields in the ID Capture Colors table above.</td></tr>
|
|
375
|
+
<tr><td><code>verbiage.idCapture</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the ID Capture Verbiage table above.</td></tr>
|
|
376
|
+
<tr><td><code>verbiage.faceLiveness</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above.</td></tr>
|
|
377
|
+
<tr><td><code>verbiage.additionalDocumentCapture</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the additionalDocumentCapture fields in the ID Capture Verbiage table above.</td></tr>
|
|
378
|
+
<tr><td><code>verbiage.signatureCapture</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the signatureCapture fields in the ID Capture Verbiage table above.</td></tr>
|
|
379
|
+
<tr><td><code>verbiage.videoSignatureCapture</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the videoSignatureCapture fields in the ID Capture Verbiage table above.</td></tr>
|
|
326
380
|
<tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Default is `true`.</td></tr>
|
|
327
381
|
<tr><td><code>geolocationRequired</code> (optional)</td><td>boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`.</td></tr>
|
|
328
382
|
<tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Default is `false`.</td></tr>
|
|
@@ -363,9 +417,13 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
|
|
|
363
417
|
<tr><td><code>webhooksEnabled</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked after submission.</td></tr>
|
|
364
418
|
<tr><td><code>webhooksClientTraceId</code> (optional)</td><td>a customer provided trace id to use when invoking customer-configured webhooks.</td></tr>
|
|
365
419
|
<tr><td><code>webhooksStripSpecialCharacters</code> (optional)</td><td>boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked.</td></tr>
|
|
366
|
-
<tr><td><code>assets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
|
|
367
|
-
<tr><td><code>colors</code> (optional)</td><td>object containing any color overrides, for available options consult the Face Liveness Colors table above.</td></tr>
|
|
368
|
-
<tr><td><code>
|
|
420
|
+
<tr><td><code>assets.faceLiveness</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
|
|
421
|
+
<tr><td><code>colors.faceLiveness</code> (optional)</td><td>object containing any color overrides, for available options consult the Face Liveness Colors table above.</td></tr>
|
|
422
|
+
<tr><td><code>colors.videoSignatureCapture</code> (optional)</td><td>object containing any color overrides, for available options consult the videoSignatureCapture fields in the ID Capture Colors table above.</td></tr>
|
|
423
|
+
<tr><td><code>verbiage.faceLiveness</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above.</td></tr>
|
|
424
|
+
<tr><td><code>verbiage.additionalDocumentCapture</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the additionalDocumentCapture fields in the ID Capture Verbiage table above.</td></tr>
|
|
425
|
+
<tr><td><code>verbiage.signatureCapture</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the signatureCapture fields in the ID Capture Verbiage table above.</td></tr>
|
|
426
|
+
<tr><td><code>verbiage.videoSignatureCapture</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the videoSignatureCapture fields in the ID Capture Verbiage table above.</td></tr>
|
|
369
427
|
<tr><td><code>geolocationEnabled</code> (optional)</td><td>boolean flag to indicate whether users should be prompted to share their location. Default is `true`.</td></tr>
|
|
370
428
|
<tr><td><code>geolocationRequired</code> (optional)</td><td>boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`.</td></tr>
|
|
371
429
|
<tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Default is `false`.</td></tr>
|
|
@@ -447,41 +505,59 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
447
505
|
**Customer Identification Assets**
|
|
448
506
|
|
|
449
507
|
<table>
|
|
450
|
-
<tr><td><code>instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png</td></tr>
|
|
451
|
-
<tr><td><code>
|
|
508
|
+
<tr><td><code>loadingOverlay.instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png</td></tr>
|
|
509
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.imageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png</td></tr>
|
|
510
|
+
<tr><td><code>failure.imageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/manual_capture.png</td></tr>
|
|
452
511
|
</table>
|
|
453
512
|
|
|
454
513
|
**Customer Identification Colors**
|
|
455
514
|
|
|
456
515
|
<table>
|
|
516
|
+
<tr><td><code>loadingOverlay.continueBtn.backgroundColor</code></td><td>Default: #16a085</td></tr>
|
|
517
|
+
<tr><td><code>loadingOverlay.continueBtn.textColor</code></td><td>Default: white</td></tr>
|
|
518
|
+
<tr><td><code>loadingOverlay.continueBtn.loadingBackgroundColor</code></td><td>Default: gray</td></tr>
|
|
519
|
+
<tr><td><code>loadingOverlay.continueBtn.loadingTextColor</code></td><td>Default: white</td></tr>
|
|
520
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.retryBtn.backgroundColor</code></td><td>Default: #ea8557</td></tr>
|
|
521
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.retryBtn.textColor</code></td><td>Default: white</td></tr>
|
|
457
522
|
<tr><td><code>guidesUnsatisfiedColor</code></td><td>Default: white</td></tr>
|
|
458
523
|
<tr><td><code>guidesSatisfiedColor</code></td><td>Default: green</td></tr>
|
|
459
524
|
<tr><td><code>guidanceMessagesSatisfiedBackgroundColor</code></td><td>Default: green</td></tr>
|
|
460
525
|
<tr><td><code>guidanceMessagesUnsatisfiedBackgroundColor</code></td><td>Default: red</td></tr>
|
|
461
526
|
<tr><td><code>guidanceMessagesSatisfiedTextColor</code></td><td>Default: white</td></tr>
|
|
462
527
|
<tr><td><code>guidanceMessagesUnsatisfiedTextColor</code></td><td>Default: white</td></tr>
|
|
528
|
+
<tr><td><code>success.doneBtn.backgroundColor</code></td><td>Default: #16a085</td></tr>
|
|
529
|
+
<tr><td><code>success.doneBtn.textColor</code></td><td>Default: white</td></tr>
|
|
530
|
+
<tr><td><code>success.retryBtn.backgroundColor</code></td><td>Default: #ea8557</td></tr>
|
|
531
|
+
<tr><td><code>success.retryBtn.textColor</code></td><td>Default: white</td></tr>
|
|
532
|
+
<tr><td><code>failure.retryBtn.backgroundColor</code></td><td>Default: #ea8557</td></tr>
|
|
533
|
+
<tr><td><code>failure.retryBtn.textColor</code></td><td>Default: white</td></tr>
|
|
534
|
+
<tr><td><code>failure.exitBtn.backgroundColor</code></td><td>Default: #666</td></tr>
|
|
535
|
+
<tr><td><code>failure.exitBtn.textColor</code></td><td>Default: white</td></tr>
|
|
463
536
|
</table>
|
|
464
537
|
|
|
465
538
|
**Customer Identification Verbiage**
|
|
466
539
|
|
|
467
540
|
<table>
|
|
468
|
-
<tr><td><code>
|
|
469
|
-
<tr><td><code>
|
|
470
|
-
<tr><td><code>
|
|
471
|
-
<tr><td><code>
|
|
472
|
-
<tr><td><code>
|
|
473
|
-
<tr><td><code>
|
|
541
|
+
<tr><td><code>loadingOverlay.headingText</code></td><td>Default: "Use your device camera to capture your face"</td></tr>
|
|
542
|
+
<tr><td><code>loadingOverlay.removeEyeCoveringsText</code></td><td>Default: "Remove Sunglasses & Hat"</td></tr>
|
|
543
|
+
<tr><td><code>loadingOverlay.avoidExcessiveBacklightingText</code></td><td>Default: "Avoid Excessive Backlighting"</td></tr>
|
|
544
|
+
<tr><td><code>loadingOverlay.continueText</code></td><td>Default: "Continue"</td></tr>
|
|
545
|
+
<tr><td><code>loadingOverlay.cameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
|
|
546
|
+
<tr><td><code>loadingOverlay.modelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
|
|
547
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.headingText</code></td><td>Default: "Your camera permission is disabled"</td></tr>
|
|
548
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.descriptionText</code></td><td>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."</td></tr>
|
|
549
|
+
<tr><td><code>loadingOverlay.cameraAccessDenied.retryBtnText</code></td><td>Default: "Retry"</td></tr>
|
|
474
550
|
<tr><td><code>guidanceHoldStillText</code></td><td>Default: "Hold still for a few seconds..."</td></tr>
|
|
475
551
|
<tr><td><code>guidanceLookStraightText</code></td><td>Default: "Look straight into the camera..."</td></tr>
|
|
476
552
|
<tr><td><code>guidanceMoveBackText</code></td><td>Default: "Move back..."</td></tr>
|
|
477
553
|
<tr><td><code>guidanceMoveForwardText</code></td><td>Default: "Move forward..."</td></tr>
|
|
478
554
|
<tr><td><code>guidanceMoveToCenterText</code></td><td>Default: "Move to the center..."</td></tr>
|
|
479
|
-
<tr><td><code>
|
|
480
|
-
<tr><td><code>
|
|
481
|
-
<tr><td><code>
|
|
482
|
-
<tr><td><code>
|
|
483
|
-
<tr><td><code>
|
|
484
|
-
<tr><td><code>
|
|
555
|
+
<tr><td><code>success.headingText</code></td><td>Default: "Customer has been identified!"</td></tr>
|
|
556
|
+
<tr><td><code>success.retryBtnText</code></td><td>Default: "Retry"</td></tr>
|
|
557
|
+
<tr><td><code>success.doneBtnText</code></td><td>Default: "Done"</td></tr>
|
|
558
|
+
<tr><td><code>failure.headingText</code></td><td>Default: "Customer not found"</td></tr>
|
|
559
|
+
<tr><td><code>failure.retryBtnText</code></td><td>Default: "Retry"</td></tr>
|
|
560
|
+
<tr><td><code>failure.exitBtnText</code></td><td>Default: "Exit"</td></tr>
|
|
485
561
|
</table>
|
|
486
562
|
|
|
487
563
|
**Example**
|
|
@@ -4,14 +4,14 @@ import { FaceLivenessWizardProps } from './face_liveness/FaceLivenessWizard';
|
|
|
4
4
|
import { SubmissionAction, SubmissionEnvironment, SubmissionResponse } from '../contexts/SubmissionContext';
|
|
5
5
|
import { AdditionalDocumentCaptureWizardProps } from './additional_document_capture/AdditionalDocumentCaptureWizard';
|
|
6
6
|
import { SignatureCaptureProps } from './signature_capture/SignatureCapture';
|
|
7
|
-
import {
|
|
8
|
-
export type CompositeWizardCheck = 'IdCapture' | 'FaceLiveness' | 'SignatureCapture' | '
|
|
7
|
+
import { VideoSignatureWizardProps } from './video_signature_capture/VideoSignatureWizard';
|
|
8
|
+
export type CompositeWizardCheck = 'IdCapture' | 'FaceLiveness' | 'SignatureCapture' | 'VideoSignatureCapture' | 'AdditionalDocumentCapture';
|
|
9
9
|
export type CompositeWizardComponentProps = {
|
|
10
10
|
checks: CompositeWizardCheck[];
|
|
11
11
|
idCaptureProps?: IdCaptureWizardProps;
|
|
12
12
|
faceLivenessProps?: FaceLivenessWizardProps;
|
|
13
13
|
signatureCaptureProps?: SignatureCaptureProps;
|
|
14
|
-
|
|
14
|
+
videoSignatureCaptureProps?: VideoSignatureWizardProps;
|
|
15
15
|
additionalDocumentCaptureProps?: AdditionalDocumentCaptureWizardProps;
|
|
16
16
|
captureSignature?: boolean | (() => Promise<boolean>);
|
|
17
17
|
captureSignatureVideo?: boolean | (() => Promise<boolean>);
|
|
@@ -24,4 +24,4 @@ export type CompositeWizardProps = CompositeWizardComponentProps & {
|
|
|
24
24
|
onComplete?: (submissionResponse: SubmissionResponse) => void;
|
|
25
25
|
};
|
|
26
26
|
export declare const CompositeWizard: (props: CompositeWizardProps) => ReactElement;
|
|
27
|
-
export declare const CompositeWizardComponent: ({ checks: userChecks, idCaptureProps, faceLivenessProps, signatureCaptureProps,
|
|
27
|
+
export declare const CompositeWizardComponent: ({ checks: userChecks, idCaptureProps, faceLivenessProps, signatureCaptureProps, videoSignatureCaptureProps, additionalDocumentCaptureProps, captureSignature, captureSignatureVideo, }: CompositeWizardComponentProps) => ReactElement;
|
|
@@ -1,9 +1,5 @@
|
|
|
1
1
|
import { ReactElement } from 'react';
|
|
2
2
|
import { AdditionalDocument, UploadedDocument } from './AdditionalDocumentCapture';
|
|
3
|
-
export type NamespacedAdditionalDocumentsVerbiage = {
|
|
4
|
-
additionalDocumentsHeadingText?: string;
|
|
5
|
-
additionalDocumentsNextBtnText?: string;
|
|
6
|
-
};
|
|
7
3
|
export type AdditionalDocumentCaptureVerbiage = {
|
|
8
4
|
headingText?: string;
|
|
9
5
|
nextBtnText?: string;
|
|
@@ -1,4 +1,19 @@
|
|
|
1
1
|
import { ReactElement } from 'react';
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
2
|
+
import { LoaderButtonColors } from '../common/LoaderButton';
|
|
3
|
+
export type CameraAccessDeniedOverlayAssets = {
|
|
4
|
+
imageUrl?: string;
|
|
5
|
+
};
|
|
6
|
+
export type CameraAccessDeniedOverlayColors = {
|
|
7
|
+
retryBtn?: LoaderButtonColors;
|
|
8
|
+
};
|
|
9
|
+
export type CameraAccessDeniedOverlayVerbiage = {
|
|
10
|
+
headingText?: string;
|
|
11
|
+
descriptionText?: string;
|
|
12
|
+
retryBtnText?: string;
|
|
13
|
+
};
|
|
14
|
+
export type CameraAccessDeniedOverlayProps = {
|
|
15
|
+
assets?: CameraAccessDeniedOverlayAssets;
|
|
16
|
+
colors?: CameraAccessDeniedOverlayColors;
|
|
17
|
+
verbiage?: CameraAccessDeniedOverlayVerbiage;
|
|
18
|
+
};
|
|
19
|
+
export declare const CameraAccessDeniedOverlay: ({ assets, colors, verbiage, }: CameraAccessDeniedOverlayProps) => ReactElement;
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
import { CSSProperties, ReactNode } from 'react';
|
|
2
|
+
export type LoaderButtonColors = {
|
|
3
|
+
backgroundColor?: string;
|
|
4
|
+
textColor?: string;
|
|
5
|
+
loadingBackgroundColor?: string;
|
|
6
|
+
loadingTextColor?: string;
|
|
7
|
+
};
|
|
8
|
+
export type LoaderButtonProps = {
|
|
9
|
+
children?: ReactNode;
|
|
10
|
+
disabled?: boolean;
|
|
11
|
+
finished?: boolean;
|
|
12
|
+
colors?: LoaderButtonColors;
|
|
13
|
+
onClick?: () => void;
|
|
14
|
+
style?: CSSProperties;
|
|
15
|
+
};
|
|
16
|
+
export declare const LoaderButton: ({ children, colors, disabled, finished, onClick, style, }: LoaderButtonProps) => JSX.Element;
|
|
@@ -1,11 +1,24 @@
|
|
|
1
1
|
import { ReactElement } from 'react';
|
|
2
2
|
import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
|
|
3
3
|
import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
|
|
4
|
-
import {
|
|
4
|
+
import { AdditionalDocumentCaptureVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
|
|
5
5
|
import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
|
|
6
6
|
import { LangOption } from '../../lib/locales';
|
|
7
|
-
import {
|
|
8
|
-
|
|
7
|
+
import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
|
|
8
|
+
import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
|
|
9
|
+
export type CustomerBiometricsEnrollmentAssets = {
|
|
10
|
+
faceLiveness?: FaceLivenessAssets;
|
|
11
|
+
};
|
|
12
|
+
export type CustomerBiometricsEnrollmentColors = {
|
|
13
|
+
faceLiveness?: FaceLivenessColors;
|
|
14
|
+
videoSignatureCapture?: VideoSignatureColors;
|
|
15
|
+
};
|
|
16
|
+
export type CustomerBiometricsEnrollmentVerbiage = {
|
|
17
|
+
faceLiveness?: FaceLivenessVerbiage;
|
|
18
|
+
additionalDocumentCapture?: AdditionalDocumentCaptureVerbiage;
|
|
19
|
+
signatureCapture?: SignatureCaptureVerbiage;
|
|
20
|
+
videoSignatureCapture?: VideoSignatureVerbiage;
|
|
21
|
+
};
|
|
9
22
|
export type CustomerBiometricsEnrollmentProps = {
|
|
10
23
|
enrollmentId: string;
|
|
11
24
|
lang?: LangOption;
|
|
@@ -19,19 +32,19 @@ export type CustomerBiometricsEnrollmentProps = {
|
|
|
19
32
|
webhooksClientTraceId?: string;
|
|
20
33
|
webhooksStripSpecialCharacters?: boolean;
|
|
21
34
|
timeoutDurationMs?: number;
|
|
22
|
-
assets?: FaceLivenessAssets;
|
|
23
|
-
colors?: FaceLivenessColors;
|
|
24
|
-
verbiage?: CustomerBiometricsEnrollmentVerbiage;
|
|
25
35
|
onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
|
|
26
36
|
onComplete?: (submissionResponse: SubmissionResponse) => void;
|
|
27
37
|
onEnrolled?: (submissionResponse: SubmissionResponse) => void;
|
|
28
38
|
onDenied?: (submissionResponse: SubmissionResponse) => void;
|
|
29
39
|
onExitAfterFailure?: () => void;
|
|
40
|
+
captureAdditionalDocuments?: AdditionalDocument[];
|
|
30
41
|
captureSignature?: boolean | (() => Promise<boolean>);
|
|
31
42
|
captureSignatureVideo?: boolean | (() => Promise<boolean>);
|
|
32
|
-
|
|
43
|
+
assets?: CustomerBiometricsEnrollmentAssets;
|
|
44
|
+
colors?: CustomerBiometricsEnrollmentColors;
|
|
45
|
+
verbiage?: CustomerBiometricsEnrollmentVerbiage;
|
|
33
46
|
geolocationEnabled?: boolean;
|
|
34
47
|
geolocationRequired?: boolean;
|
|
35
48
|
debugMode?: boolean;
|
|
36
49
|
};
|
|
37
|
-
export declare const CustomerBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, companyId, deduplicationEnabled, deduplicationSynchronous, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs,
|
|
50
|
+
export declare const CustomerBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, companyId, deduplicationEnabled, deduplicationSynchronous, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureAdditionalDocuments, captureSignature, captureSignatureVideo, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: CustomerBiometricsEnrollmentProps) => ReactElement;
|
|
@@ -1,11 +1,28 @@
|
|
|
1
1
|
import { ReactElement } from 'react';
|
|
2
2
|
import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
|
|
3
3
|
import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
|
|
4
|
-
import {
|
|
4
|
+
import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
|
|
5
|
+
import { AdditionalDocumentCaptureVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
|
|
5
6
|
import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
|
|
6
7
|
import { LangOption } from '../../lib/locales';
|
|
7
|
-
import {
|
|
8
|
-
import {
|
|
8
|
+
import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
|
|
9
|
+
import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
|
|
10
|
+
export type CustomerEnrollmentAssets = {
|
|
11
|
+
idCapture?: IdCaptureWizardAssets;
|
|
12
|
+
faceLiveness?: FaceLivenessAssets;
|
|
13
|
+
};
|
|
14
|
+
export type CustomerEnrollmentColors = {
|
|
15
|
+
idCapture?: IdCaptureWizardColors;
|
|
16
|
+
faceLiveness?: FaceLivenessColors;
|
|
17
|
+
videoSignatureCapture?: VideoSignatureColors;
|
|
18
|
+
};
|
|
19
|
+
export type CustomerEnrollmentVerbiage = {
|
|
20
|
+
idCapture?: IdCaptureWizardVerbiage;
|
|
21
|
+
faceLiveness?: FaceLivenessVerbiage;
|
|
22
|
+
additionalDocumentCapture?: AdditionalDocumentCaptureVerbiage;
|
|
23
|
+
signatureCapture?: SignatureCaptureVerbiage;
|
|
24
|
+
videoSignatureCapture?: VideoSignatureVerbiage;
|
|
25
|
+
};
|
|
9
26
|
export type CustomerEnrollmentProps = {
|
|
10
27
|
enrollmentId: string;
|
|
11
28
|
lang?: LangOption;
|
|
@@ -28,23 +45,20 @@ export type CustomerEnrollmentProps = {
|
|
|
28
45
|
passportAutoCaptureScoreThreshold?: number;
|
|
29
46
|
idCardFocusScoreThreshold?: number;
|
|
30
47
|
passportFocusScoreThreshold?: number;
|
|
31
|
-
idCaptureAssets?: IdCaptureAssets;
|
|
32
|
-
idCaptureColors?: IdCaptureColors;
|
|
33
|
-
idCaptureVerbiage?: IdValidationVerbiage;
|
|
34
48
|
faceLivenessTimeoutDurationMs?: number;
|
|
35
|
-
faceLivenessAssets?: FaceLivenessAssets;
|
|
36
|
-
faceLivenessColors?: FaceLivenessColors;
|
|
37
|
-
faceLivenessVerbiage?: FaceLivenessVerbiage;
|
|
38
49
|
onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
|
|
39
50
|
onComplete?: (submissionResponse: SubmissionResponse) => void;
|
|
40
51
|
onEnrolled?: (submissionResponse: SubmissionResponse) => void;
|
|
41
52
|
onDenied?: (submissionResponse: SubmissionResponse) => void;
|
|
42
53
|
onExitAfterFailure?: () => void;
|
|
54
|
+
captureAdditionalDocuments?: AdditionalDocument[];
|
|
43
55
|
captureSignature?: boolean | (() => Promise<boolean>);
|
|
44
56
|
captureSignatureVideo?: boolean | (() => Promise<boolean>);
|
|
45
|
-
|
|
57
|
+
assets?: CustomerEnrollmentAssets;
|
|
58
|
+
colors?: CustomerEnrollmentColors;
|
|
59
|
+
verbiage?: CustomerEnrollmentVerbiage;
|
|
46
60
|
geolocationEnabled?: boolean;
|
|
47
61
|
geolocationRequired?: boolean;
|
|
48
62
|
debugMode?: boolean;
|
|
49
63
|
};
|
|
50
|
-
export declare const CustomerIdAndBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, deduplicationEnabled, deduplicationSynchronous, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold,
|
|
64
|
+
export declare const CustomerIdAndBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, deduplicationEnabled, deduplicationSynchronous, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, faceLivenessTimeoutDurationMs, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureAdditionalDocuments, captureSignature, captureSignatureVideo, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: CustomerEnrollmentProps) => ReactElement;
|