idmission-web-sdk 0.0.64 → 0.0.66
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 +7 -0
- package/dist/components/common/useShowSuccessScreen.d.ts +1 -0
- package/dist/components/customer_flows/CustomerBiometricsEnrollment.d.ts +2 -1
- package/dist/components/customer_flows/CustomerIdAndBiometricsEnrollment.d.ts +2 -1
- package/dist/components/customer_flows/CustomerIdentification.d.ts +2 -1
- package/dist/components/customer_flows/CustomerVerification.d.ts +2 -1
- package/dist/components/customer_flows/FaceValidation.d.ts +2 -1
- package/dist/components/customer_flows/IdAndFaceValidation.d.ts +6 -2
- package/dist/components/customer_flows/IdValidation.d.ts +2 -1
- package/dist/components/customer_flows/SignatureKYC.d.ts +2 -1
- 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/IdCaptureModelsProvider.d.ts +5 -0
- package/dist/components/id_capture/IdCaptureWizard.d.ts +2 -1
- package/dist/components/video_signature_capture/VideoSignatureWizard.d.ts +2 -1
- package/dist/sdk2.cjs.development.js +316 -223
- 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 +316 -223
- package/dist/sdk2.esm.js.map +1 -1
- package/dist/sdk2.umd.development.js +316 -223
- 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/FaceValidation.stories.d.ts +1 -0
- package/dist/stories/CustomerFlows/IdAndFaceValidation.stories.d.ts +2 -0
- package/dist/stories/CustomerFlows/IdValidation.stories.d.ts +1 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -58,6 +58,7 @@ Render a fullscreen ID capture component that instructs the user to photograph b
|
|
|
58
58
|
<tr><td><code>passportAutoCaptureScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which document detection guidance score condition is considered to be met for passports.</td></tr>
|
|
59
59
|
<tr><td><code>idCardFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards.</td></tr>
|
|
60
60
|
<tr><td><code>passportFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for passports.</td></tr>
|
|
61
|
+
<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>
|
|
61
62
|
<tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
|
|
62
63
|
<tr><td><code>manualReviewRequired</code> (optional)</td><td>boolean flag to indicate whether responses should always be reviewed by a human.</td></tr>
|
|
63
64
|
<tr><td><code>verifyIdWithExternalDatabases</code> (optional)</td><td>boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc.</td></tr>
|
|
@@ -184,6 +185,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
184
185
|
<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>
|
|
185
186
|
<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>
|
|
186
187
|
<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>
|
|
188
|
+
<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>
|
|
187
189
|
<tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
|
|
188
190
|
<tr><td><code>webhooksEnabled</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked after submission.</td></tr>
|
|
189
191
|
<tr><td><code>webhooksClientTraceId</code> (optional)</td><td>a customer provided trace id to use when invoking customer-configured webhooks.</td></tr>
|
|
@@ -297,6 +299,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
|
|
|
297
299
|
<tr><td><code>idCardFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards.</td></tr>
|
|
298
300
|
<tr><td><code>passportFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for passports.</td></tr>
|
|
299
301
|
<tr><td><code>faceLivenessTimeoutDurationMs</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>
|
|
302
|
+
<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>
|
|
300
303
|
<tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
|
|
301
304
|
<tr><td><code>manualReviewRequired</code> (optional)</td><td>boolean flag to indicate whether responses should always be reviewed by a human.</td></tr>
|
|
302
305
|
<tr><td><code>verifyIdWithExternalDatabases</code> (optional)</td><td>boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc.</td></tr>
|
|
@@ -357,6 +360,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
|
|
|
357
360
|
<tr><td><code>idCardFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards.</td></tr>
|
|
358
361
|
<tr><td><code>passportFocusScoreThreshold</code> (optional)</td><td>number between 0 and 1 at which focus guidance score condition is considered to be met for passports.</td></tr>
|
|
359
362
|
<tr><td><code>faceLivenessTimeoutDurationMs</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>
|
|
363
|
+
<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>
|
|
360
364
|
<tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
|
|
361
365
|
<tr><td><code>manualReviewRequired</code> (optional)</td><td>boolean flag to indicate whether responses should always be reviewed by a human.</td></tr>
|
|
362
366
|
<tr><td><code>verifyIdWithExternalDatabases</code> (optional)</td><td>boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc.</td></tr>
|
|
@@ -411,6 +415,7 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
|
|
|
411
415
|
<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
|
|
412
416
|
<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>
|
|
413
417
|
<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>
|
|
418
|
+
<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>
|
|
414
419
|
<tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
|
|
415
420
|
<tr><td><code>deduplicationEnabled</code> (optional)</td><td>boolean flag indicating whether submissions from the same user should be de-duplicated.</td></tr>
|
|
416
421
|
<tr><td><code>deduplicationSynchronous</code> (optional)</td><td>boolean flag indicating whether to wait for de-duplication to complete before allowing the user to proceed.</td></tr>
|
|
@@ -454,6 +459,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
454
459
|
<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>
|
|
455
460
|
<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>
|
|
456
461
|
<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>
|
|
462
|
+
<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>
|
|
457
463
|
<tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
|
|
458
464
|
<tr><td><code>webhooksEnabled</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked after submission.</td></tr>
|
|
459
465
|
<tr><td><code>webhooksClientTraceId</code> (optional)</td><td>a customer provided trace id to use when invoking customer-configured webhooks.</td></tr>
|
|
@@ -489,6 +495,7 @@ Render a fullscreen capture component that analyzes frames from the user's front
|
|
|
489
495
|
<tr><td><code>onCustomerMatched</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdentification flow and matches a pre-registered customer <code>enrollmentId</code> in IDmission's database. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check.</td></tr>
|
|
490
496
|
<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>
|
|
491
497
|
<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>
|
|
498
|
+
<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>
|
|
492
499
|
<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>
|
|
493
500
|
<tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
|
|
494
501
|
<tr><td><code>webhooksEnabled</code> (optional)</td><td>boolean flag to indicate whether customer-configured webhooks should be invoked after submission.</td></tr>
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export declare function useShowSuccessScreen(skipSuccessScreen: boolean | (() => Promise<boolean>), successScreenReady: boolean, onDoneCallback?: () => void): boolean;
|
|
@@ -32,6 +32,7 @@ export type CustomerBiometricsEnrollmentProps = {
|
|
|
32
32
|
webhooksClientTraceId?: string;
|
|
33
33
|
webhooksStripSpecialCharacters?: boolean;
|
|
34
34
|
timeoutDurationMs?: number;
|
|
35
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
35
36
|
onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
|
|
36
37
|
onComplete?: (submissionResponse: SubmissionResponse) => void;
|
|
37
38
|
onEnrolled?: (submissionResponse: SubmissionResponse) => void;
|
|
@@ -47,4 +48,4 @@ export type CustomerBiometricsEnrollmentProps = {
|
|
|
47
48
|
geolocationRequired?: boolean;
|
|
48
49
|
debugMode?: boolean;
|
|
49
50
|
};
|
|
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;
|
|
51
|
+
export declare const CustomerBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, companyId, deduplicationEnabled, deduplicationSynchronous, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, skipSuccessScreen, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureAdditionalDocuments, captureSignature, captureSignatureVideo, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: CustomerBiometricsEnrollmentProps) => ReactElement;
|
|
@@ -46,6 +46,7 @@ export type CustomerEnrollmentProps = {
|
|
|
46
46
|
idCardFocusScoreThreshold?: number;
|
|
47
47
|
passportFocusScoreThreshold?: number;
|
|
48
48
|
faceLivenessTimeoutDurationMs?: number;
|
|
49
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
49
50
|
onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
|
|
50
51
|
onComplete?: (submissionResponse: SubmissionResponse) => void;
|
|
51
52
|
onEnrolled?: (submissionResponse: SubmissionResponse) => void;
|
|
@@ -61,4 +62,4 @@ export type CustomerEnrollmentProps = {
|
|
|
61
62
|
geolocationRequired?: boolean;
|
|
62
63
|
debugMode?: boolean;
|
|
63
64
|
};
|
|
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;
|
|
65
|
+
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, skipSuccessScreen, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureAdditionalDocuments, captureSignature, captureSignatureVideo, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: CustomerEnrollmentProps) => ReactElement;
|
|
@@ -12,6 +12,7 @@ export type CustomerIdentificationProps = {
|
|
|
12
12
|
webhooksClientTraceId?: string;
|
|
13
13
|
webhooksStripSpecialCharacters?: boolean;
|
|
14
14
|
timeoutDurationMs?: number;
|
|
15
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
15
16
|
onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
|
|
16
17
|
onComplete?: (response: SubmissionResponse) => void;
|
|
17
18
|
onCustomerMatched?: (response: SubmissionResponse) => void;
|
|
@@ -25,4 +26,4 @@ export type CustomerIdentificationProps = {
|
|
|
25
26
|
geolocationRequired?: boolean;
|
|
26
27
|
debugMode?: boolean;
|
|
27
28
|
};
|
|
28
|
-
export declare const CustomerIdentification: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, onCaptureGuidanceTimeout, onExitAfterFailure, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: CustomerIdentificationProps) => ReactElement;
|
|
29
|
+
export declare const CustomerIdentification: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, skipSuccessScreen, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, onCaptureGuidanceTimeout, onExitAfterFailure, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: CustomerIdentificationProps) => ReactElement;
|
|
@@ -13,6 +13,7 @@ export type CustomerVerificationProps = {
|
|
|
13
13
|
webhooksClientTraceId?: string;
|
|
14
14
|
webhooksStripSpecialCharacters?: boolean;
|
|
15
15
|
timeoutDurationMs?: number;
|
|
16
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
16
17
|
assets?: CustomerVerificationAssets;
|
|
17
18
|
colors?: CustomerVerificationColors;
|
|
18
19
|
verbiage?: CustomerVerificationVerbiage;
|
|
@@ -25,4 +26,4 @@ export type CustomerVerificationProps = {
|
|
|
25
26
|
geolocationRequired?: boolean;
|
|
26
27
|
debugMode?: boolean;
|
|
27
28
|
};
|
|
28
|
-
export declare const CustomerVerification: ({ lang, enrollmentId, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, assets, colors, verbiage, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, onExitAfterFailure, geolocationEnabled, geolocationRequired, debugMode, }: CustomerVerificationProps) => ReactElement;
|
|
29
|
+
export declare const CustomerVerification: ({ lang, enrollmentId, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, skipSuccessScreen, assets, colors, verbiage, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, onExitAfterFailure, geolocationEnabled, geolocationRequired, debugMode, }: CustomerVerificationProps) => ReactElement;
|
|
@@ -12,6 +12,7 @@ export type FaceValidationProps = {
|
|
|
12
12
|
webhooksClientTraceId?: string;
|
|
13
13
|
webhooksStripSpecialCharacters?: boolean;
|
|
14
14
|
timeoutDurationMs?: number;
|
|
15
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
15
16
|
onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
|
|
16
17
|
onComplete?: (submissionResponse: SubmissionResponse | null) => void;
|
|
17
18
|
onApproved?: (submissionResponse: SubmissionResponse | null) => void;
|
|
@@ -24,4 +25,4 @@ export type FaceValidationProps = {
|
|
|
24
25
|
geolocationRequired?: boolean;
|
|
25
26
|
debugMode?: boolean;
|
|
26
27
|
};
|
|
27
|
-
export declare const FaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: FaceValidationProps) => ReactElement;
|
|
28
|
+
export declare const FaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, skipSuccessScreen, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: FaceValidationProps) => ReactElement;
|
|
@@ -6,6 +6,7 @@ import { AdditionalDocumentCaptureVerbiage } from '../additional_document_captur
|
|
|
6
6
|
import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
|
|
7
7
|
import { LangOption } from '../../lib/locales';
|
|
8
8
|
import { SignatureCaptureVerbiage } from '../signature_capture/SignatureCapture';
|
|
9
|
+
import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
|
|
9
10
|
export type IdAndFaceValidationAssets = {
|
|
10
11
|
idCapture?: IdCaptureWizardAssets;
|
|
11
12
|
faceLiveness?: FaceLivenessAssets;
|
|
@@ -13,12 +14,14 @@ export type IdAndFaceValidationAssets = {
|
|
|
13
14
|
export type IdAndFaceValidationColors = {
|
|
14
15
|
idCapture?: IdCaptureWizardColors;
|
|
15
16
|
faceLiveness?: FaceLivenessColors;
|
|
17
|
+
videoSignatureCapture?: VideoSignatureColors;
|
|
16
18
|
};
|
|
17
19
|
export type IdAndFaceValidationVerbiage = {
|
|
18
20
|
idCapture?: IdCaptureWizardVerbiage;
|
|
19
21
|
faceLiveness?: FaceLivenessVerbiage;
|
|
20
|
-
signatureCapture?: SignatureCaptureVerbiage;
|
|
21
22
|
additionalDocumentCapture?: AdditionalDocumentCaptureVerbiage;
|
|
23
|
+
signatureCapture?: SignatureCaptureVerbiage;
|
|
24
|
+
videoSignatureCapture?: VideoSignatureVerbiage;
|
|
22
25
|
};
|
|
23
26
|
export type IdAndFaceValidationProps = {
|
|
24
27
|
lang?: LangOption;
|
|
@@ -40,6 +43,7 @@ export type IdAndFaceValidationProps = {
|
|
|
40
43
|
idCardFocusScoreThreshold?: number;
|
|
41
44
|
passportFocusScoreThreshold?: number;
|
|
42
45
|
faceLivenessTimeoutDurationMs?: number;
|
|
46
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
43
47
|
onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
|
|
44
48
|
onComplete?: (submissionResponse: SubmissionResponse) => void;
|
|
45
49
|
onApproved?: (submissionResponse: SubmissionResponse) => void;
|
|
@@ -55,4 +59,4 @@ export type IdAndFaceValidationProps = {
|
|
|
55
59
|
geolocationRequired?: boolean;
|
|
56
60
|
debugMode?: boolean;
|
|
57
61
|
};
|
|
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;
|
|
62
|
+
export declare const IdAndFaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, faceLivenessTimeoutDurationMs, skipSuccessScreen, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, assets, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: IdAndFaceValidationProps) => ReactElement;
|
|
@@ -33,6 +33,7 @@ export type IdValidationProps = {
|
|
|
33
33
|
passportAutoCaptureScoreThreshold?: number;
|
|
34
34
|
idCardFocusScoreThreshold?: number;
|
|
35
35
|
passportFocusScoreThreshold?: number;
|
|
36
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
36
37
|
onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
|
|
37
38
|
onComplete?: (submissionResponse: SubmissionResponse) => void;
|
|
38
39
|
onApproved?: (submissionResponse: SubmissionResponse) => void;
|
|
@@ -47,4 +48,4 @@ export type IdValidationProps = {
|
|
|
47
48
|
geolocationRequired?: boolean;
|
|
48
49
|
debugMode?: boolean;
|
|
49
50
|
};
|
|
50
|
-
export declare const IdValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, onBeforeSubmit, onComplete, onApproved, onDenied, assets, colors, verbiage, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdValidationProps) => ReactElement;
|
|
51
|
+
export declare const IdValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, onBeforeSubmit, onComplete, onApproved, onDenied, assets, colors, verbiage, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdValidationProps) => ReactElement;
|
|
@@ -9,10 +9,11 @@ export type SignatureKYCProps = {
|
|
|
9
9
|
submissionUrl?: string;
|
|
10
10
|
onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
|
|
11
11
|
onComplete?: (submissionResponse: SubmissionResponse) => void;
|
|
12
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
12
13
|
colors?: VideoSignatureColors;
|
|
13
14
|
verbiage?: VideoSignatureVerbiage;
|
|
14
15
|
geolocationEnabled?: boolean;
|
|
15
16
|
geolocationRequired?: boolean;
|
|
16
17
|
debugMode?: boolean;
|
|
17
18
|
};
|
|
18
|
-
export declare const SignatureKYC: ({ submissionToken, submissionEnvironment, submissionUrl, onBeforeSubmit, onComplete, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: SignatureKYCProps) => ReactElement;
|
|
19
|
+
export declare const SignatureKYC: ({ submissionToken, submissionEnvironment, submissionUrl, onBeforeSubmit, onComplete, skipSuccessScreen, colors, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: SignatureKYCProps) => ReactElement;
|
|
@@ -25,9 +25,10 @@ export type CustomerIdentificationWizardProps = {
|
|
|
25
25
|
onExitAfterFailure?: () => void;
|
|
26
26
|
onCaptureGuidanceTimeout?: () => void;
|
|
27
27
|
captureGuidanceTimeoutDurationMs?: number;
|
|
28
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
28
29
|
assets?: CustomerIdentificationAssets;
|
|
29
30
|
colors?: CustomerIdentificationColors;
|
|
30
31
|
verbiage?: CustomerIdentificationVerbiage;
|
|
31
32
|
debugMode?: boolean;
|
|
32
33
|
};
|
|
33
|
-
export declare const CustomerIdentificationWizard: ({ onComplete, onCustomerMatched, onCustomerNotMatched, onExitAfterFailure, onCaptureGuidanceTimeout, captureGuidanceTimeoutDurationMs, assets, colors, verbiage, debugMode, }: CustomerIdentificationWizardProps) => ReactElement;
|
|
34
|
+
export declare const CustomerIdentificationWizard: ({ onComplete, onCustomerMatched, onCustomerNotMatched, onExitAfterFailure, onCaptureGuidanceTimeout, captureGuidanceTimeoutDurationMs, skipSuccessScreen, assets, colors, verbiage, debugMode, }: CustomerIdentificationWizardProps) => ReactElement;
|
|
@@ -27,9 +27,10 @@ export type CustomerVerificationWizardProps = {
|
|
|
27
27
|
onExitAfterFailure?: () => void;
|
|
28
28
|
onCaptureGuidanceTimeout?: () => void;
|
|
29
29
|
captureGuidanceTimeoutDurationMs?: number;
|
|
30
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
30
31
|
assets?: CustomerVerificationAssets;
|
|
31
32
|
colors?: CustomerVerificationColors;
|
|
32
33
|
verbiage?: CustomerVerificationVerbiage;
|
|
33
34
|
debugMode?: boolean;
|
|
34
35
|
};
|
|
35
|
-
export declare const CustomerVerificationWizard: ({ onComplete, onCustomerMatched, onCustomerNotMatched, onExitAfterFailure, onCaptureGuidanceTimeout, captureGuidanceTimeoutDurationMs, assets, colors, verbiage, debugMode, }: CustomerVerificationWizardProps) => ReactElement;
|
|
36
|
+
export declare const CustomerVerificationWizard: ({ onComplete, onCustomerMatched, onCustomerNotMatched, onExitAfterFailure, onCaptureGuidanceTimeout, captureGuidanceTimeoutDurationMs, skipSuccessScreen, assets, colors, verbiage, debugMode, }: CustomerVerificationWizardProps) => ReactElement;
|
|
@@ -25,9 +25,10 @@ export type FaceLivenessWizardProps = {
|
|
|
25
25
|
onExitAfterFailure?: (submissionResponse: SubmissionResponse | null) => void;
|
|
26
26
|
timeoutDurationMs?: number;
|
|
27
27
|
maxRetries?: number;
|
|
28
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
28
29
|
assets?: FaceLivenessAssets;
|
|
29
30
|
colors?: FaceLivenessColors;
|
|
30
31
|
verbiage?: FaceLivenessVerbiage;
|
|
31
32
|
debugMode?: boolean;
|
|
32
33
|
};
|
|
33
|
-
export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitAfterFailure, timeoutDurationMs, maxRetries, assets, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;
|
|
34
|
+
export declare const FaceLivenessWizard: ({ onComplete, onSuccess, onTimeout, onExitAfterFailure, timeoutDurationMs, maxRetries, skipSuccessScreen, assets, colors, verbiage, debugMode, }: FaceLivenessWizardProps) => ReactElement;
|
|
@@ -29,6 +29,11 @@ export type IdCaptureThresholds = {
|
|
|
29
29
|
pdf417?: number;
|
|
30
30
|
focus?: number;
|
|
31
31
|
};
|
|
32
|
+
export declare const PREDICTION_POSITIONS: {
|
|
33
|
+
boxes: number;
|
|
34
|
+
scores: number;
|
|
35
|
+
labels: number;
|
|
36
|
+
};
|
|
32
37
|
export type IdCaptureModelsState = {
|
|
33
38
|
ready: boolean;
|
|
34
39
|
working: MutableRefObject<boolean>;
|
|
@@ -37,9 +37,10 @@ export type IdCaptureWizardProps = {
|
|
|
37
37
|
mrzDetectionScoreThreshold?: number;
|
|
38
38
|
idCardFocusScoreThreshold?: number;
|
|
39
39
|
passportFocusScoreThreshold?: number;
|
|
40
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
40
41
|
assets?: IdCaptureWizardAssets;
|
|
41
42
|
colors?: IdCaptureWizardColors;
|
|
42
43
|
verbiage?: IdCaptureWizardVerbiage;
|
|
43
44
|
debugMode?: boolean;
|
|
44
45
|
};
|
|
45
|
-
export declare const IdCaptureWizard: ({ onSuccess, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, assets, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
|
|
46
|
+
export declare const IdCaptureWizard: ({ onSuccess, autoCaptureEnabled, autoCaptureGoodFramesRequired, autoCaptureBarcodeRequired, barcodeScanningEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, skipSuccessScreen, assets, colors, verbiage, debugMode, }: IdCaptureWizardProps) => ReactElement;
|
|
@@ -20,9 +20,10 @@ export type VideoSignatureWizardProps = {
|
|
|
20
20
|
onComplete?: () => void;
|
|
21
21
|
onVideoCaptured?: (videoData: Blob, signatureData: SignatureData, signatureImageData: string) => void;
|
|
22
22
|
onRetryClicked?: () => void;
|
|
23
|
+
skipSuccessScreen?: boolean | (() => Promise<boolean>);
|
|
23
24
|
assets?: VideoSignatureAssets;
|
|
24
25
|
colors?: VideoSignatureColors;
|
|
25
26
|
verbiage?: VideoSignatureVerbiage;
|
|
26
27
|
debugMode?: boolean;
|
|
27
28
|
};
|
|
28
|
-
export declare const VideoSignatureWizard: ({ onComplete, onVideoCaptured, onRetryClicked, assets, colors, verbiage, debugMode, }: VideoSignatureWizardProps) => ReactElement;
|
|
29
|
+
export declare const VideoSignatureWizard: ({ onComplete, onVideoCaptured, onRetryClicked, skipSuccessScreen, assets, colors, verbiage, debugMode, }: VideoSignatureWizardProps) => ReactElement;
|