idmission-web-sdk 2.0.4 → 2.0.5

package/README.md

@@ -84,7 +84,7 @@ Render a fullscreen ID capture component that instructs the user to photograph b
 <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>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
-<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
+<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured, for available options consult the Additional Document Properties table below.</td></tr>
 <tr><td><code>loadingOverlayMode</code> (optional)</td><td>string indicating which ID capture loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</td></tr>
 <tr><td><code>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</td></tr>
 <tr><td><code>idAutoCaptureEnabled</code> (optional)</td><td>boolean to indicate whether photos should be captured automatically when guidance conditions are met. Default is `true`.</td></tr>
@@ -364,7 +364,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>onCameraAccessDenied</code> (optional)</td><td>callback function that fires when camera access is denied or lost.</td></tr>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
-<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
+<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured, for available options consult the Additional Document Properties table below.</td></tr>
 <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>
 <tr><td><code>precapturedDocuments</code> (optional)</td><td>object to allow documents that have been previously captured to be submitted. Valid keys: idCardFront, idCardBack, passport.</td></tr>
 <tr><td><code>idCaptureLoadingOverlayMode</code> (optional)</td><td>string indicating which ID capture loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</td></tr>
@@ -452,7 +452,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <tr><td><code>onCameraAccessDenied</code> (optional)</td><td>callback function that fires when camera access is denied or lost.</td></tr>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
-<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
+<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured, for available options consult the Additional Document Properties table below.</td></tr>
 <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>
 <tr><td><code>idCaptureLoadingOverlayMode</code> (optional)</td><td>string indicating which ID capture loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</td></tr>
 <tr><td><code>idCaptureRequirement</code> (optional)</td><td>string to indicate which types of documents should be captured. Valid values: idCard, passport, idCardOrPassport, idCardAndPassport. Default is idCardOrPassport.</td></tr>
@@ -538,7 +538,7 @@ Render a fullscreen capture component that performs FaceValidation, and then sto
 <tr><td><code>onCameraAccessDenied</code> (optional)</td><td>callback function that fires when camera access is denied or lost.</td></tr>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
-<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
+<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured, for available options consult the Additional Document Properties table below.</td></tr>
 <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>
 <tr><td><code>loadingOverlayMode</code> (optional)</td><td>string indicating which loading overlay screen should be used. Supported values: default and legacy. Defaults to default.</td></tr>
 <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>
@@ -764,7 +764,7 @@ Render a fullscreen capture component that performs IDValidation and FaceValidat
 <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>
 <tr><td><code>captureSignature</code> (optional)</td><td>boolean indicating whether the user should be prompted to sign the screen before submission. Defaults to false.</td></tr>
 <tr><td><code>captureSignatureVideo</code> (optional)</td><td>boolean indicating whether the user should be prompted to record themselves signing the screen before submission. Defaults to false.</td></tr>
-<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured. Each element includes a name and description.</td></tr>
+<tr><td><code>captureAdditionalDocuments</code> (optional)</td><td>array of additional documents to be captured, for available options consult the Additional Document Properties table below.</td></tr>
 <tr><td><code>companyId</code> (optional)</td><td>company identifier to include with submission.</td></tr>
 <tr><td><code>needImmediateResponse</code> (optional)</td><td>boolean to indicate if validation of the minimum resolution for an ID document image should be triggered. Defaults to true.</td></tr>
 <tr><td><code>manualReviewRequired</code> (optional)</td><td>boolean flag to indicate whether responses should always be reviewed by a human. Defaults to false.</td></tr>
@@ -942,4 +942,25 @@ verbiage: {
 
 Leaving a locale out of your translation object will result in the default text being shown for that locale, with the rest of your provided translations being honored. This functionality can be leveraged to define translations for languages that the IDmission Web SDK does not yet support. If you end up creating full translations for new languages, feel free to send your translations our way at https://www.idmission.com/company/contact-us/, and we will try to get them added to the main SDK translation set!
 
-The full list of i18n locales can be found here: https://github.com/ladjs/i18n-locales.
+The full list of i18n locales can be found here: https://github.com/ladjs/i18n-locales.
+
+### Specifying additional documents to be captured
+
+Many customer flow documented above include a `captureAdditionalDocuments` property, which allows for an array of documents to be specified in the order that they will be captured in.
+
+**Additional Document Properties**
+
+<table>
+<tr>
+<td><code>name</code></td><td>string indicating the name of document to be captured</td>
+</tr>
+<tr>
+<td><code>description</code> (optional)</td><td>string describing to the user anything extra about the document that they should know</td>
+</tr>
+<tr>
+<td><code>skip</code> (optional)</td><td>async function that may return a boolean indicating whether this document should be skipped</td>
+</tr>
+<tr>
+<td><code>processAsPOA</code> (optional)</td><td>boolean indicating whether the document should be treated as a proof of address -- when true, the document will be processed and validated on the server.</td>
+</tr>
+</table>

package/dist/sdk2.cjs.development.js

@@ -49,7 +49,7 @@ var LanguageDetector__default = /*#__PURE__*/_interopDefaultLegacy(LanguageDetec
 var i18n__default = /*#__PURE__*/_interopDefaultLegacy(i18n);
 var SignatureCanvas__default = /*#__PURE__*/_interopDefaultLegacy(SignatureCanvas);
 
-var webSdkVersion = '2.0.4';
+var webSdkVersion = '2.0.5';
 
 function getPlatform() {
   // eslint-disable-next-line @typescript-eslint/ban-ts-comment