Skip to main content
GET
Get Agent Identity

Overview

Returns the agent’s identity: the display fields a recipient sees, the generated contact card, the numbers bound to the agent, and the delivery toggles. An agent that has never been given an identity gets one on first read, seeded with the agent’s name as display_name and the remaining fields empty. Signed URLs in the response are short lived, about an hour. Read the identity again for fresh ones rather than storing them.

Headers

string
required
Your API key for authentication.

Path Parameters

string
required
The agent’s unique identifier.

Response

string
Unique identifier for the identity record. Distinct from the agent ID.
string
The organization that owns the agent.
string
The agent the identity belongs to.
string
The name shown to the recipient. Seeded from the agent’s name on first read.
string
Short line describing the agent. Empty string when unset.
string
Contact email on the card. Empty string when unset.
string
Website on the card. Empty string when unset.
string
Postal address on the card. Empty string when unset.
string | null
ID of the stored logo, or null when no logo has been uploaded.
string | null
ID of the generated contact card file. Rebuilt whenever a card field changes, so this value moves after an update.
boolean
Whether the contact card is delivered automatically. Defaults to false.
boolean
Whether rich messaging is allowed for this agent. Defaults to true.
boolean
Whether verified caller display is switched on for this agent.
string
Registration state of the verified caller display: not_submitted, submitted, pending_review, approved, or rejected.
object | null
The stored registration payload, or null when nothing has been submitted.
string[]
The agent’s bound numbers in E.164, as returned by Get Agent Inbound Numbers. Empty when no number is attached.
string | null
Short-lived signed URL for the logo, or null when there is no logo.
string | null
Short-lived signed URL for the contact card file, or null when none exists.
string
ISO 8601 timestamp of when the identity was created.
string
ISO 8601 timestamp of the last change.
null | array
null on success, or a list of error objects if the request failed.

Docs for agents: llms.txt