Skip to main content

Start a new Face Match session

POST 
/face-match/start

Start a New Face Match Session​

This endpoint starts a new Face Match session by sending a reference image to the server, which initializes the session and returns a session ID.
The session is used to perform liveness-verified comparisons between the provided reference image and the live probe images captured during the process.

Request Body Details​

The request requires a base64-encoded image representing the verified or real photo of the person.
Optionally, you can include a customerId to associate the session with an internal customer record.
This allows the API to return the customerId in the response, making it easier to track who the Face Match session belongs to in your system.

Example Flow​

  1. Initiate Session: Send the base64-encoded reference image (and optionally customerId) to the startFacematchSession endpoint.
  2. Response: The server returns a session ID that can be used to compose the URL to the Face Match client interface, where the user will perform the live comparison.
  3. Liveness Verification: During the Face Match process, probe images will be captured dynamically to ensure that the user is physically present and not using static or spoofed images.
  4. Session Usage: The same session ID can be used to track the status, retrieve results, or confirm completion once the matching and liveness checks are done.
  5. Credits: No credits are deducted upon initiating the session. Credits are deducted only when the session is processed.

Additional Information​

  • The referenceImage serves as the baseline for all live comparisons performed during the session.
  • Each probe image collected in the session is automatically checked for liveness to prevent spoofing.
  • You can use the session ID to generate the Face Match client URL, which initiates the user-facing verification flow.
  • Once the session is completed, results can be retrieved using the Get Face Match Result endpoint.

Request​

Responses​