Build with the record
API overview
Read directory results, entity records, and hosted agent registration files.
Start with a public read
The current public read routes are served by entity.id. They expose application data, not a normalized verification verdict. Use server-side requests for JSON routes whose cross-origin access has not been established for your origin.
Endpoints
GET /api/entities — search or browse directory records.
GET /api/entity-direct — read a record by its nodehash, with optional network selection.
GET /agent.json — retrieve a hosted ERC-8004 registration file from an agent domain.
Authentication
These three GET handlers do not require a user API key. Signed-in app workflows are separate and use the app’s session and authorization checks. Do not reuse browser cookies as a service integration or expose a Payload service key to a browser.
Compatibility and limits
These are existing, unversioned application routes. Expect optional fields and differences between record types. No public request quota, webhook contract, or service-level guarantee is specified in this reference. Discuss production integration requirements with the team.
Verify API and Registrar SDK
For a supported verification or registrar integration, contact Entity.ID to agree on access and the contract. This reference does not define a Bearer-key /v1/verify endpoint or a public @entityid/sdk package.
Handle failures
Check the HTTP status and content type before parsing JSON. Use bounded timeouts and retries for transient failures, preserve network context, and treat unavailable data as unknown. See Errors and integration practices.