Lookup an Embed session

This endpoint allows you to retrieve an existing Embed session using identification details and a product_module_key. The session is retrieved based on the customer's identification type, number, and associated organization information. This supports use cases where an organization needs to look up session details securely using authentication.

Body Params
string
required

The unique key for the product module associated with the session.

string
required

The type of identification, required for authenticated sessions. Must be one of the following: id, email, cellphone, or custom.

string
required

Identification number corresponding to the identification type, validated based on country and type.

string
required

Country code of the identification (ISO Alpha-2). This is required based on the identification type provided.

string

An optional registration number for identification.

string

Optional UUID for the Embed session ID, if known.

Response

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json