idmission-web-sdk 0.0.54 → 0.0.56

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.
Files changed (45) hide show
  1. package/README.md +103 -75
  2. package/dist/components/CompositeWizard.d.ts +4 -4
  3. package/dist/components/additional_document_capture/AdditionalDocumentCaptureWizard.d.ts +0 -4
  4. package/dist/components/customer_flows/CustomerBiometricsEnrollment.d.ts +21 -8
  5. package/dist/components/customer_flows/CustomerIdAndBiometricsEnrollment.d.ts +25 -11
  6. package/dist/components/customer_flows/IdAndFaceValidation.d.ts +21 -10
  7. package/dist/components/customer_flows/IdValidation.d.ts +15 -7
  8. package/dist/components/customer_flows/SignatureKYC.d.ts +3 -3
  9. package/dist/components/customer_identification/CustomerIdentificationFailure.d.ts +9 -3
  10. package/dist/components/customer_identification/CustomerIdentificationSuccess.d.ts +6 -3
  11. package/dist/components/customer_identification/CustomerIdentificationWizard.d.ts +8 -14
  12. package/dist/components/customer_verification/CustomerVerificationFailure.d.ts +9 -3
  13. package/dist/components/customer_verification/CustomerVerificationSuccess.d.ts +6 -3
  14. package/dist/components/customer_verification/CustomerVerificationWizard.d.ts +8 -13
  15. package/dist/components/face_liveness/FaceLivenessFailure.d.ts +9 -3
  16. package/dist/components/face_liveness/FaceLivenessSuccess.d.ts +5 -2
  17. package/dist/components/face_liveness/FaceLivenessWizard.d.ts +8 -14
  18. package/dist/components/id_capture/FlipIdPrompt.d.ts +12 -6
  19. package/dist/components/id_capture/IdCaptureLoadingOverlay.d.ts +10 -4
  20. package/dist/components/id_capture/IdCaptureSuccess.d.ts +9 -6
  21. package/dist/components/id_capture/IdCaptureWizard.d.ts +21 -33
  22. package/dist/components/selfie_capture/SelfieCaptureLoadingOverlay.d.ts +10 -3
  23. package/dist/components/signature_capture/SignatureCapture.d.ts +0 -5
  24. package/dist/components/video_signature_capture/VideoSignatureCapture.d.ts +20 -0
  25. package/dist/components/video_signature_capture/VideoSignatureLoadingOverlay.d.ts +8 -0
  26. package/dist/components/video_signature_capture/VideoSignatureSuccess.d.ts +13 -0
  27. package/dist/components/video_signature_capture/VideoSignatureWizard.d.ts +27 -0
  28. package/dist/lib/locales/es/translation.d.ts +1 -1
  29. package/dist/lib/locales/index.d.ts +1 -1
  30. package/dist/sdk2.cjs.development.js +465 -549
  31. package/dist/sdk2.cjs.development.js.map +1 -1
  32. package/dist/sdk2.cjs.production.js +1 -1
  33. package/dist/sdk2.cjs.production.js.map +1 -1
  34. package/dist/sdk2.esm.js +465 -549
  35. package/dist/sdk2.esm.js.map +1 -1
  36. package/dist/sdk2.umd.development.js +465 -549
  37. package/dist/sdk2.umd.development.js.map +1 -1
  38. package/dist/sdk2.umd.production.js +1 -1
  39. package/dist/sdk2.umd.production.js.map +1 -1
  40. package/dist/stories/SignatureCapture/VideoSignatureCapture.stories.d.ts +1 -1
  41. package/package.json +1 -1
  42. package/dist/components/signature_capture/VideoSignatureCapture.d.ts +0 -19
  43. package/dist/components/signature_kyc/SignatureKYCLoadingOverlay.d.ts +0 -12
  44. package/dist/components/signature_kyc/SignatureKYCSuccess.d.ts +0 -10
  45. package/dist/components/signature_kyc/SignatureKYCWizard.d.ts +0 -24
package/README.md CHANGED
@@ -79,13 +79,18 @@ 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>loadingOverlayInstructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/WebSDK-Instruction-DL-Capture-3-Portrait.png</td></tr>
83
- <tr><td><code>idCardFrontPortraitGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Front-SVG-Portrait-2.svg</td></tr>
84
- <tr><td><code>idCardFrontLandscapeGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Landscape-SVG-Portrait-2.svg</td></tr>
85
- <tr><td><code>idCardBackPortraitGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Back-SVG-Portrait-2.svg</td></tr>
86
- <tr><td><code>idCardBackLandscapeGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-IDCard-Back-SVG-Landscape-2.svg</td></tr>
87
- <tr><td><code>passportPortraitGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-Passport-Front-SVG-Portrait-2.svg</td></tr>
88
- <tr><td><code>passportLandscapeGuidesImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Shieldout-Passport-Front-SVG-Landscape-2.svg</td></tr>
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.accessBlockedImageUrl</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**
@@ -97,31 +102,42 @@ Render a fullscreen ID capture component that instructs the user to photograph b
97
102
  **ID Capture Verbiage**
98
103
 
99
104
  <table>
100
- <tr><td><code>loadingOverlayHeadingText</code></td><td>Default: "Use your device camera to capture your ID"</td></tr>
101
- <tr><td><code>loadingOverlayUseContinuityCameraText</code></td><td>Default: "Use your iPhone as a webcam"</td></tr>
102
- <tr><td><code>loadingOverlayModelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
103
- <tr><td><code>loadingOverlayCameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
104
- <tr><td><code>loadingOverlayCameraAccessBlockedText</code></td><td>Default: "Camera access blocked"</td></tr>
105
- <tr><td><code>loadingOverlayContinueText</code></td><td>Default: "Continue"</td></tr>
106
- <tr><td><code>idCardFrontInstructionText</code></td><td>Default: "Scan the front of ID"</td></tr>
107
- <tr><td><code>idCardBackInstructionText</code></td><td>Default: "Scan the back of ID"</td></tr>
108
- <tr><td><code>passportInstructionText</code></td><td>Default: "Scan the ID page of passport"</td></tr>
109
- <tr><td><code>flipIdInstructionText</code></td><td>Default: "Please flip your ID card..."</td></tr>
110
- <tr><td><code>capturingText</code></td><td>Default: "Capturing..."</td></tr>
111
- <tr><td><code>captureFailedText</code></td><td>Default: "Capture failed!"</td></tr>
112
- <tr><td><code>signatureCaptureHeadingText</code></td><td>Default: "Please sign the box below"</td></tr>
113
- <tr><td><code>signatureCaptureAcceptBtnText</code></td><td>Default: "Accept"</td></tr>
114
- <tr><td><code>signatureCaptureClearBtnText</code></td><td>Default: "Clear"</td></tr>
115
- <tr><td><code>additionalDocumentsHeadingText</code></td><td>Default: "Additional document capture"</td></tr>
116
- <tr><td><code>additionalDocumentsNextBtnText</code></td><td>Default: "Next"</td></tr>
117
- <tr><td><code>successHeadingText</code></td><td>Default: "ID Capture Successful"</td></tr>
118
- <tr><td><code>successIdCardFrontText</code></td><td>Default: "ID Card Front"</td></tr>
119
- <tr><td><code>successIdCardBackText</code></td><td>Default: "ID Card Back"</td></tr>
120
- <tr><td><code>successPassportText</code></td><td>Default: "Passport"</td></tr>
121
- <tr><td><code>successInstructionText</code></td><td>Default: "Verify the entire ID was captured clearly with no glare."</td></tr>
122
- <tr><td><code>successRetryText</code></td><td>Default: "Retry"</td></tr>
123
- <tr><td><code>successSubmittingText</code></td><td>Default: "Submitting..."</td></tr>
124
- <tr><td><code>successSubmitText</code></td><td>Default: "Submit"</td></tr>
105
+ <tr><td><code>loadingOverlay.headingText</code></td><td>Default: "Use your device camera to capture your ID"</td></tr>
106
+ <tr><td><code>loadingOverlay.useContinuityCameraText</code></td><td>Default: "Use your iPhone as a webcam"</td></tr>
107
+ <tr><td><code>loadingOverlay.modelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
108
+ <tr><td><code>loadingOverlay.cameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
109
+ <tr><td><code>loadingOverlay.cameraAccessBlockedText</code></td><td>Default: "Camera access blocked"</td></tr>
110
+ <tr><td><code>loadingOverlay.continueText</code></td><td>Default: "Continue"</td></tr>
111
+ <tr><td><code>idCardFront.instructionText</code></td><td>Default: "Scan the front of ID"</td></tr>
112
+ <tr><td><code>idCardFront.capturingText</code></td><td>Default: "Capturing..."</td></tr>
113
+ <tr><td><code>idCardFront.captureFailedText</code></td><td>Default: "Capture failed!"</td></tr>
114
+ <tr><td><code>idCardBack.instructionText</code></td><td>Default: "Scan the back of ID"</td></tr>
115
+ <tr><td><code>idCardBack.capturingText</code></td><td>Default: "Capturing..."</td></tr>
116
+ <tr><td><code>idCardBack.captureFailedText</code></td><td>Default: "Capture failed!"</td></tr>
117
+ <tr><td><code>passport.instructionText</code></td><td>Default: "Scan the ID page of passport"</td></tr>
118
+ <tr><td><code>passport.capturingText</code></td><td>Default: "Capturing..."</td></tr>
119
+ <tr><td><code>passport.captureFailedText</code></td><td>Default: "Capture failed!"</td></tr>
120
+ <tr><td><code>flipIdPrompt.instructionText</code></td><td>Default: "Please flip your ID card..."</td></tr>
121
+ <tr><td><code>additionalDocumentCapture.headingText</code></td><td>Default: "Additional document capture"</td></tr>
122
+ <tr><td><code>additionalDocumentCapture.nextBtnText</code></td><td>Default: "Next"</td></tr>
123
+ <tr><td><code>signatureCapture.headingText</code></td><td>Default: "Please sign the box below"</td></tr>
124
+ <tr><td><code>signatureCapture.acceptBtnText</code></td><td>Default: "Accept"</td></tr>
125
+ <tr><td><code>signatureCapture.clearBtnText</code></td><td>Default: "Clear"</td></tr>
126
+ <tr><td><code>videoSignatureCapture.faceLiveness</code></td><td>Default: see Face Liveness Verbiage section below</td></tr>
127
+ <tr><td><code>videoSignatureCapture.guidanceMessageText</code></td><td>Default: "Please sign the box below"</td></tr>
128
+ <tr><td><code>videoSignatureCapture.acceptBtnText</code></td><td>Default: "Accept"</td></tr>
129
+ <tr><td><code>videoSignatureCapture.clearBtnText</code></td><td>Default: "Clear"</td></tr>
130
+ <tr><td><code>videoSignatureCapture.success.headingText</code></td><td>Default: "Video signature has been successfully captured!"</td></tr>
131
+ <tr><td><code>videoSignatureCapture.success.doneBtnText</code></td><td>Default: "Done"</td></tr>
132
+ <tr><td><code>videoSignatureCapture.success.retryBtnText</code></td><td>Default: "Retry"</td></tr>
133
+ <tr><td><code>success.headingText</code></td><td>Default: "ID Capture Successful"</td></tr>
134
+ <tr><td><code>success.idCardFrontText</code></td><td>Default: "ID Card Front"</td></tr>
135
+ <tr><td><code>success.idCardBackText</code></td><td>Default: "ID Card Back"</td></tr>
136
+ <tr><td><code>success.passportText</code></td><td>Default: "Passport"</td></tr>
137
+ <tr><td><code>success.instructionText</code></td><td>Default: "Verify the entire ID was captured clearly with no glare."</td></tr>
138
+ <tr><td><code>success.retryText</code></td><td>Default: "Retry"</td></tr>
139
+ <tr><td><code>success.submittingText</code></td><td>Default: "Submitting..."</td></tr>
140
+ <tr><td><code>success.submitText</code></td><td>Default: "Submit"</td></tr>
125
141
  </table>
126
142
 
127
143
  **Example**
@@ -171,8 +187,9 @@ Render a fullscreen capture component that analyzes frames from the user's front
171
187
  **Face Liveness Assets**
172
188
 
173
189
  <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>failureImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/manual_capture.png</td></tr>
190
+ <tr><td><code>loadingOverlay.instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png</td></tr>
191
+ <tr><td><code>loadingOverlay.accessBlockedImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png</td></tr>
192
+ <tr><td><code>failure.imageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/manual_capture.png</td></tr>
176
193
  </table>
177
194
 
178
195
  **Face Liveness Colors**
@@ -189,12 +206,12 @@ Render a fullscreen capture component that analyzes frames from the user's front
189
206
  **Face Liveness Verbiage**
190
207
 
191
208
  <table>
192
- <tr><td><code>loadingOverlayHeadingText</code></td><td>Default: "Use your device camera to capture your face"</td></tr>
193
- <tr><td><code>loadingOverlayRemoveEyeCoveringsText</code></td><td>Default: "Remove Sunglasses & Hat"</td></tr>
194
- <tr><td><code>loadingOverlayAvoidExcessiveBacklightingText</code></td><td>Default: "Avoid Excessive Backlighting"</td></tr>
195
- <tr><td><code>loadingOverlayContinueText</code></td><td>Default: "Continue"</td></tr>
196
- <tr><td><code>loadingOverlayCameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
197
- <tr><td><code>loadingOverlayModelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
209
+ <tr><td><code>loadingOverlay.headingText</code></td><td>Default: "Use your device camera to capture your face"</td></tr>
210
+ <tr><td><code>loadingOverlay.removeEyeCoveringsText</code></td><td>Default: "Remove Sunglasses & Hat"</td></tr>
211
+ <tr><td><code>loadingOverlay.avoidExcessiveBacklightingText</code></td><td>Default: "Avoid Excessive Backlighting"</td></tr>
212
+ <tr><td><code>loadingOverlay.continueText</code></td><td>Default: "Continue"</td></tr>
213
+ <tr><td><code>loadingOverlay.cameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
214
+ <tr><td><code>loadingOverlay.modelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
198
215
  <tr><td><code>guidanceHoldStillText</code></td><td>Default: "Hold still for a few seconds..."</td></tr>
199
216
  <tr><td><code>guidanceLookStraightText</code></td><td>Default: "Look straight into the camera..."</td></tr>
200
217
  <tr><td><code>guidanceMoveBackText</code></td><td>Default: "Move back..."</td></tr>
@@ -203,12 +220,12 @@ Render a fullscreen capture component that analyzes frames from the user's front
203
220
  <tr><td><code>guidanceRemoveEyeCoveringsText</code></td><td>Default: "Please remove your eye coverings (sunglasses, eye patch, etc.)..."</td></tr>
204
221
  <tr><td><code>guidanceRemoveHeadCoveringsText</code></td><td>Default: "Please remove your head coverings (hat, scarf, etc.)..."</td></tr>
205
222
  <tr><td><code>guidanceRemoveMaskText</code></td><td>Default: "Please remove your mask..."</td></tr>
206
- <tr><td><code>successHeadingText</code></td><td>Default: "Face liveness has been verified!"</td></tr>
207
- <tr><td><code>successRetryBtnText</code></td><td>Default: "Retry"</td></tr>
208
- <tr><td><code>successDoneBtnText</code></td><td>Default: "Done"</td></tr>
209
- <tr><td><code>failureHeadingText</code></td><td>Default: "Live face not detected, please try again"</td></tr>
210
- <tr><td><code>failureRetryBtnText</code></td><td>Default: "Retry"</td></tr>
211
- <tr><td><code>failureExitBtnText</code></td><td>Default: "Exit"</td></tr>
223
+ <tr><td><code>success.headingText</code></td><td>Default: "Face liveness has been verified!"</td></tr>
224
+ <tr><td><code>success.retryBtnText</code></td><td>Default: "Retry"</td></tr>
225
+ <tr><td><code>success.doneBtnText</code></td><td>Default: "Done"</td></tr>
226
+ <tr><td><code>failure.headingText</code></td><td>Default: "Live face not detected, please try again"</td></tr>
227
+ <tr><td><code>failure.retryBtnText</code></td><td>Default: "Retry"</td></tr>
228
+ <tr><td><code>failure.exitBtnText</code></td><td>Default: "Exit"</td></tr>
212
229
  </table>
213
230
 
214
231
  **Example**
@@ -257,12 +274,14 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
257
274
  <tr><td><code>webhooksEnabled</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked after submission.</td></tr>
258
275
  <tr><td><code>webhooksClientTraceId</code> (optional)</td><td>a customer provided trace id to use when invoking customer-configured webhooks.</td></tr>
259
276
  <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>idCaptureAssets</code> (optional)</td><td>object containing any asset overrides, for available options consult the ID Capture Assets table above.</td></tr>
261
- <tr><td><code>idCaptureColors</code> (optional)</td><td>object containing any color overrides, for available options consult the ID Capture Colors table above.</td></tr>
262
- <tr><td><code>idCaptureVerbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the ID Capture Verbiage table above.</td></tr>
263
- <tr><td><code>faceLivenessAssets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
264
- <tr><td><code>faceLivenessColors</code> (optional)</td><td>object containing any color overrides, for available options consult the Face Liveness Colors table above.</td></tr>
265
- <tr><td><code>faceLivenessVerbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above.</td></tr>
277
+ <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>
278
+ <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>
279
+ <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>
280
+ <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>
281
+ <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>
282
+ <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>
283
+ <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>
284
+ <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
285
  <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
286
  <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
287
  <tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Default is `false`.</td></tr>
@@ -317,12 +336,16 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
317
336
  <tr><td><code>webhooksEnabled</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked after submission.</td></tr>
318
337
  <tr><td><code>webhooksClientTraceId</code> (optional)</td><td>a customer provided trace id to use when invoking customer-configured webhooks.</td></tr>
319
338
  <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>idCaptureAssets</code> (optional)</td><td>object containing any asset overrides, for available options consult the ID Capture Assets table above.</td></tr>
321
- <tr><td><code>idCaptureColors</code> (optional)</td><td>object containing any color overrides, for available options consult the ID Capture Colors table above.</td></tr>
322
- <tr><td><code>idCaptureVerbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the ID Capture Verbiage table above.</td></tr>
323
- <tr><td><code>faceLivenessAssets</code> (optional)</td><td>object containing any asset overrides, for available options consult the Face Liveness Assets table above.</td></tr>
324
- <tr><td><code>faceLivenessColors</code> (optional)</td><td>object containing any color overrides, for available options consult the Face Liveness Colors table above.</td></tr>
325
- <tr><td><code>faceLivenessVerbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above.</td></tr>
339
+ <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>
340
+ <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>
341
+ <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>
342
+ <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>
343
+ <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>
344
+ <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>
345
+ <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>
346
+ <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>
347
+ <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>
348
+ <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
349
  <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
350
  <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
351
  <tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Default is `false`.</td></tr>
@@ -363,9 +386,13 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
363
386
  <tr><td><code>webhooksEnabled</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked after submission.</td></tr>
364
387
  <tr><td><code>webhooksClientTraceId</code> (optional)</td><td>a customer provided trace id to use when invoking customer-configured webhooks.</td></tr>
365
388
  <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>verbiage</code> (optional)</td><td>object containing any verbiage overrides, for available options consult the Face Liveness Verbiage table above.</td></tr>
389
+ <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>
390
+ <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>
391
+ <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>
392
+ <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>
393
+ <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>
394
+ <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>
395
+ <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
396
  <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
397
  <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
398
  <tr><td><code>debugMode</code> (optional)</td><td>boolean flag to enable on-screen prediction information output. Default is `false`.</td></tr>
@@ -447,8 +474,9 @@ Render a fullscreen capture component that analyzes frames from the user's front
447
474
  **Customer Identification Assets**
448
475
 
449
476
  <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>failureImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/manual_capture.png</td></tr>
477
+ <tr><td><code>loadingOverlay.instructionImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/Selfie-Image-1.png</td></tr>
478
+ <tr><td><code>loadingOverlay.accessBlockedImageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/camera-disable-icon.png</td></tr>
479
+ <tr><td><code>failure.imageUrl</code></td><td>Default: https://websdk-cdn-dev.idmission.com/assets/manual_capture.png</td></tr>
452
480
  </table>
453
481
 
454
482
  **Customer Identification Colors**
@@ -465,23 +493,23 @@ Render a fullscreen capture component that analyzes frames from the user's front
465
493
  **Customer Identification Verbiage**
466
494
 
467
495
  <table>
468
- <tr><td><code>loadingOverlayHeadingText</code></td><td>Default: "Use your device camera to capture your face"</td></tr>
469
- <tr><td><code>loadingOverlayRemoveEyeCoveringsText</code></td><td>Default: "Remove Sunglasses & Hat"</td></tr>
470
- <tr><td><code>loadingOverlayAvoidExcessiveBacklightingText</code></td><td>Default: "Avoid Excessive Backlighting"</td></tr>
471
- <tr><td><code>loadingOverlayContinueText</code></td><td>Default: "Continue"</td></tr>
472
- <tr><td><code>loadingOverlayCameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
473
- <tr><td><code>loadingOverlayModelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
496
+ <tr><td><code>loadingOverlay.headingText</code></td><td>Default: "Use your device camera to capture your face"</td></tr>
497
+ <tr><td><code>loadingOverlay.removeEyeCoveringsText</code></td><td>Default: "Remove Sunglasses & Hat"</td></tr>
498
+ <tr><td><code>loadingOverlay.avoidExcessiveBacklightingText</code></td><td>Default: "Avoid Excessive Backlighting"</td></tr>
499
+ <tr><td><code>loadingOverlay.continueText</code></td><td>Default: "Continue"</td></tr>
500
+ <tr><td><code>loadingOverlay.cameraInitializingText</code></td><td>Default: "Camera initializing..."</td></tr>
501
+ <tr><td><code>loadingOverlay.modelsWarmingUpText</code></td><td>Default: "Models warming up..."</td></tr>
474
502
  <tr><td><code>guidanceHoldStillText</code></td><td>Default: "Hold still for a few seconds..."</td></tr>
475
503
  <tr><td><code>guidanceLookStraightText</code></td><td>Default: "Look straight into the camera..."</td></tr>
476
504
  <tr><td><code>guidanceMoveBackText</code></td><td>Default: "Move back..."</td></tr>
477
505
  <tr><td><code>guidanceMoveForwardText</code></td><td>Default: "Move forward..."</td></tr>
478
506
  <tr><td><code>guidanceMoveToCenterText</code></td><td>Default: "Move to the center..."</td></tr>
479
- <tr><td><code>successHeadingText</code></td><td>Default: "Customer has been identified!"</td></tr>
480
- <tr><td><code>successRetryBtnText</code></td><td>Default: "Retry"</td></tr>
481
- <tr><td><code>successDoneBtnText</code></td><td>Default: "Done"</td></tr>
482
- <tr><td><code>failureHeadingText</code></td><td>Default: "Customer not found"</td></tr>
483
- <tr><td><code>failureRetryBtnText</code></td><td>Default: "Retry"</td></tr>
484
- <tr><td><code>failureExitBtnText</code></td><td>Default: "Exit"</td></tr>
507
+ <tr><td><code>success.headingText</code></td><td>Default: "Customer has been identified!"</td></tr>
508
+ <tr><td><code>success.retryBtnText</code></td><td>Default: "Retry"</td></tr>
509
+ <tr><td><code>success.doneBtnText</code></td><td>Default: "Done"</td></tr>
510
+ <tr><td><code>failure.headingText</code></td><td>Default: "Customer not found"</td></tr>
511
+ <tr><td><code>failure.retryBtnText</code></td><td>Default: "Retry"</td></tr>
512
+ <tr><td><code>failure.exitBtnText</code></td><td>Default: "Exit"</td></tr>
485
513
  </table>
486
514
 
487
515
  **Example**
package/dist/components/CompositeWizard.d.ts CHANGED
@@ -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 { SignatureKYCWizardProps } from './signature_kyc/SignatureKYCWizard';
8
- export type CompositeWizardCheck = 'IdCapture' | 'FaceLiveness' | 'SignatureCapture' | 'SignatureKYC' | 'AdditionalDocumentCapture';
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
- signatureKYCProps?: SignatureKYCWizardProps;
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, signatureKYCProps, additionalDocumentCaptureProps, captureSignature, captureSignatureVideo, }: CompositeWizardComponentProps) => ReactElement;
27
+ export declare const CompositeWizardComponent: ({ checks: userChecks, idCaptureProps, faceLivenessProps, signatureCaptureProps, videoSignatureCaptureProps, additionalDocumentCaptureProps, captureSignature, captureSignatureVideo, }: CompositeWizardComponentProps) => ReactElement;
package/dist/components/additional_document_capture/AdditionalDocumentCaptureWizard.d.ts CHANGED
@@ -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;
package/dist/components/customer_flows/CustomerBiometricsEnrollment.d.ts CHANGED
@@ -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 { NamespacedAdditionalDocumentsVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
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 { NamespacedSignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
8
- export type CustomerBiometricsEnrollmentVerbiage = FaceLivenessVerbiage & NamespacedSignatureCaptureVerbiage & NamespacedAdditionalDocumentsVerbiage;
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
- captureAdditionalDocuments?: AdditionalDocument[];
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, assets, colors, verbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerBiometricsEnrollmentProps) => ReactElement;
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;
package/dist/components/customer_flows/CustomerIdAndBiometricsEnrollment.d.ts CHANGED
@@ -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 { IdCaptureAssets } from '../id_capture/IdCaptureWizard';
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 { IdValidationVerbiage } from './IdValidation';
8
- import { IdCaptureColors } from '../id_capture/IdCapture';
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
- captureAdditionalDocuments?: AdditionalDocument[];
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, idCaptureAssets, idCaptureColors, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessColors, faceLivenessVerbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerEnrollmentProps) => ReactElement;
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;
package/dist/components/customer_flows/IdAndFaceValidation.d.ts CHANGED
@@ -1,11 +1,25 @@
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 { IdCaptureAssets } from '../id_capture/IdCaptureWizard';
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 { IdValidationVerbiage } from './IdValidation';
8
- import { IdCaptureColors } from '../id_capture/IdCapture';
8
+ import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
9
+ export type IdAndFaceValidationAssets = {
10
+ idCapture?: IdCaptureWizardAssets;
11
+ faceLiveness?: FaceLivenessAssets;
12
+ };
13
+ export type IdAndFaceValidationColors = {
14
+ idCapture?: IdCaptureWizardColors;
15
+ faceLiveness?: FaceLivenessColors;
16
+ };
17
+ export type IdAndFaceValidationVerbiage = {
18
+ idCapture?: IdCaptureWizardVerbiage;
19
+ faceLiveness?: FaceLivenessVerbiage;
20
+ signatureCapture?: SignatureCaptureVerbiage;
21
+ additionalDocumentCapture?: AdditionalDocumentCaptureVerbiage;
22
+ };
9
23
  export type IdAndFaceValidationProps = {
10
24
  lang?: LangOption;
11
25
  submissionToken: string;
@@ -25,13 +39,7 @@ export type IdAndFaceValidationProps = {
25
39
  passportAutoCaptureScoreThreshold?: number;
26
40
  idCardFocusScoreThreshold?: number;
27
41
  passportFocusScoreThreshold?: number;
28
- idCaptureAssets?: IdCaptureAssets;
29
- idCaptureColors?: IdCaptureColors;
30
- idCaptureVerbiage?: IdValidationVerbiage;
31
42
  faceLivenessTimeoutDurationMs?: number;
32
- faceLivenessAssets?: FaceLivenessAssets;
33
- faceLivenessColors?: FaceLivenessColors;
34
- faceLivenessVerbiage?: FaceLivenessVerbiage;
35
43
  onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
36
44
  onComplete?: (submissionResponse: SubmissionResponse) => void;
37
45
  onApproved?: (submissionResponse: SubmissionResponse) => void;
@@ -40,8 +48,11 @@ export type IdAndFaceValidationProps = {
40
48
  captureSignature?: boolean | (() => Promise<boolean>);
41
49
  captureSignatureVideo?: boolean | (() => Promise<boolean>);
42
50
  captureAdditionalDocuments?: AdditionalDocument[];
51
+ assets?: IdAndFaceValidationAssets;
52
+ colors?: IdAndFaceValidationColors;
53
+ verbiage?: IdAndFaceValidationVerbiage;
43
54
  geolocationEnabled?: boolean;
44
55
  geolocationRequired?: boolean;
45
56
  debugMode?: boolean;
46
57
  };
47
- export declare const IdAndFaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureColors, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessColors, faceLivenessVerbiage, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdAndFaceValidationProps) => ReactElement;
58
+ export declare const IdAndFaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, faceLivenessTimeoutDurationMs, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: IdAndFaceValidationProps) => ReactElement;
package/dist/components/customer_flows/IdValidation.d.ts CHANGED
@@ -1,12 +1,20 @@
1
1
  import { ReactElement } from 'react';
2
2
  import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
3
- import { IdCaptureAssets, IdCaptureVerbiage } from '../id_capture/IdCaptureWizard';
4
- import { NamespacedAdditionalDocumentsVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
3
+ import { IdCaptureWizardAssets, IdCaptureWizardColors, IdCaptureWizardVerbiage } from '../id_capture/IdCaptureWizard';
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 { NamespacedSignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
8
- import { IdCaptureColors } from '../id_capture/IdCapture';
9
- export type IdValidationVerbiage = IdCaptureVerbiage & NamespacedSignatureCaptureVerbiage & NamespacedAdditionalDocumentsVerbiage;
7
+ import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
8
+ import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
9
+ export type IdValidationAssets = IdCaptureWizardAssets;
10
+ export type IdValidationColors = IdCaptureWizardColors & {
11
+ videoSignatureCapture?: VideoSignatureColors;
12
+ };
13
+ export type IdValidationVerbiage = IdCaptureWizardVerbiage & {
14
+ additionalDocumentCapture?: AdditionalDocumentCaptureVerbiage;
15
+ signatureCapture?: SignatureCaptureVerbiage;
16
+ videoSignatureCapture?: VideoSignatureVerbiage;
17
+ };
10
18
  export type IdValidationProps = {
11
19
  lang?: LangOption;
12
20
  submissionToken: string;
@@ -32,8 +40,8 @@ export type IdValidationProps = {
32
40
  captureSignature?: boolean | (() => Promise<boolean>);
33
41
  captureSignatureVideo?: boolean | (() => Promise<boolean>);
34
42
  captureAdditionalDocuments?: AdditionalDocument[];
35
- assets?: IdCaptureAssets;
36
- colors?: IdCaptureColors;
43
+ assets?: IdValidationAssets;
44
+ colors?: IdValidationColors;
37
45
  verbiage?: IdValidationVerbiage;
38
46
  geolocationEnabled?: boolean;
39
47
  geolocationRequired?: boolean;
package/dist/components/customer_flows/SignatureKYC.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import { ReactElement } from 'react';
2
2
  import { LangOption } from '../../lib/locales';
3
3
  import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
4
- import { SignatureKYCColors, SignatureKYCVerbiage } from '../signature_kyc/SignatureKYCWizard';
4
+ import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
5
5
  export type SignatureKYCProps = {
6
6
  lang?: LangOption;
7
7
  submissionToken: string;
@@ -9,8 +9,8 @@ export type SignatureKYCProps = {
9
9
  submissionUrl?: string;
10
10
  onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
11
11
  onComplete?: (submissionResponse: SubmissionResponse) => void;
12
- colors?: SignatureKYCColors;
13
- verbiage?: SignatureKYCVerbiage;
12
+ colors?: VideoSignatureColors;
13
+ verbiage?: VideoSignatureVerbiage;
14
14
  geolocationEnabled?: boolean;
15
15
  geolocationRequired?: boolean;
16
16
  debugMode?: boolean;
package/dist/components/customer_identification/CustomerIdentificationFailure.d.ts CHANGED
@@ -1,11 +1,17 @@
1
1
  import { ReactElement } from 'react';
2
- export type CustomerIdentificationFailureProps = {
2
+ export type CustomerIdentificationFailureAssets = {
3
+ imageUrl?: string;
4
+ };
5
+ export type CustomerIdentificationFailureVerbiage = {
3
6
  headingText?: string;
4
7
  retryBtnText?: string;
5
8
  exitBtnText?: string;
6
- imageUrl?: string;
9
+ };
10
+ export type CustomerIdentificationFailureProps = {
7
11
  canRetry?: boolean;
8
12
  onRetryClick?: () => void;
9
13
  onExitClick?: () => void;
14
+ assets?: CustomerIdentificationFailureAssets;
15
+ verbiage?: CustomerIdentificationFailureVerbiage;
10
16
  };
11
- export declare const CustomerIdentificationFailure: ({ headingText, retryBtnText, exitBtnText, imageUrl, canRetry, onRetryClick, onExitClick, }: CustomerIdentificationFailureProps) => ReactElement;
17
+ export declare const CustomerIdentificationFailure: ({ canRetry, onRetryClick, onExitClick, assets, verbiage, }: CustomerIdentificationFailureProps) => ReactElement;