idmission-web-sdk 1.0.99 → 1.0.101
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 +8 -0
- package/dist/components/customer_flows/CustomerBiometricsEnrollment.d.ts +2 -0
- package/dist/components/customer_flows/CustomerIdAndBiometricsEnrollment.d.ts +2 -0
- package/dist/components/customer_flows/CustomerIdentification.d.ts +2 -0
- package/dist/components/customer_flows/CustomerVerification.d.ts +2 -0
- package/dist/components/customer_flows/FaceValidation.d.ts +2 -0
- package/dist/components/customer_flows/IdAndFaceValidation.d.ts +2 -0
- package/dist/components/customer_flows/IdValidation.d.ts +2 -0
- package/dist/components/customer_flows/SignatureKYC.d.ts +2 -0
- package/dist/components/customer_flows/VideoIdValidation.d.ts +2 -0
- package/dist/components/customer_identification/CustomerIdentificationWizard.d.ts +2 -1
- package/dist/components/customer_verification/CustomerVerificationWizard.d.ts +2 -1
- package/dist/components/face_liveness/FaceLivenessWizard.d.ts +2 -1
- package/dist/components/id_capture/IdCaptureLoadingOverlay.d.ts +3 -1
- package/dist/components/id_capture/IdCaptureWizard.d.ts +2 -1
- package/dist/components/selfie_capture/SelfieCaptureLoadingOverlay.d.ts +3 -1
- package/dist/components/submission/SubmissionProvider.d.ts +1 -1
- package/dist/components/submission/TokenIssuerNotAllowedErrorOverlay.d.ts +2 -0
- package/dist/components/video_id/IdVideoCaptureWizard.d.ts +2 -1
- package/dist/components/video_signature_capture/VideoSignatureWizard.d.ts +2 -1
- package/dist/sdk2.cjs.development.js +108 -18
- 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 +108 -18
- package/dist/sdk2.esm.js.map +1 -1
- package/dist/sdk2.umd.development.js +108 -18
- 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/CustomerFlows/IdValidation.stories.d.ts +6 -0
- package/dist/version.d.ts +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -78,6 +78,7 @@ Render a fullscreen ID capture component that instructs the user to photograph b
|
|
|
78
78
|
<tr><td><code>onApproved</code> (optional)</td><td>callback function that fires when the user completes the IDValidation flow with a valid ID. Arguments: same as onComplete.</td></tr>
|
|
79
79
|
<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user completes the IDValidation flow with an invalid ID. Arguments: same as onComplete.</td></tr>
|
|
80
80
|
<tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
|
|
81
|
+
<tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
|
|
81
82
|
<tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
|
|
82
83
|
<tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
|
|
83
84
|
<tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
|
|
@@ -223,6 +224,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
223
224
|
<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user completes the FaceValidation flow and fails the realness check. Arguments: same as onComplete.</td></tr>
|
|
224
225
|
<tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
|
|
225
226
|
<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the FaceValidation flow and failing the realness check.</td></tr>
|
|
227
|
+
<tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
|
|
226
228
|
<tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
|
|
227
229
|
<tr><td><code>timeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000 (15 seconds).</td></tr>
|
|
228
230
|
<tr><td><code>skipSuccessScreen</code> (optional)</td><td>boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false.</td></tr>
|
|
@@ -335,6 +337,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
|
|
|
335
337
|
<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user completes both flows with an invalid ID or fails the realness check. Arguments: same as onComplete.</td></tr>
|
|
336
338
|
<tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
|
|
337
339
|
<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.</td></tr>
|
|
340
|
+
<tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
|
|
338
341
|
<tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
|
|
339
342
|
<tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
|
|
340
343
|
<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
|
|
@@ -407,6 +410,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
|
|
|
407
410
|
<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow but could not be enrolled. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check.</td></tr>
|
|
408
411
|
<tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
|
|
409
412
|
<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.</td></tr>
|
|
413
|
+
<tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
|
|
410
414
|
<tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
|
|
411
415
|
<tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
|
|
412
416
|
<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
|
|
@@ -477,6 +481,7 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
|
|
|
477
481
|
<tr><td><code>onDenied</code> (optional)</td><td>callback function that fires when the user has completed the CustomerBiometricsEnrollment flow but could not be enrolled. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check.</td></tr>
|
|
478
482
|
<tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
|
|
479
483
|
<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check.</td></tr>
|
|
484
|
+
<tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
|
|
480
485
|
<tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
|
|
481
486
|
<tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
|
|
482
487
|
<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
|
|
@@ -529,6 +534,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
529
534
|
<tr><td><code>onCustomerNotMatched</code> (optional)</td><td>callback function that fires when the user has completed the CustomerVerification flow but does not match the specified customer <code>enrollmentId</code>. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check.</td></tr>
|
|
530
535
|
<tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
|
|
531
536
|
<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after failing the realness check.</td></tr>
|
|
537
|
+
<tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
|
|
532
538
|
<tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
|
|
533
539
|
<tr><td><code>timeoutDurationMs</code> (optional)</td><td>the duration of time in milliseconds that the user may try to pass the realness check. Defaults to 15000 (15 seconds).</td></tr>
|
|
534
540
|
<tr><td><code>skipSuccessScreen</code> (optional)</td><td>boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false.</td></tr>
|
|
@@ -571,6 +577,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
571
577
|
<tr><td><code>onCustomerNotMatched</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdentification flow but does not match any registered customer. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check.</td></tr>
|
|
572
578
|
<tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
|
|
573
579
|
<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after failing the realness check.</td></tr>
|
|
580
|
+
<tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
|
|
574
581
|
<tr><td><code>skipSuccessScreen</code> (optional)</td><td>boolean to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to false.</td></tr>
|
|
575
582
|
<tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
|
|
576
583
|
<tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
|
|
@@ -667,6 +674,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
|
|
|
667
674
|
<tr><td><code>onComplete</code> (optional)</td><td>callback function that fires when the user has completed the VideoIdValidation flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user.</td></tr>
|
|
668
675
|
<tr><td><code>onExitCapture</code> (optional)</td><td>callback function that fires when the user clicks the X button during capture.</td></tr>
|
|
669
676
|
<tr><td><code>onExitAfterFailure</code> (optional)</td><td>callback function that fires when the user clicks the exit button after failing the realness check.</td></tr>
|
|
677
|
+
<tr><td><code>onUserCancel</code> (optional)</td><td>callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay.</td></tr>
|
|
670
678
|
<tr><td><code>lang</code> (optional)</td><td>language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto.</td></tr>
|
|
671
679
|
<tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
|
|
672
680
|
<tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
|
|
@@ -71,6 +71,8 @@ export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
|
|
|
71
71
|
onExitCapture?: () => void;
|
|
72
72
|
/** Callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. */
|
|
73
73
|
onExitAfterFailure?: () => void;
|
|
74
|
+
/** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
|
|
75
|
+
onUserCancel?: () => void;
|
|
74
76
|
/** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
|
|
75
77
|
captureSignature?: boolean | (() => Promise<boolean>);
|
|
76
78
|
/** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */
|
|
@@ -109,6 +109,8 @@ export interface CustomerEnrollmentProps extends PropsWithChildren {
|
|
|
109
109
|
onExitCapture?: () => void;
|
|
110
110
|
/** Callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. */
|
|
111
111
|
onExitAfterFailure?: () => void;
|
|
112
|
+
/** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
|
|
113
|
+
onUserCancel?: () => void;
|
|
112
114
|
/** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
|
|
113
115
|
captureSignature?: boolean | (() => Promise<boolean>);
|
|
114
116
|
/** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */
|
|
@@ -45,6 +45,8 @@ export interface CustomerIdentificationProps extends PropsWithChildren {
|
|
|
45
45
|
onExitCapture?: () => void;
|
|
46
46
|
/** Callback function that fires when the user clicks the exit button after failing the realness check. */
|
|
47
47
|
onExitAfterFailure?: () => void;
|
|
48
|
+
/** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
|
|
49
|
+
onUserCancel?: () => void;
|
|
48
50
|
/** Name of an included theme or object containing theme properties. **/
|
|
49
51
|
theme?: ThemeInput;
|
|
50
52
|
/** Object containing any asset overrides. */
|
|
@@ -54,6 +54,8 @@ export interface CustomerVerificationProps extends PropsWithChildren {
|
|
|
54
54
|
onExitCapture?: () => void;
|
|
55
55
|
/** Callback function that fires when the user clicks the exit button after failing the realness check. */
|
|
56
56
|
onExitAfterFailure?: () => void;
|
|
57
|
+
/** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
|
|
58
|
+
onUserCancel?: () => void;
|
|
57
59
|
/** Boolean flag to indicate whether users should be prompted to share their location. Default is `true`. */
|
|
58
60
|
geolocationEnabled?: boolean;
|
|
59
61
|
/** Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`. */
|
|
@@ -44,6 +44,8 @@ export interface FaceValidationProps extends PropsWithChildren {
|
|
|
44
44
|
onExitCapture?: () => void;
|
|
45
45
|
/** Callback function that fires when the user clicks the exit button after completing the FaceValidation flow and failing the realness check. */
|
|
46
46
|
onExitAfterFailure?: () => void;
|
|
47
|
+
/** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
|
|
48
|
+
onUserCancel?: () => void;
|
|
47
49
|
/** Name of an included theme or object containing theme properties. **/
|
|
48
50
|
theme?: ThemeInput;
|
|
49
51
|
/** Object containing any asset overrides. */
|
|
@@ -108,6 +108,8 @@ export interface IdAndFaceValidationProps extends PropsWithChildren {
|
|
|
108
108
|
onExitCapture?: () => void;
|
|
109
109
|
/** Callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. */
|
|
110
110
|
onExitAfterFailure?: () => void;
|
|
111
|
+
/** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
|
|
112
|
+
onUserCancel?: () => void;
|
|
111
113
|
/** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
|
|
112
114
|
captureSignature?: boolean | (() => Promise<boolean>);
|
|
113
115
|
/** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */
|
|
@@ -88,6 +88,8 @@ export interface IdValidationProps extends PropsWithChildren {
|
|
|
88
88
|
onDenied?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
|
|
89
89
|
/** Callback function that fires when the user clicks the exit button during ID or selfie capture. */
|
|
90
90
|
onExitCapture?: () => void;
|
|
91
|
+
/** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
|
|
92
|
+
onUserCancel?: () => void;
|
|
91
93
|
/** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
|
|
92
94
|
captureSignature?: boolean | (() => Promise<boolean>);
|
|
93
95
|
/** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */
|
|
@@ -16,6 +16,8 @@ export interface SignatureKYCProps extends PropsWithChildren {
|
|
|
16
16
|
onSubmit?: (req: SubmissionRequest) => void;
|
|
17
17
|
/** Callback function that fires when the user completes the SignatureKYC flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the data submitted by the user. */
|
|
18
18
|
onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
|
|
19
|
+
/** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
|
|
20
|
+
onUserCancel?: () => void;
|
|
19
21
|
/** Boolean or async function to indicate whether to proceed automatically after capture guidance is satisfied. If an async function is supplied returning a boolean, it will be evaluated at the time of capture guidance satisfaction. Defaults to `false`. */
|
|
20
22
|
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
21
23
|
/** Name of an included theme or object containing theme properties. **/
|
|
@@ -70,6 +70,8 @@ export interface VideoIdValidationProps extends PropsWithChildren {
|
|
|
70
70
|
onExitCapture?: () => void;
|
|
71
71
|
/** Callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. */
|
|
72
72
|
onExitAfterFailure?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
|
|
73
|
+
/** Callback function that fires when the user clicks the exit button from the loading overlay, declining to engage with IDmission. Binding this callback results in the cancel button being rendered on the loading overlay. */
|
|
74
|
+
onUserCancel?: () => void;
|
|
73
75
|
/** Object containing any overrides for IDValidation. */
|
|
74
76
|
idCaptureProps?: IdCaptureWizardProps;
|
|
75
77
|
/** Object containing any overrides for FaceLiveness. */
|
|
@@ -29,6 +29,7 @@ export type CustomerIdentificationWizardProps = {
|
|
|
29
29
|
onCustomerNotMatched?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
|
|
30
30
|
onExitCapture?: () => void;
|
|
31
31
|
onExitAfterFailure?: () => void;
|
|
32
|
+
onUserCancel?: () => void;
|
|
32
33
|
onCaptureGuidanceTimeout?: () => void;
|
|
33
34
|
captureGuidanceTimeoutDurationMs?: number;
|
|
34
35
|
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
@@ -38,4 +39,4 @@ export type CustomerIdentificationWizardProps = {
|
|
|
38
39
|
verbiage?: CustomerIdentificationVerbiage;
|
|
39
40
|
debugMode?: boolean;
|
|
40
41
|
};
|
|
41
|
-
export declare const CustomerIdentificationWizard: ({ onComplete, onCustomerMatched, onCustomerNotMatched, onExitCapture, onExitAfterFailure, onCaptureGuidanceTimeout, captureGuidanceTimeoutDurationMs, skipSuccessScreen, assets, classNames, colors, verbiage, debugMode, }: CustomerIdentificationWizardProps) => ReactElement;
|
|
42
|
+
export declare const CustomerIdentificationWizard: ({ onComplete, onCustomerMatched, onCustomerNotMatched, onExitCapture, onExitAfterFailure, onUserCancel, onCaptureGuidanceTimeout, captureGuidanceTimeoutDurationMs, skipSuccessScreen, assets, classNames, colors, verbiage, debugMode, }: CustomerIdentificationWizardProps) => ReactElement;
|
|
@@ -31,6 +31,7 @@ export type CustomerVerificationWizardProps = {
|
|
|
31
31
|
onCustomerNotMatched?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
|
|
32
32
|
onExitCapture?: () => void;
|
|
33
33
|
onExitAfterFailure?: () => void;
|
|
34
|
+
onUserCancel?: () => void;
|
|
34
35
|
onCaptureGuidanceTimeout?: () => void;
|
|
35
36
|
captureGuidanceTimeoutDurationMs?: number;
|
|
36
37
|
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
@@ -40,4 +41,4 @@ export type CustomerVerificationWizardProps = {
|
|
|
40
41
|
verbiage?: CustomerVerificationVerbiage;
|
|
41
42
|
debugMode?: boolean;
|
|
42
43
|
};
|
|
43
|
-
export declare const CustomerVerificationWizard: ({ onComplete, onCustomerMatched, onCustomerNotMatched, onExitCapture, onExitAfterFailure, onCaptureGuidanceTimeout, captureGuidanceTimeoutDurationMs, skipSuccessScreen, assets, classNames, colors, verbiage, debugMode, }: CustomerVerificationWizardProps) => ReactElement;
|
|
44
|
+
export declare const CustomerVerificationWizard: ({ onComplete, onCustomerMatched, onCustomerNotMatched, onExitCapture, onExitAfterFailure, onUserCancel, onCaptureGuidanceTimeout, captureGuidanceTimeoutDurationMs, skipSuccessScreen, assets, classNames, colors, verbiage, debugMode, }: CustomerVerificationWizardProps) => ReactElement;
|
|
@@ -30,6 +30,7 @@ export type FaceLivenessWizardProps = {
|
|
|
30
30
|
onTimeout?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
|
|
31
31
|
onExitCapture?: () => void;
|
|
32
32
|
onExitAfterFailure?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
|
|
33
|
+
onUserCancel?: () => void;
|
|
33
34
|
timeoutDurationMs?: number;
|
|
34
35
|
maxRetries?: number;
|
|
35
36
|
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
@@ -40,4 +41,4 @@ export type FaceLivenessWizardProps = {
|
|
|
40
41
|
verbiage?: FaceLivenessVerbiage;
|
|
41
42
|
debugMode?: boolean;
|
|
42
43
|
};
|
|
43
|
-
export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitCapture, onExitAfterFailure, timeoutDurationMs, maxRetries, skipSuccessScreen, releaseCameraAccessOnExit, assets, classNames, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;
|
|
44
|
+
export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitCapture, onExitAfterFailure, onUserCancel, timeoutDurationMs, maxRetries, skipSuccessScreen, releaseCameraAccessOnExit, assets, classNames, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;
|
|
@@ -16,6 +16,7 @@ export type IdCaptureLoadingOverlayClassNames = {
|
|
|
16
16
|
continuityCameraCheckboxLabel?: string;
|
|
17
17
|
continuityCameraCheckbox?: string;
|
|
18
18
|
continueBtn?: string;
|
|
19
|
+
cancelBtn?: string;
|
|
19
20
|
cameraAccessDenied?: CameraAccessDeniedOverlayClassNames;
|
|
20
21
|
};
|
|
21
22
|
export type IdCaptureLoadingOverlayColors = {
|
|
@@ -32,9 +33,10 @@ export type IdCaptureLoadingOverlayVerbiage = {
|
|
|
32
33
|
};
|
|
33
34
|
export type IdCaptureLoadingOverlayProps = {
|
|
34
35
|
onDismissed?: () => void;
|
|
36
|
+
onUserCancel?: () => void;
|
|
35
37
|
assets?: IdCaptureLoadingOverlayAssets;
|
|
36
38
|
classNames?: IdCaptureLoadingOverlayClassNames;
|
|
37
39
|
colors?: IdCaptureLoadingOverlayColors;
|
|
38
40
|
verbiage?: IdCaptureLoadingOverlayVerbiage;
|
|
39
41
|
};
|
|
40
|
-
export declare const IdCaptureLoadingOverlay: ({ onDismissed, assets, classNames, colors, verbiage: rawVerbiage, }: IdCaptureLoadingOverlayProps) => ReactElement;
|
|
42
|
+
export declare const IdCaptureLoadingOverlay: ({ onDismissed, onUserCancel, assets, classNames, colors, verbiage: rawVerbiage, }: IdCaptureLoadingOverlayProps) => ReactElement;
|
|
@@ -46,6 +46,7 @@ export type IdCaptureSubmission = {
|
|
|
46
46
|
export type IdCaptureWizardProps = {
|
|
47
47
|
onSuccess?: (submission: IdCaptureSubmission) => void;
|
|
48
48
|
onExitCapture?: () => void;
|
|
49
|
+
onUserCancel?: () => void;
|
|
49
50
|
precapturedDocuments?: CapturedDocuments;
|
|
50
51
|
captureRequirement?: IdCaptureRequirementOption;
|
|
51
52
|
autoCaptureEnabled?: boolean;
|
|
@@ -65,4 +66,4 @@ export type IdCaptureWizardProps = {
|
|
|
65
66
|
verbiage?: IdCaptureWizardVerbiage;
|
|
66
67
|
debugMode?: boolean;
|
|
67
68
|
};
|
|
68
|
-
export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, precapturedDocuments, captureRequirement, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, releaseCameraAccessOnExit, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
|
|
69
|
+
export declare const IdCaptureWizard: ({ onSuccess, onExitCapture, onUserCancel, precapturedDocuments, captureRequirement, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, releaseCameraAccessOnExit, assets, classNames, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
|
|
@@ -14,6 +14,7 @@ export type SelfieCaptureLoadingOverlayClassNames = {
|
|
|
14
14
|
image?: string;
|
|
15
15
|
buttonsRow?: string;
|
|
16
16
|
continueBtn?: string;
|
|
17
|
+
cancelBtn?: string;
|
|
17
18
|
cameraAccessDenied?: CameraAccessDeniedOverlayClassNames;
|
|
18
19
|
};
|
|
19
20
|
export type SelfieCaptureLoadingOverlayColors = {
|
|
@@ -31,9 +32,10 @@ export type SelfieCaptureLoadingOverlayVerbiage = {
|
|
|
31
32
|
};
|
|
32
33
|
export type SelfieCaptureLoadingOverlayProps = {
|
|
33
34
|
onDismissed?: () => void;
|
|
35
|
+
onUserCancel?: () => void;
|
|
34
36
|
assets?: SelfieCaptureLoadingOverlayAssets;
|
|
35
37
|
classNames?: SelfieCaptureLoadingOverlayClassNames;
|
|
36
38
|
colors?: SelfieCaptureLoadingOverlayColors;
|
|
37
39
|
verbiage?: SelfieCaptureLoadingOverlayVerbiage;
|
|
38
40
|
};
|
|
39
|
-
export declare const SelfieCaptureLoadingOverlay: ({ onDismissed, assets, classNames, colors, verbiage: rawVerbiage, }: SelfieCaptureLoadingOverlayProps) => ReactElement;
|
|
41
|
+
export declare const SelfieCaptureLoadingOverlay: ({ onDismissed, onUserCancel, assets, classNames, colors, verbiage: rawVerbiage, }: SelfieCaptureLoadingOverlayProps) => ReactElement;
|
|
@@ -4,7 +4,7 @@ import { UploadedDocument } from '../additional_document_capture/AdditionalDocum
|
|
|
4
4
|
import { SignatureData } from '../signature_capture/data';
|
|
5
5
|
import { NetworkError, SubmissionError } from './Errors';
|
|
6
6
|
import { CapturedDocuments } from '../id_capture/CapturedDocuments';
|
|
7
|
-
export type TokenState = 'NOT_PARSED' | 'PARSING' | 'GOOD' | 'EXPIRED' | 'INVALID_FORMAT' | 'INVALID_SIGNATURE' | '
|
|
7
|
+
export type TokenState = 'NOT_PARSED' | 'PARSING' | 'GOOD' | 'MISSING' | 'EXPIRED' | 'INVALID_FORMAT' | 'INVALID_SIGNATURE' | 'ISSUER_NOT_ALLOWED' | 'PUBLIC_KEY_LOAD_FAILED';
|
|
8
8
|
export type SubmissionState = {
|
|
9
9
|
submit: () => Promise<SubmissionResponse | null>;
|
|
10
10
|
submissionStatus: SubmissionStatus;
|
|
@@ -32,6 +32,7 @@ export type VideoIdWizardProps = {
|
|
|
32
32
|
onComplete?: () => void;
|
|
33
33
|
onExitCapture?: () => void;
|
|
34
34
|
onExitAfterFailure?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
|
|
35
|
+
onUserCancel?: () => void;
|
|
35
36
|
idCaptureProps?: IdCaptureWizardProps;
|
|
36
37
|
faceLivenessProps?: FaceLivenessWizardProps;
|
|
37
38
|
idCardFrontDetectionThreshold?: number;
|
|
@@ -49,4 +50,4 @@ export type VideoIdWizardProps = {
|
|
|
49
50
|
verbiage?: VideoIdWizardVerbiage;
|
|
50
51
|
debugMode?: boolean;
|
|
51
52
|
};
|
|
52
|
-
export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, idCaptureProps, faceLivenessProps, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, readTextPrompt, readTextTimeoutDurationMs, skipIdCapture, skipShowIdCardBack, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;
|
|
53
|
+
export declare const VideoIdWizard: ({ onComplete, onExitCapture, onExitAfterFailure, onUserCancel, idCaptureProps, faceLivenessProps, idCardFrontDetectionThreshold, idCardFrontFocusThreshold, goodIdCardFrontFramesThreshold, showIdCardBackDurationMs, readTextPrompt, readTextTimeoutDurationMs, skipIdCapture, skipShowIdCardBack, assets, classNames, colors, verbiage, debugMode, }: VideoIdWizardProps) => ReactElement;
|
|
@@ -27,6 +27,7 @@ export type VideoSignatureWizardProps = {
|
|
|
27
27
|
onVideoCaptured?: (videoData: Blob, signatureData: SignatureData, signatureImageData: string) => void;
|
|
28
28
|
onRetryClicked?: () => void;
|
|
29
29
|
onExitCapture?: () => void;
|
|
30
|
+
onUserCancel?: () => void;
|
|
30
31
|
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
31
32
|
assets?: VideoSignatureAssets;
|
|
32
33
|
classNames?: VideoSignatureClassNames;
|
|
@@ -34,4 +35,4 @@ export type VideoSignatureWizardProps = {
|
|
|
34
35
|
verbiage?: VideoSignatureVerbiage;
|
|
35
36
|
debugMode?: boolean;
|
|
36
37
|
};
|
|
37
|
-
export declare const VideoSignatureWizard: ({ onComplete, onVideoCaptured, onRetryClicked, onExitCapture, skipSuccessScreen, assets, classNames, colors, verbiage, debugMode, }: VideoSignatureWizardProps) => ReactElement;
|
|
38
|
+
export declare const VideoSignatureWizard: ({ onComplete, onVideoCaptured, onRetryClicked, onExitCapture, onUserCancel, skipSuccessScreen, assets, classNames, colors, verbiage, debugMode, }: VideoSignatureWizardProps) => ReactElement;
|