@transmitsecurity/platform-web-sdk 2.3.0 → 2.3.2-beta-26093939905.0

package/dist/ido.d.ts

@@ -804,7 +804,98 @@ declare enum IdoJourneyActionType {
      * On failure, the `IdoServiceResponse` {@link IdoServiceResponse.errorData} field will contain
      * relevant error codes that can be used to handle various failure scenarios.
      */
-    MobileApproveAuthentication = "transmit_platform_mobile_approve_authentication"
+    MobileApproveAuthentication = "transmit_platform_mobile_approve_authentication",
+    /**
+     * @description `journeyStepId` for a selfie acquisition action.
+     * This action instructs the client to acquire a selfie image from the user, typically as part of an identity verification or face authentication process.
+     *
+     * Data received in the {@link IdoServiceResponse} object:
+     * ```json
+     * {
+     *   "data": {
+     *     "start_token": "<START_TOKEN>",         // Optional: used to start an identity verification session if required
+     *     "acquisition_id": "<ACQUISITION_ID>"   // Required: ID needed to start selfie capture
+     *   }
+     * }
+     * ```
+     *
+     * To perform the selfie acquisition:
+     * 1. If a `start_token` is present, initialize the IDV SDK session:
+     *    ```javascript
+     *    if (response.data.start_token !== undefined) {
+     *      await idv.start(response.data.start_token);
+     *    }
+     *    ```
+     * 2. Run the selfie acquisition by calling the IDV SDK's `captureSelfie()` method:
+     *    ```javascript
+     *    await idv.captureSelfie({ acquisitionId: response.data.acquisition_id });
+     *    ```
+     *
+     * After acquiring the selfie, the client response does not need to include any data:
+     * ```javascript
+     * ido.submitClientResponse(ClientResponseOptionType.ClientInput);
+     * ```
+     *
+     * If an error occurs while capturing the selfie, the client should handle error states and inform the user
+     * and/or retry as appropriate according to application requirements.
+     *
+     * For deeper understanding and more implementation details, refer to the IDV SDK documentation:
+     * {@link https://developer.transmitsecurity.com/sdk-ref/idvsdk/overview IDV SDK Reference}
+     */
+    SelfieAcquisition = "transmit_platform_selfie_acquisition",
+    /**
+     * @description `journeyStepId` for a document acquisition action.
+     * This action instructs the client to acquire a document image from the user, typically as part of an identity verification or face authentication process.
+     *
+     * Data received in the {@link IdoServiceResponse} object:
+     * ```json
+     * {
+     *   "data": {
+     *     "start_token": "<START_TOKEN>",         // Optional: used to start an identity verification session if required
+     *     "acquisition_id": "<ACQUISITION_ID>"   // Required: ID needed to start document capture
+     *   }
+     * }
+     * ```
+     *
+     * To perform the document acquisition:
+     * 1. If a `start_token` is present, initialize the IDV SDK session:
+     *    ```javascript
+     *    if (response.data.start_token !== undefined) {
+     *      await idv.start(response.data.start_token);
+     *    }
+     *    ```
+     * 2. Run the document acquisition by calling the IDV SDK's `captureDocument()` method:
+     *    ```javascript
+     *    await idv.captureDocument({ acquisitionId: response.data.acquisition_id });
+     *    ```
+     *
+     * After acquiring the document, the client response does not need to include any data:
+     * ```javascript
+     * ido.submitClientResponse(ClientResponseOptionType.ClientInput);
+     * ```
+     *
+     * If an error occurs while capturing the document, the client should handle error states and inform the user
+     * and/or retry as appropriate according to application requirements.
+     *
+     * For deeper understanding and more implementation details, refer to the IDV SDK documentation:
+     * {@link https://developer.transmitsecurity.com/sdk-ref/idvsdk/overview IDV SDK Reference}
+     */
+    DocumentAcquisition = "transmit_platform_document_acquisition",
+    /**
+     * @description `journeyStepId` for IDV recommendation action.
+     *
+     * When this action is received, it indicates that identity verification (IDV) processing is being performed asynchronously on the backend.
+     * The client is responsible for implementing a polling mechanism: keep calling
+     * `ido.submitClientResponse(ClientResponseOptionType.ClientInput)` in a loop until the server responds with a new action or returns an error.
+     *
+     * Note: No data is provided by the server in the {@link IdoServiceResponse} object for this action at any time.
+     *
+     * It is recommended to show a blocking UI element (such as a loader or progress indicator) while polling,
+     * to inform the user that processing is ongoing.
+     *
+     * This process can take a couple of seconds. The recommended polling interval is every 1 second.
+     */
+    WaitForIdvRecommendations = "transmit_platform_idv_recommendation"
 }
 /**
  * @interface