Skip to content

Agent Card

The agent card endpoint returns a formatted identity card for a registered agent. It is designed for platforms and integrations that need to display verified agent information to users.

GET /api/agents/{wayidDid}/card

This endpoint is public and rate-limited.

{
"wayidDid": "wayid:agent:7f3aB9cDe2FgHjKmNpQrSt4U",
"displayName": "Acme Bot",
"username": "acme-bot",
"description": "AI assistant for Acme Corp",
"avatarUrl": "https://way.je/avatars/acme-bot.png",
"status": "active",
"claimedAt": "2026-03-10T16:45:00Z",
"owner": {
"displayName": "Jane Smith",
"username": "janesmith"
},
"verification": {
"provider": "concordium",
"label": "Concordium ID",
"verifiedAt": "2026-02-20T10:30:00Z"
},
"certificateUrl": "https://way.je/agent/wayid:agent:7f3aB9cDe2FgHjKmNpQrSt4U"
}
FieldTypeDescription
wayidDidstringThe agent’s WayID DID
displayNamestringPublic-facing agent name
usernamestringURL-safe handle
descriptionstringWhat the agent does (max 160 chars)
avatarUrlstringAgent profile image URL
statusstring"active", "suspended", or "revoked"
claimedAtstringISO 8601 registration timestamp
ownerobjectOwner’s display name and username
verificationobject or nullIdentity verification details, if verified
certificateUrlstringFull URL to the agent’s public certificate page

Present when the owner has completed identity verification. null otherwise.

FieldTypeDescription
providerstring"concordium" or "mitid"
labelstringHuman-readable provider name (e.g. "Concordium ID")
verifiedAtstringISO 8601 timestamp of verification

The endpoint supports the Accept header for different output formats:

Accept headerFormat
application/json (default)JSON object
text/plainPlain text card
text/htmlHTML snippet with inline CSS

This allows platforms to request the format that best fits their rendering context — JSON for APIs, plain text for chat integrations, and HTML for web embeds.

The /whoareyou skill (and its /who and /way aliases) uses this endpoint to display an agent’s identity card directly in conversation. When a user asks an agent “who are you?”, the agent fetches its own card and formats it as:

🛡️ Acme Bot @acme-bot
AI assistant for Acme Corp
✅ Verified — Concordium ID
Owned by Jane Smith (@janesmith)
View Certificate → https://way.je/agent/wayid:agent:...

Card responses are cached for 60 seconds. Changes to an agent’s profile or verification status may take up to a minute to appear in card responses.