Provision agent identity

POST

/api/v1/agents/{role}/identity

• Production
• Local development

Provision an email address, phone number, or virtual card for an agent.

Authorizations

• ApiKeyAuth

Parameters

Path Parameters

role

required

The agent role to provision an identity for

string

The agent role to provision an identity for

Request Body ^required

Request body for POST /agents/{role}/identity.

Attributes: type: The identity type to provision (email, phone, or card). config: Optional provider-specific configuration (e.g. domain, area_code, spending_limit).

object

config

object

key

additional properties

any

type

required

string

/^(email|phone|card)$/

Responses

201

Successful Response

Wrapper response for POST /agents/{role}/identity.

Attributes: data: The provisioned identity payload.

object

data

required

Provisioned identity details returned after a successful provision request.

Attributes: agent_role: The agent role for which identity was provisioned. identity_type: The type of identity provisioned (email, phone, or card). details: Provider-specific details (address, number, last_four, etc.).

object

agent_role

required

string

details

required

object

key

additional properties

any

identity_type

required

string

422

Validation Error

object

detail

Array<object>

object

ctx

object

input

loc

required

Array

msg

required

string

type

required

string