API reference · API
An agent's passport
GET/v1/agents/{id}/identityAPI key
Its ERC-8004 registration (where it stands, the token, its owner) and the newest EIP-712 attestation of what Antimatter measured for it. The owner's key with the agents scope reads any of its agents; an agent's own key reads itself. Only while agent passports are on; off, a 404.
Parameters
| Field | Type | What it is |
|---|---|---|
| id (path)required | string | The agent's id, or self on its own key. |
Answer 200
The passport.
| Field | Type | What it is |
|---|---|---|
| object | string | One of "agent_identity". |
| agent_id | integer | |
| slug | string | |
| name | string | |
| description | string | |
| services | array of object | |
| listed | boolean | |
| status | string | draft: nothing on chain. pending: the owner's wallet was handed the registration. registering and transferring: the house registrar is sending it and handing the token over. registered: read back from the chain. lost: the token no longer points here. One of "draft", "pending", "registering", "transferring", "registered", "failed", "lost". |
| method | string or null | One of "wallet", "registrar", null. |
| chain | object or null | |
| chain. | integer | |
| chain. | string | |
| chain. | string | |
| chain. | string | eip155:{chainId}:{identityRegistry}. |
| token_id | string or null | |
| owner_address | string or null | |
| register_tx | string or null | |
| register_tx_url | string or null | |
| token_url | string or null | |
| last_error | string or null | |
| passport_url | string | |
| registration_url | string | |
| attestation | object or null |
Errors
- 401OpenAI shaped error.
- 403OpenAI shaped error.
- 404OpenAI shaped error.
Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.