idmission-web-sdk 0.0.21 → 0.0.23

package/README.md

@@ -270,7 +270,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <table>
 <tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
 <tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
-<tr><td><code>enrollmentId</code></td><td>the unique identifier to use for the customer to be enrolled.</td></tr>
+<tr><td><code>enrollmentId</code></td><td>the unique identifier to use for the customer to be enrolled. Overrides <code>personalData.uniqueNumber</code> if both are specified.</td></tr>
 <tr><td><code>onBeforeSubmit</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onComplete</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow. 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>
 <tr><td><code>onEnrolled</code> (optional)</td><td>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.</td></tr>
@@ -323,7 +323,7 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
 <table>
 <tr><td><code>submissionToken</code></td><td>a token generated with your IDmission credentials.</td></tr>
 <tr><td><code>submissionUrl</code></td><td>URL to hit with all API requests. Default: https://api.idmission.com</td></tr>
-<tr><td><code>enrollmentId</code></td><td>the unique identifier to use for the customer to be enrolled.</td></tr>
+<tr><td><code>enrollmentId</code></td><td>the unique identifier to use for the customer to be enrolled. Overrides <code>personalData.uniqueNumber</code> if both are specified.</td></tr>
 <tr><td><code>onBeforeSubmit</code> (optional)</td><td>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.</td></tr>
 <tr><td><code>onComplete</code> (optional)</td><td>callback function that fires when the user has completed the CustomerIdAndBiometricsEnrollment flow. 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>
 <tr><td><code>onEnrolled</code> (optional)</td><td>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.</td></tr>

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

@@ -12,6 +12,12 @@ export type CustomerBiometricsEnrollmentProps = {
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
+    companyId?: string;
+    deduplicationEnabled?: boolean;
+    deduplicationSynchronous?: boolean;
+    webhooksEnabled?: boolean;
+    webhooksClientTraceId?: string;
+    webhooksStripSpecialCharacters?: boolean;
     timeoutDurationMs?: number;
     assets?: FaceLivenessAssets;
     verbiage?: CustomerBiometricsEnrollmentVerbiage;
@@ -27,4 +33,4 @@ export type CustomerBiometricsEnrollmentProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const CustomerBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, timeoutDurationMs, assets, verbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerBiometricsEnrollmentProps) => ReactElement;
+export declare const CustomerBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, companyId, deduplicationEnabled, deduplicationSynchronous, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, assets, verbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerBiometricsEnrollmentProps) => ReactElement;

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

@@ -1,5 +1,5 @@
 import { ReactElement } from 'react';
-import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { IdCaptureAssets } from '../id_capture/IdCaptureWizard';
 import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
@@ -11,6 +11,16 @@ export type CustomerEnrollmentProps = {
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
+    companyId?: string;
+    manualReviewRequired?: boolean;
+    verifyIdWithExternalDatabases?: boolean;
+    personalData?: PersonalData;
+    cardData?: CardData;
+    deduplicationEnabled?: boolean;
+    deduplicationSynchronous?: boolean;
+    webhooksEnabled?: boolean;
+    webhooksClientTraceId?: string;
+    webhooksStripSpecialCharacters?: boolean;
     idAutoCaptureEnabled?: boolean;
     idCardAutoCaptureScoreThreshold?: number;
     mrzDetectionScoreThreshold?: number;
@@ -34,4 +44,4 @@ export type CustomerEnrollmentProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const CustomerIdAndBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerEnrollmentProps) => ReactElement;
+export declare const CustomerIdAndBiometricsEnrollment: ({ enrollmentId, lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, deduplicationEnabled, deduplicationSynchronous, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onEnrolled, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: CustomerEnrollmentProps) => ReactElement;

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

@@ -7,6 +7,10 @@ export type CustomerIdentificationProps = {
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
+    companyId?: string;
+    webhooksEnabled?: boolean;
+    webhooksClientTraceId?: string;
+    webhooksStripSpecialCharacters?: boolean;
     timeoutDurationMs?: number;
     onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
     onComplete?: (response: SubmissionResponse) => void;
@@ -20,4 +24,4 @@ export type CustomerIdentificationProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const CustomerIdentification: ({ lang, submissionToken, submissionEnvironment, submissionUrl, timeoutDurationMs, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, onCaptureGuidanceTimeout, onExitAfterFailure, assets, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: CustomerIdentificationProps) => ReactElement;
+export declare const CustomerIdentification: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, onCaptureGuidanceTimeout, onExitAfterFailure, assets, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: CustomerIdentificationProps) => ReactElement;

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

@@ -8,6 +8,10 @@ export type CustomerVerificationProps = {
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
+    companyId?: string;
+    webhooksEnabled?: boolean;
+    webhooksClientTraceId?: string;
+    webhooksStripSpecialCharacters?: boolean;
     timeoutDurationMs?: number;
     assets?: CustomerVerificationAssets;
     verbiage?: CustomerVerificationVerbiage;
@@ -20,4 +24,4 @@ export type CustomerVerificationProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const CustomerVerification: ({ lang, enrollmentId, submissionToken, submissionEnvironment, submissionUrl, timeoutDurationMs, assets, verbiage, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, onExitAfterFailure, geolocationEnabled, geolocationRequired, debugMode, }: CustomerVerificationProps) => ReactElement;
+export declare const CustomerVerification: ({ lang, enrollmentId, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, assets, verbiage, onBeforeSubmit, onComplete, onCustomerMatched, onCustomerNotMatched, onExitAfterFailure, geolocationEnabled, geolocationRequired, debugMode, }: CustomerVerificationProps) => ReactElement;

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

@@ -7,6 +7,10 @@ export type FaceValidationProps = {
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
+    companyId?: string;
+    webhooksEnabled?: boolean;
+    webhooksClientTraceId?: string;
+    webhooksStripSpecialCharacters?: boolean;
     timeoutDurationMs?: number;
     onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
     onComplete?: (submissionResponse: SubmissionResponse | null) => void;
@@ -19,4 +23,4 @@ export type FaceValidationProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const FaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, timeoutDurationMs, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, assets, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: FaceValidationProps) => ReactElement;
+export declare const FaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, timeoutDurationMs, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, assets, verbiage, geolocationEnabled, geolocationRequired, debugMode, }: FaceValidationProps) => ReactElement;

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

@@ -1,5 +1,5 @@
 import { ReactElement } from 'react';
-import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { FaceLivenessAssets, FaceLivenessVerbiage } from '../face_liveness/FaceLivenessWizard';
 import { IdCaptureAssets } from '../id_capture/IdCaptureWizard';
 import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
@@ -10,6 +10,14 @@ export type IdAndFaceValidationProps = {
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
+    companyId?: string;
+    manualReviewRequired?: boolean;
+    verifyIdWithExternalDatabases?: boolean;
+    personalData?: PersonalData;
+    cardData?: CardData;
+    webhooksEnabled?: boolean;
+    webhooksClientTraceId?: string;
+    webhooksStripSpecialCharacters?: boolean;
     idAutoCaptureEnabled?: boolean;
     idCardAutoCaptureScoreThreshold?: number;
     mrzDetectionScoreThreshold?: number;
@@ -33,4 +41,4 @@ export type IdAndFaceValidationProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const IdAndFaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdAndFaceValidationProps) => ReactElement;
+export declare const IdAndFaceValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, companyId, manualReviewRequired, verifyIdWithExternalDatabases, personalData, cardData, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, mrzDetectionScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, idCaptureAssets, idCaptureVerbiage, faceLivenessTimeoutDurationMs, faceLivenessAssets, faceLivenessVerbiage, onBeforeSubmit, onComplete, onApproved, onDenied, onExitAfterFailure, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdAndFaceValidationProps) => ReactElement;

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

@@ -1,5 +1,5 @@
 import { ReactElement } from 'react';
-import { SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, PersonalData, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 import { IdCaptureAssets, IdCaptureVerbiage } from '../id_capture/IdCaptureWizard';
 import { NamespacedAdditionalDocumentsVerbiage } from '../additional_document_capture/AdditionalDocumentCaptureWizard';
 import { AdditionalDocument } from '../additional_document_capture/AdditionalDocumentCapture';
@@ -11,6 +11,14 @@ export type IdValidationProps = {
     submissionToken: string;
     submissionEnvironment?: SubmissionEnvironment;
     submissionUrl?: string;
+    companyId?: string;
+    manualReviewRequired?: boolean;
+    verifyIdWithExternalDatabases?: boolean;
+    personalData?: PersonalData;
+    cardData?: CardData;
+    webhooksEnabled?: boolean;
+    webhooksClientTraceId?: string;
+    webhooksStripSpecialCharacters?: boolean;
     idAutoCaptureEnabled?: boolean;
     idCardAutoCaptureScoreThreshold?: number;
     passportAutoCaptureScoreThreshold?: number;
@@ -29,4 +37,4 @@ export type IdValidationProps = {
     geolocationRequired?: boolean;
     debugMode?: boolean;
 };
-export declare const IdValidation: ({ lang, submissionToken, submissionEnvironment, submissionUrl, idAutoCaptureEnabled, idCardAutoCaptureScoreThreshold, passportAutoCaptureScoreThreshold, idCardFocusScoreThreshold, passportFocusScoreThreshold, onBeforeSubmit, onComplete, onApproved, onDenied, assets, verbiage, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdValidationProps) => ReactElement;
+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, verbiage, captureSignature, captureSignatureVideo, captureAdditionalDocuments, geolocationEnabled, geolocationRequired, debugMode, }: IdValidationProps) => ReactElement;

package/dist/components/submission/SubmissionProvider.d.ts

@@ -1,16 +1,26 @@
 import { ReactElement } from 'react';
-import { SubmissionAction, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
+import { CardData, PersonalData, SubmissionAction, SubmissionEnvironment, SubmissionRequest, SubmissionResponse } from '../../contexts/SubmissionContext';
 export type SubmissionProviderProps = {
     action: SubmissionAction;
     children: ReactElement;
     token: string;
     url?: string;
     environment?: SubmissionEnvironment;
+    companyId?: string;
     enrollmentId?: string;
+    personalData?: PersonalData;
+    cardData?: CardData;
+    manualReviewRequired?: boolean;
+    verifyIdWithExternalDatabases?: boolean;
+    deduplicationEnabled?: boolean;
+    deduplicationSynchronous?: boolean;
     geolocationEnabled?: boolean;
     geolocationRequired?: boolean;
+    webhooksEnabled?: boolean;
+    webhooksClientTraceId?: string;
+    webhooksStripSpecialCharacters?: boolean;
     onBeforeSubmit?: (request: SubmissionRequest) => Promise<SubmissionRequest>;
     onResponseReceived?: (response: SubmissionResponse) => void;
     onRequestFailure?: (err: Error) => void;
 };
-export declare const SubmissionProvider: ({ action, children, url, environment, token, enrollmentId, geolocationEnabled, geolocationRequired, onBeforeSubmit, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;
+export declare const SubmissionProvider: ({ action, children, url, environment, token, companyId, enrollmentId, personalData, cardData, manualReviewRequired, verifyIdWithExternalDatabases, deduplicationEnabled, deduplicationSynchronous, geolocationEnabled, geolocationRequired, webhooksEnabled, webhooksClientTraceId, webhooksStripSpecialCharacters, onBeforeSubmit, onResponseReceived, onRequestFailure, }: SubmissionProviderProps) => ReactElement;

package/dist/contexts/SubmissionContext.d.ts

@@ -33,9 +33,8 @@ export type SubmissionRequest = {
             idCountry: 'NSP';
             idState: '';
         };
-        personalData?: {
-            uniqueNumber?: string;
-        };
+        personalData?: PersonalData;
+        cardData?: CardData;
         biometricData?: {
             selfie?: string;
         };
@@ -49,6 +48,7 @@ export type SubmissionRequest = {
     };
     additionalData: {
         uniqueRequestId: string;
+        clientTraceId?: string;
         manualReviewRequired: 'Y' | 'N';
         bypassAgeValidation: 'Y' | 'N';
         deDuplicationRequired: 'Y' | 'N';
@@ -65,7 +65,7 @@ export type SubmissionRequest = {
         metadata?: string;
     };
     employee?: {
-        companyId?: number;
+        companyId?: string;
     };
 };
 export type CaptureAttemptMetadata = {
@@ -73,6 +73,27 @@ export type CaptureAttemptMetadata = {
     captureTime: number;
     operationTime?: number;
 };
+export type PersonalData = {
+    uniqueNumber?: string;
+    name?: string;
+    phone?: string;
+    phoneCountryCode?: string;
+    email?: string;
+    dob?: string;
+    gender?: 'M' | 'F';
+    addressLine1?: string;
+    addressLine2?: string;
+    city?: string;
+    district?: string;
+    postalCode?: string;
+    country?: string;
+};
+export type CardData = {
+    cardToken?: string;
+    cardLast4?: string;
+    cardExpDate?: string;
+    nameOnCard?: string;
+};
 export type SubmissionMetadata = {
     selfie: CaptureAttemptMetadata[];
     back: CaptureAttemptMetadata[];