Start User Live Selfie Capture

In the backend, invoke the Create New Operation Endpoint with the following request body (example):

{  
  "AccountNumber": "AccountV2",  
  "Codeword": "",  
  "Name": "GetForeignBiometry",  
  "Timeout": 3600,  
  "TransportType": 0,  
  "Tag": ""  
} 

The AccountNumber must match the value specified by the user during Account Creation

A TransportType of 0 returns an OperationId and OneTimeSecret.

Example Response Body:

{  
   "OperationId": "113e838b-be34-53e9-c52f-3cc45b2d10ce",
   "OneTimeSecret": "TbAeETwpOxbvKy7rWCeOcQ=="  
}

Display the User Interface

Save these values from the response and use them to display the Capture Experience to the user.

Alternative TransportType parameter usage options are detailed in the Out-of-band Transactions section.

Wait for the Completion of the Capture

Once the user completes the selfie capture, the status changes from 0 (Pending) to 1 (Accepted). For more details, refer to the Transaction Statuses section.

📘

Common Transaction Status

Transaction Statuses are consistent across Enrollment, Capture and Authentication workflows.

The application has several ways to detect when the status changes.

• Periodically polling the backend for Enrollment operation status changes using the Operation Status Endpoint
• Embedded Integrations can listen to Web Component events for web integration or JavaScript bridge events for WebView integration. The UI emits a signal when the user reaches the "final page" of the experience.

Please refer to the Web Component Events section for more details.

The most effective strategy for balancing UX transition speed and system load is to:

• Listen to events emitted by the Web Component or WebView.
• When the user reaches the final page, transmit the signal from your application's frontend to its backend.
• Verify the status change through the backend Operation Status Endpoint.
• As a backup, poll status changes periodically using Operation Status Endpoint, for example, once every 5 seconds.

Both Out-of-band and Embedded integrations can use Webhook to receive notifications when the status changes. Note that webhooks are not queued and do not have guaranteed delivery, so the periodic polling backup strategy still applies.