ENTITY developer reference
Use an API collection
Candidate documentation for reading and synthetic examples. Account creation, live API access, SDKs, collections and MCP are not available here. A released service profile and matching integration instructions are required before use.
Availability
An executable API collection is not available from these pages. Its format, supported importer, release binding and authenticated behaviour must be qualified before a download is offered. The candidate API reference describes operations; it is not a released collection or callable service.
Before importing a released collection
Use the collection distributed with the accepted release. A historical draft importing successfully is not evidence of compatibility. Match its binding to the capabilities result and keep environment values local, separating test from production. Never export an environment containing a token or secret with the collection.
Inspect each request before execution. The collection must contain only the released public data surface and reachable schemas; private account, staff, operator and funding-purchase interfaces are not public integration operations.
Make one deliberate request
Record one logical-operation key, its original creation time, unchanged input and your explicit maximum units. Check the selected profile and the actual environment’s authentication instructions. The Entity-Service-Profile header carries the accepted profile_id; the endpoint pins its separate immutable revision.
Inspect the response, business outcome, evidence and usage receipt before proceeding. HTTP success alone does not establish that a company was identified. The first-request guide and result guide provide synthetic reading examples.
Recover an uncertain request
If delivery times out, retain the original key, creation time and request. Follow the typed recovery instruction through the original operation’s compatible contract. A collection script must not replace the key on retry. Restoring authentication does not prove that prior work had no effect.
Running a folder or collection can invoke multiple operations. Review their aggregate authority and usage before doing so; importing or viewing a collection does not authorise those calls.
Cases the released collection must support
The same release semantics must cover a successful result, ambiguity or insufficient evidence, a denied call, safe recovery after lost acknowledgement, and the usage receipt. Confirm exact wire strings and conditional fields rather than coercing data for a client importer.
Next: check compatibility and binding or read error recovery.
Downloads and offline inspection
Check release-material availability and inspect the original offline bundle verifiers. TypeScript, Python and Elixir source downloads are candidate examples with checks pending. They do not provide a released bundle, executable collection, authenticated starter or permission to make requests.