idmission-web-sdk 1.0.51 → 1.0.53

package/README.md

@@ -4,6 +4,26 @@ Demo: https://websdk2demo.idmission.com
 
 Storybook: https://websdk2test.idmission.com
 
+## Getting Started
+
+Before using the IDmission WebSDK, you should make sure you can fetch a token. New customers receive their token generation credentials via email. If you haven't received them, reach out to support@idmission.com.
+
+To test that your credentials are valid:
+```bash
+curl --location --request POST 'https://auth.idmission.com/auth/realms/identity/protocol/openid-connect/token' \
+    --header 'Content-Type: application/x-www-form-urlencoded' \
+    --data-urlencode 'grant_type=password' \
+    --data-urlencode 'client_id=' \
+    --data-urlencode 'client_secret=' \
+    --data-urlencode 'username=' \
+    --data-urlencode 'password=' \
+    --data-urlencode 'scope=api_access'
+```
+
+Prior to initializing the WebSDK on the client, you should generate a token on your server using these credentials. Be careful not to leak them on the client side! The generated token is safe to pass to the client, but the secrets used to generate them are not. If you have inadvertently leaked your client secret, react out to support@idmission.com to rotate your credentials.
+
+If you are using NodeJS, check out our [auth client for server-side JavaScript](https://www.npmjs.com/package/idmission-auth-client).
+
 ## Basic Usage in Typescript/React
 
 ```bash
@@ -22,7 +42,7 @@ render(<IdValidation submissionToken={YOUR_TOKEN} />, document.getElementById('r
 
 Add the following script tag to your page's `<head>`:
 ```html
-<script type=“module” src="https://websdk-cdn-dev.idmission.com/websdk/prod/loader.js"></script>
+<script type="module" src="https://websdk-cdn-dev.idmission.com/websdk/prod/loader.js"></script>
 ```
 
 You may subscribe to the `idmission-web-sdk.ready` event to be notified when loading has completed.

package/dist/components/customer_flows/CustomerBiometricsEnrollment.d.ts

@@ -20,31 +20,58 @@ export type CustomerBiometricsEnrollmentVerbiage = {
     videoSignatureCapture?: VideoSignatureVerbiage;
 };
 export interface CustomerBiometricsEnrollmentProps extends PropsWithChildren {
+    /** The unique identifier to match from previously enrolled customers. */
     enrollmentId: string;
+    /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
+    /** A token generated with your IDmission credentials. */
     submissionToken: string;
+    /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** Company identifier to include with submission. */
     companyId?: string;
+    /** Boolean flag indicating whether submissions from the same user should be de-duplicated. */
     deduplicationEnabled?: boolean;
+    /** Boolean flag indicating whether to wait for de-duplication to complete before allowing the user to proceed. */
     deduplicationSynchronous?: boolean;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. */
     webhooksEnabled?: boolean;
+    /** A customer provided trace id to use when invoking customer-configured webhooks. */
     webhooksClientTraceId?: string;
+    /** Boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. */
     webhooksStripSpecialCharacters?: boolean;
+    /** The duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds). */
     timeoutDurationMs?: number;
+    /** 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`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
+    /** Callback function that fires when the user has completed the CustomerBiometricsEnrollment flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Callback function that fires when the user has completed the CustomerBiometricsEnrollment flow successfully. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. */
     onEnrolled?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** 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. */
     onDenied?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. */
     onExitAfterFailure?: () => void;
+    /** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
     captureSignature?: boolean | (() => Promise<boolean>);
+    /** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
+    /** Array of additional documents to be captured. Each element includes a name and description. */
     captureAdditionalDocuments?: AdditionalDocument[];
+    /** Object containing any asset overrides. */
     assets?: CustomerBiometricsEnrollmentAssets;
+    /** Object containing any color overrides. */
     colors?: CustomerBiometricsEnrollmentColors;
+    /** Object containing any verbiage overrides. */
     verbiage?: CustomerBiometricsEnrollmentVerbiage;
+    /** Boolean flag to indicate whether users should be prompted to share their location. Default is `true`. */
     geolocationEnabled?: boolean;
+    /** Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`. */
     geolocationRequired?: boolean;
+    /** Boolean flag to enable on-screen prediction information output. Default is `false`. */
     debugMode?: boolean;
 }
+/** Render a fullscreen capture component that performs FaceValidation, and then stores the results in IDmission's customer database using the supplied `enrollmentId` for later verification or 1:N matching. */
 export declare const CustomerBiometricsEnrollment: FC<CustomerBiometricsEnrollmentProps>;

package/dist/components/customer_flows/CustomerIdAndBiometricsEnrollment.d.ts

@@ -24,42 +24,82 @@ export type CustomerEnrollmentVerbiage = {
     videoSignatureCapture?: VideoSignatureVerbiage;
 };
 export interface CustomerEnrollmentProps extends PropsWithChildren {
+    /** The unique identifier to match from previously enrolled customers. */
     enrollmentId: string;
+    /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
+    /** A token generated with your IDmission credentials. */
     submissionToken: string;
+    /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** Company identifier to include with submission. */
     companyId?: string;
+    /** Boolean flag to indicate whether responses should always be reviewed by a human. */
     manualReviewRequired?: boolean;
+    /** Boolean flag to indicate whether the back of the ID card image will be considered in processing decisions. Default is `true`. */
     idBackImageRequired?: boolean;
+    /** Boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc. */
     verifyIdWithExternalDatabases?: boolean;
+    /** Object of personal data to store with the submitted ID. Valid keys: `uniqueNumber`, `name`, `phone`, `phoneCountryCode`, `email`, `dob`, `gender`, `addressLine1`, `addressLine2`, `city`, `district`, `postalCode`, `country`. */
     personalData?: PersonalData;
+    /** Object of credit/debit card data to store with the submitted ID. Valid keys: `cardToken`, `cardLast4`, `cardExpDate`, `nameOnCard`. */
     cardData?: CardData;
+    /** Boolean flag indicating whether submissions from the same user should be de-duplicated. */
     deduplicationEnabled?: boolean;
+    /** Boolean flag indicating whether to wait for de-duplication to complete before allowing the user to proceed. */
     deduplicationSynchronous?: boolean;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. */
     webhooksEnabled?: boolean;
+    /** A customer provided trace id to use when invoking customer-configured webhooks. */
     webhooksClientTraceId?: string;
+    /** Boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. */
     webhooksStripSpecialCharacters?: boolean;
+    /** Boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`. */
     idAutoCaptureEnabled?: boolean;
+    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8. */
     idCardAutoCaptureScoreThreshold?: number;
+    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for Machine Readable Zones. Defaults to 0.5. */
     mrzDetectionScoreThreshold?: number;
+    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. */
     passportAutoCaptureScoreThreshold?: number;
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. */
     idCardFocusScoreThreshold?: number;
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. */
     passportFocusScoreThreshold?: number;
+    /** The duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds). */
     faceLivenessTimeoutDurationMs?: number;
+    /** 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`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
+    /** Callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow successfully. The SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check. */
     onEnrolled?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** 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. */
     onDenied?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. */
     onExitAfterFailure?: () => void;
+    /** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
     captureSignature?: boolean | (() => Promise<boolean>);
+    /** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
+    /** Array of additional documents to be captured. Each element includes a name and description. */
     captureAdditionalDocuments?: AdditionalDocument[];
+    /** Object containing any asset overrides. */
     assets?: CustomerEnrollmentAssets;
+    /** Object containing any color overrides. */
     colors?: CustomerEnrollmentColors;
+    /** Object containing any verbiage overrides. */
     verbiage?: CustomerEnrollmentVerbiage;
+    /** Boolean flag to indicate whether users should be prompted to share their location. Default is `true`. */
     geolocationEnabled?: boolean;
+    /** Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`. */
     geolocationRequired?: boolean;
+    /** Boolean flag to enable on-screen prediction information output. Default is `false`. */
     debugMode?: boolean;
 }
+/**
+ * Render a fullscreen capture component that performs IDValidation and FaceValidation sequentially, and then stores the results in IDmission's customer database using the supplied `enrollmentId` for later verification or 1:N matching.
+ */
 export declare const CustomerIdAndBiometricsEnrollment: FC<CustomerEnrollmentProps>;

package/dist/components/customer_flows/CustomerIdentification.d.ts

@@ -3,26 +3,51 @@ import { SubmissionRequest, SubmissionResponse } from '../../contexts/Submission
 import { CustomerIdentificationAssets, CustomerIdentificationColors, CustomerIdentificationVerbiage } from '../customer_identification/CustomerIdentificationWizard';
 import { LangOption } from '../../lib/locales';
 export interface CustomerIdentificationProps extends PropsWithChildren {
+    /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
+    /** A token generated with your IDmission credentials. */
     submissionToken: string;
+    /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** Company identifier to include with submission. */
     companyId?: string;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. */
     webhooksEnabled?: boolean;
+    /** A customer provided trace id to use when invoking customer-configured webhooks. */
     webhooksClientTraceId?: string;
+    /** Boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. */
     webhooksStripSpecialCharacters?: boolean;
+    /** The duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds). */
     timeoutDurationMs?: number;
+    /** 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`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
+    /** Callback function that fires when the user has completed the CustomerIdentification flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** 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. */
     onCustomerMatched?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** 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. */
     onCustomerNotMatched?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** */
+    /** Callback function that fires when the user fails the realness check by exceeding the time allotted. */
     onCaptureGuidanceTimeout?: () => void;
+    /** Callback function that fires when the user clicks the exit button after failing the realness check. */
     onExitAfterFailure?: () => void;
+    /** Object containing any asset overrides. */
     assets?: CustomerIdentificationAssets;
+    /** Object containing any color overrides. */
     colors?: CustomerIdentificationColors;
+    /** Object containing any verbiage overrides. */
     verbiage?: CustomerIdentificationVerbiage;
+    /** Boolean flag to indicate whether users should be prompted to share their location. Default is `true`. */
     geolocationEnabled?: boolean;
+    /** Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`. */
     geolocationRequired?: boolean;
+    /** Boolean flag to enable on-screen prediction information output. Default is `false`. */
     debugMode?: boolean;
 }
+/**
+ * Render a fullscreen capture component that analyzes frames from the user's front-facing camera to determine whether the user matches any previously registered customer in IDmission's customer database.
+ * */
 export declare const CustomerIdentification: FC<CustomerIdentificationProps>;

package/dist/components/customer_flows/CustomerVerification.d.ts

@@ -3,26 +3,50 @@ import { SubmissionRequest, SubmissionResponse } from '../../contexts/Submission
 import { LangOption } from '../../lib/locales';
 import { CustomerVerificationAssets, CustomerVerificationColors, CustomerVerificationVerbiage } from '../customer_verification/CustomerVerificationWizard';
 export interface CustomerVerificationProps extends PropsWithChildren {
+    /** The unique identifier to match from previously enrolled customers. */
     enrollmentId: string;
+    /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
+    /** A token generated with your IDmission credentials. */
     submissionToken: string;
+    /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** Company identifier to include with submission. */
     companyId?: string;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. */
     webhooksEnabled?: boolean;
+    /** A customer provided trace id to use when invoking customer-configured webhooks. */
     webhooksClientTraceId?: string;
+    /** Boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. */
     webhooksStripSpecialCharacters?: boolean;
+    /** The duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds). */
     timeoutDurationMs?: number;
+    /** 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`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Object containing any asset overrides. */
     assets?: CustomerVerificationAssets;
+    /** Object containing any color overrides. */
     colors?: CustomerVerificationColors;
+    /** Object containing any verbiage overrides. */
     verbiage?: CustomerVerificationVerbiage;
+    /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
+    /** Callback function that fires when the user has completed the CustomerVerification flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Callback function that fires when the user has completed the CustomerVerification flow and matches 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. */
     onCustomerMatched?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** 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. */
     onCustomerNotMatched?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Callback function that fires when the user clicks the exit button after failing the realness check. */
     onExitAfterFailure?: () => void;
+    /** Boolean flag to indicate whether users should be prompted to share their location. Default is `true`. */
     geolocationEnabled?: boolean;
+    /** Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`. */
     geolocationRequired?: boolean;
+    /** Boolean flag to enable on-screen prediction information output. Default is `false`. */
     debugMode?: boolean;
 }
+/**
+ * Render a fullscreen capture component that analyzes frames from the user's front-facing camera to determine whether the user matches a specified `enrollmentId` that they have previously registered in IDmission's customer database.
+ */
 export declare const CustomerVerification: FC<CustomerVerificationProps>;

package/dist/components/customer_flows/FaceValidation.d.ts

@@ -3,25 +3,46 @@ import { LivenessCheckRequest, SubmissionResponse } from '../../contexts/Submiss
 import { FaceLivenessAssets, FaceLivenessColors, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { LangOption } from '../../lib/locales';
 export interface FaceValidationProps extends PropsWithChildren {
+    /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
+    /** A token generated with your IDmission credentials. */
     submissionToken: string;
+    /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** Company identifier to include with submission. */
     companyId?: string;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. */
     webhooksEnabled?: boolean;
+    /** A customer provided trace id to use when invoking customer-configured webhooks. */
     webhooksClientTraceId?: string;
+    /** Boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. */
     webhooksStripSpecialCharacters?: boolean;
+    /** The duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds). */
     timeoutDurationMs?: number;
+    /** 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`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Callback function that fires immediately prior to liveness check, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The liveness check request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeSubmit?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
+    /** Callback function that fires when the user has completed the FaceValidation flow, regardless of whether they are approved or denied. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
+    /** Callback function that fires when the user completes the FaceValidation flow and passes the realness check. Arguments: same as onComplete. */
     onApproved?: (resp: SubmissionResponse, req: LivenessCheckRequest) => void;
+    /** Callback function that fires when the user completes the FaceValidation flow and fails the realness check. Arguments: same as onComplete. */
     onDenied?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
+    /** Callback function that fires when the user clicks the exit button after completing the FaceValidation flow and failing the realness check. */
     onExitAfterFailure?: () => void;
+    /** Object containing any asset overrides. */
     assets?: FaceLivenessAssets;
+    /** Object containing any color overrides. */
     colors?: FaceLivenessColors;
+    /** Object containing any verbiage overrides. */
     verbiage?: FaceLivenessVerbiage;
+    /** Boolean flag to indicate whether users should be prompted to share their location. Default is `true`. */
     geolocationEnabled?: boolean;
+    /** Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`. */
     geolocationRequired?: boolean;
+    /** Boolean flag to enable on-screen prediction information output. Default is `false`. */
     debugMode?: boolean;
 }
+/** Render a fullscreen capture component that analyzes frames from the user's front-facing camera to determine whether a live human face is present. */
 export declare const FaceValidation: FC<FaceValidationProps>;

package/dist/components/customer_flows/IdAndFaceValidation.d.ts

@@ -24,40 +24,78 @@ export type IdAndFaceValidationVerbiage = {
     videoSignatureCapture?: VideoSignatureVerbiage;
 };
 export interface IdAndFaceValidationProps extends PropsWithChildren {
+    /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
+    /** A token generated with your IDmission credentials. */
     submissionToken: string;
+    /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** Company identifier to include with submission. */
     companyId?: string;
+    /** Boolean flag to indicate whether responses should always be reviewed by a human. */
     manualReviewRequired?: boolean;
+    /** Boolean flag to indicate whether the back of the ID card image will be considered in processing decisions. Default is `true`. */
     idBackImageRequired?: boolean;
+    /** Boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc. */
     verifyIdWithExternalDatabases?: boolean;
+    /** Object of personal data to store with the submitted ID. Valid keys: `uniqueNumber`, `name`, `phone`, `phoneCountryCode`, `email`, `dob`, `gender`, `addressLine1`, `addressLine2`, `city`, `district`, `postalCode`, `country`. */
     personalData?: PersonalData;
+    /** Object of credit/debit card data to store with the submitted ID. Valid keys: `cardToken`, `cardLast4`, `cardExpDate`, `nameOnCard`. */
     cardData?: CardData;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. */
     webhooksEnabled?: boolean;
+    /** A customer provided trace id to use when invoking customer-configured webhooks. */
     webhooksClientTraceId?: string;
+    /** Boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. */
     webhooksStripSpecialCharacters?: boolean;
+    /** Boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`. */
     idAutoCaptureEnabled?: boolean;
+    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8. */
     idCardAutoCaptureScoreThreshold?: number;
+    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for Machine Readable Zones. Defaults to 0.5. */
     mrzDetectionScoreThreshold?: number;
+    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. */
     passportAutoCaptureScoreThreshold?: number;
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. */
     idCardFocusScoreThreshold?: number;
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. */
     passportFocusScoreThreshold?: number;
+    /** The duration of time in milliseconds that the user may try to pass the realness check. Defaults to `15000` (15 seconds). */
     faceLivenessTimeoutDurationMs?: number;
+    /** 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`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Callback function that fires immediately prior to liveness check, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The liveness check request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeLivenessCheck?: (req: LivenessCheckRequest) => Promise<LivenessCheckRequest>;
+    /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
+    /** Callback function that fires when the user has completed both flows. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Callback function that fires when the user completes both flows with a valid ID and passes the realness check. Arguments: same as `onComplete`. */
     onApproved?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Callback function that fires when the user completes both flows with an invalid ID or fails the realness check. Arguments: same as `onComplete`. */
     onDenied?: (resp: SubmissionResponse | null, req: SubmissionRequest | LivenessCheckRequest | null) => void;
+    /** Callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. */
     onExitAfterFailure?: () => void;
+    /** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
     captureSignature?: boolean | (() => Promise<boolean>);
+    /** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
+    /** Array of additional documents to be captured. Each element includes a name and description. */
     captureAdditionalDocuments?: AdditionalDocument[];
+    /** Object containing any asset overrides. */
     assets?: IdAndFaceValidationAssets;
+    /** Object containing any color overrides. */
     colors?: IdAndFaceValidationColors;
+    /** Object containing any verbiage overrides. */
     verbiage?: IdAndFaceValidationVerbiage;
+    /** Boolean flag to indicate whether users should be prompted to share their location. Default is `true`. */
     geolocationEnabled?: boolean;
+    /** Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`. */
     geolocationRequired?: boolean;
+    /** Boolean flag to enable on-screen prediction information output. Default is `false`. */
     debugMode?: boolean;
 }
+/**
+ * Render a fullscreen capture component that performs `IDValidation` and `FaceValidation` sequentially.
+ * */
 export declare const IdAndFaceValidation: FC<IdAndFaceValidationProps>;

package/dist/components/customer_flows/IdValidation.d.ts

@@ -16,36 +16,70 @@ export type IdValidationVerbiage = IdCaptureWizardVerbiage & {
     videoSignatureCapture?: VideoSignatureVerbiage;
 };
 export interface IdValidationProps extends PropsWithChildren {
+    /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
+    /** A token generated with your IDmission credentials. */
     submissionToken: string;
+    /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** Company identifier to include with submission. */
     companyId?: string;
+    /** Boolean flag to indicate whether responses should always be reviewed by a human. */
     manualReviewRequired?: boolean;
+    /** Boolean flag to indicate whether the back of the ID card image will be considered in processing decisions. Default is `true`. */
     idBackImageRequired?: boolean;
+    /** Boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc. */
     verifyIdWithExternalDatabases?: boolean;
+    /** Object of personal data to store with the submitted ID. Valid keys: `uniqueNumber`, `name`, `phone`, `phoneCountryCode`, `email`, `dob`, `gender`, `addressLine1`, `addressLine2`, `city`, `district`, `postalCode`, `country`. */
     personalData?: PersonalData;
+    /** Object of credit/debit card data to store with the submitted ID. Valid keys: `cardToken`, `cardLast4`, `cardExpDate`, `nameOnCard`. */
     cardData?: CardData;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. */
     webhooksEnabled?: boolean;
+    /** A customer provided trace id to use when invoking customer-configured webhooks. */
     webhooksClientTraceId?: string;
+    /** Boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. */
     webhooksStripSpecialCharacters?: boolean;
+    /** Boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`. */
     idAutoCaptureEnabled?: boolean;
+    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for ID cards. Defaults to 0.8. */
     idCardAutoCaptureScoreThreshold?: number;
+    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for passports. Defaults to 0.75. */
     passportAutoCaptureScoreThreshold?: number;
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for ID cards. */
     idCardFocusScoreThreshold?: number;
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for passports. */
     passportFocusScoreThreshold?: number;
+    /** 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`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
+    /** Callback function that fires when the user completes the IDValidation flow. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Callback function that fires when the user completes the IDValidation flow with a valid ID. Arguments: same as `onComplete`. */
     onApproved?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Callback function that fires when the user completes the IDValidation flow with an invalid ID. Arguments: same as `onComplete`. */
     onDenied?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Boolean or async function indicating whether the user should be prompted to sign the screen before submission. Defaults to `false`. */
     captureSignature?: boolean | (() => Promise<boolean>);
+    /** Boolean or async function indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to `false`. */
     captureSignatureVideo?: boolean | (() => Promise<boolean>);
+    /** Array of additional documents to be captured. Each element includes a name and description. */
     captureAdditionalDocuments?: AdditionalDocument[];
+    /** Object containing any asset overrides. */
     assets?: IdValidationAssets;
+    /** Object containing any color overrides. */
     colors?: IdValidationColors;
+    /** Object containing any verbiage overrides. */
     verbiage?: IdValidationVerbiage;
+    /** Boolean flag to indicate whether users should be prompted to share their location. Default is `true`. */
     geolocationEnabled?: boolean;
+    /** Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`. */
     geolocationRequired?: boolean;
+    /** Boolean flag to enable on-screen prediction information output. Default is `false`. */
     debugMode?: boolean;
 }
+/**
+ * Render a fullscreen ID capture component that instructs the user to photograph both sides of their ID card, or full page of their passport.
+ */
 export declare const IdValidation: FC<IdValidationProps>;

package/dist/components/customer_flows/SignatureKYC.d.ts

@@ -3,16 +3,28 @@ import { LangOption } from '../../lib/locales';
 import { SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { VideoSignatureColors, VideoSignatureVerbiage } from '../video_signature_capture/VideoSignatureWizard';
 export interface SignatureKYCProps extends PropsWithChildren {
+    /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
+    /** A token generated with your IDmission credentials. */
     submissionToken: string;
+    /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
+    /** 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. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** 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`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Object containing any color overrides. */
     colors?: VideoSignatureColors;
+    /** Object containing any verbiage overrides. */
     verbiage?: VideoSignatureVerbiage;
+    /** Boolean flag to indicate whether users should be prompted to share their location. Default is `true`. */
     geolocationEnabled?: boolean;
+    /** Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`. */
     geolocationRequired?: boolean;
+    /** Boolean flag to enable on-screen prediction information output. Default is `false`. */
     debugMode?: boolean;
 }
+/** Render a fullscreen capture component that captures a video of the user signing the screen. */
 export declare const SignatureKYC: FC<SignatureKYCProps>;

package/dist/components/customer_flows/VideoIdValidation.d.ts

@@ -8,35 +8,68 @@ export type VideoIdValidationAssets = VideoIdWizardAssets;
 export type VideoIdValidationColors = VideoIdWizardColors;
 export type VideoIdValidationVerbiage = VideoIdWizardVerbiage;
 export interface VideoIdValidationProps extends PropsWithChildren {
+    /** Language code to use. Supported values: 'auto' (detect based on user's OS), 'en' (English), 'es' (Spanish). Defaults to auto. */
     lang?: LangOption;
+    /** A token generated with your IDmission credentials. */
     submissionToken: string;
+    /** URL to hit with all API requests. Defaults to the value specified in your decoded `submissionToken`. */
     submissionUrl?: string;
+    /** Company identifier to include with submission. */
     companyId?: string;
+    /** Boolean flag to indicate whether responses should always be reviewed by a human. */
     manualReviewRequired?: boolean;
+    /** Boolean flag to indicate whether the back of the ID card image will be considered in processing decisions. Default is `true`. */
     idBackImageRequired?: boolean;
+    /** Boolean flag to indicate whether ID data should be verified with government databases such as AAMVA, watch lists, etc. */
     verifyIdWithExternalDatabases?: boolean;
+    /** Object of personal data to store with the submitted ID. Valid keys: `uniqueNumber`, `name`, `phone`, `phoneCountryCode`, `email`, `dob`, `gender`, `addressLine1`, `addressLine2`, `city`, `district`, `postalCode`, `country`. */
     personalData?: PersonalData;
+    /** Object of credit/debit card data to store with the submitted ID. Valid keys: `cardToken`, `cardLast4`, `cardExpDate`, `nameOnCard`. */
     cardData?: CardData;
+    /** Boolean flag to indicate whether customer-configured webhooks should be invoked after submission. */
     webhooksEnabled?: boolean;
+    /** A customer provided trace id to use when invoking customer-configured webhooks. */
     webhooksClientTraceId?: string;
+    /** Boolean flag to indicate whether non-alphanumeric characters should be removed from the submission data when customer-configured webhooks are invoked. */
     webhooksStripSpecialCharacters?: boolean;
+    /** Callback function that fires immediately prior to submission, giving the client application an opportunity to specify custom asynchronous logic that mutates the request before it executes. The submission request is passed in as a parameter and a promise resolving to the updated request should be returned. */
     onBeforeSubmit?: (req: SubmissionRequest) => Promise<SubmissionRequest>;
+    /** Callback function that fires when the user has completed all flows. Arguments: the SubmissionResponse from IDmission's API is passed as an argument to the customer's application for further handling, which indicates whether the user passed the validation check, and the request payload dispatched to IDmission's API, which contains the images submitted by the user. */
     onComplete?: (resp: SubmissionResponse, req: SubmissionRequest) => void;
+    /** Callback function that fires when the user clicks the exit button after completing the IDValidation flow and failing the realness check. */
     onExitAfterFailure?: (resp: SubmissionResponse | null, req: LivenessCheckRequest | null) => void;
+    /** Object containing any overrides for IDValidation. */
     idCaptureProps?: IdCaptureWizardProps;
+    /** Object containing any overrides for FaceLiveness. */
     faceLivenessProps?: FaceLivenessWizardProps;
+    /** Number between 0 and 1 at which document detection guidance score condition is considered to be met for the ID card front during video capture. */
     idCardFrontDetectionThreshold?: number;
+    /** Number between 0 and 1 at which focus guidance score condition is considered to be met for the ID card front during video capture. */
     idCardFrontFocusThreshold?: number;
+    /** Number of good frames of the ID card front that must be captured before moving on during video capture. */
     goodIdCardFrontFramesThreshold?: number;
+    /** The duration of time in milliseconds that the user is instructed to show the back of their ID card during video capture. */
     showIdCardBackDurationMs?: number;
+    /** An optional text prompt to display on screen for the user to read during video capture after the ID card has been shown. */
     readTextPrompt?: CustomerSuppliedVerbiage;
+    /** The duration of time in milliseconds that the user is allowed to spend reading the `readTextPrompt`. */
     readTextTimeoutDurationMs?: number;
+    /** 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`. */
     skipSuccessScreen?: boolean | (() => Promise<boolean>);
+    /** Object containing any asset overrides. */
     assets?: VideoIdValidationAssets;
+    /** Object containing any color overrides. */
     colors?: VideoIdValidationColors;
+    /** Object containing any verbiage overrides. */
     verbiage?: VideoIdValidationVerbiage;
+    /** Boolean flag to indicate whether users should be prompted to share their location. Default is `true`. */
     geolocationEnabled?: boolean;
+    /** Boolean flag to indicate whether users should be blocked from proceeding if they block location access. Default is `false`. */
     geolocationRequired?: boolean;
+    /** Boolean flag to enable on-screen prediction information output. Default is `false`. */
     debugMode?: boolean;
 }
+/**
+ * Render a fullscreen capture component that performs IDValidation and FaceValidation sequentially, then captures a video of the user holding their ID, and optionally speaking a prompt aloud.
+ * */
 export declare const VideoIdValidation: FC<VideoIdValidationProps>;