@transmitsecurity/platform-web-sdk 1.15.0

package/dist/idv.d.ts

@@ -0,0 +1,68 @@
+/**
+ * The `idv` module allows you to integrate identity verification services into your application. This allows you to
+ * securely verify the identity of your customers using documents like their driver's license or passport.
+ *
+ * After the SDK is initialized, your app can start a verification flow by creating a session in the backend to establish
+ * a secure context and then start the verification session by calling {@link module:tsPlatform.idv.start|start}. The SDK executes
+ * the verification process with the user using the Transmit identity verification experience. Once all the required images are submitted,
+ * Transmit starts processing the verification while the SDK polls for its status. Once processing is completed, the SDK notifies the app
+ * so it can obtain the verification result (via the backend) and proceed accordingly.
+ * @module tsPlatform.idv
+ */
+
+/**
+ * Starts a verification session that was created in the backend (via the [Verification API](/openapi/verify/verifications/#operation/createSession)).
+ * This will start the verification process for the user and guides them through the entire identity verification flow
+ * using the Transmit identity verification experience, which includes capturing the required images and submitting them for processing.
+ * @function start
+ * @param {string} startToken - The start_token returned by the backend when the session was created, used to
+ * bind the session to the device
+ * @returns {Promise<boolean>} Indicates if the session was started successfully
+ * @memberof module:core
+ * @example
+ * const showLoader = true;
+ * const startToken = '123456'; // start_token returned by the backend upon session creation
+ * tsPlatform.idv.start(startToken).then((started) => {
+ *  showLoader = false;
+ *  if (started) {
+ *    console.log('Session started');
+ *  } else {
+ *    console.log('Session not started');
+ *  }
+ * });
+ */
+declare function start(startToken?: string): Promise<boolean>;
+/**
+ * Recaptures the required images in case the `recapture` status is returned. For example, this may occur in case some data
+ * couldn't be extracted due to poor image quality.
+ * @function recapture
+ * @returns {Promise<boolean>} Indicates if the session was started successfully
+ * @memberof module:core
+ * @example
+ * const showLoader = true;
+ * tsPlatform.idv.recapture().then((success) => {
+ *  showLoader = false;
+ *  if (success) {
+ *    console.log('Recapture started');
+ *  } else {
+ *    console.log('Recapture not started');
+ *  }
+ * });
+ */
+declare function recapture(): Promise<boolean>;
+/**
+ * deprecated use {@link module:tsPlatform.idv.recapture|recapture} instead
+ * TODO: [VER-3126](https://transmitsecurity.atlassian.net/browse/VER-3126)
+ */
+declare function restart(): Promise<boolean>;
+declare const version: () => string;
+
+declare const PACKAGE_VERSION: string;
+declare namespace idv {
+  export function initialize(config: any): void;
+  export * from "@transmit-security/ts-identity-verification";
+}
+
+declare function initialize(config: any): void;
+
+export { PACKAGE_VERSION, idv, initialize, recapture, restart, start, version };