Skip to main content
GET
Get an identity by external ID

Authorizations

Authorization
string
header
required

Bearer authentication using the project Secret Key (prefixed with sk_, or test_sk_ for sandbox). All v4 public endpoints require the Secret Key — see Authentication. Never expose the Secret Key in client-side code.

Path Parameters

identity_id
string
required

The external identity identifier.

Maximum string length: 255
Pattern: ^[a-zA-Z0-9._-]+$

Response

The identity object.

object
enum<string>
required
Available options:
identity
id
string
required

External identity identifier.

Example:

"ext-user-123"

url
string
required

Canonical API path.

Example:

"/v4/identities/ext-user-123"

user_id
string
required

Qonversion user identifier linked to this identity.

Example:

"QON_3af4c5b8a4d24f21b72e9d0c8aef9d4e"