Skip to content
UltimateTeam.ai Docs

Provision agent identity

POST
/api/v1/agents/{role}/identity
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/agents/example/identity \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "config": {}, "type": "example" }'

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
role
required
Role

The agent role to provision an identity for

string

The agent role to provision an identity for

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
IdentityProvisionRequest

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
Config
object
key
additional properties
any
type
required
Type
string
/^(email|phone|card)$/
Examplegenerated
{
  "config": {},
  "type": "example"
}

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
IdentityProvisionResponse

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

Attributes: data: The provisioned identity payload.

object
data
required
IdentityProvisionData

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
Agent Role
string
details
required
Details
object
key
additional properties
any
identity_type
required
Identity Type
string
Examplegenerated
{
  "data": {
    "agent_role": "example",
    "details": {},
    "identity_type": "example"
  }
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}