Skip to main content
POST
Create an identity transfer token

Authorizations

Authorization
string
header
required

This API uses OAuth2 tokens.

Body

application/json
bearer_type
enum<string>
required

The authorization token type.

  • agent — use with an OAuth2 Agent Bearer Token.
  • customer — use with an OAuth2 Bearer Token.
Available options:
agent,
customer
client_id
string<hex>
required

The client ID for which the token is being issued.

customer_id
string<uuid>

The customer ID for which the identity transfer token is being issued. The customer must already exist. Required only if bearer_type=agent.

code_challenge
string

A code challenge, as in the OAuth2 PKCE flow.

Response

OK: returns identity transfer token details.

Identity transfer token

identity_transfer_token
string

The identity transfer token value.

expires_in
integer<uint64>

The identity transfer token lifetime, in seconds.