Base URL
All API requests use the following base URL:Authentication
Every request must include an API key in theX-API-Key header:
Tiers
See pricing for current tier names, quotas, and rate-limit numbers. Endpoint availability shown below by paid vs. free; tier names in this table reflect the live pricing page.| Free | Paid | Enterprise | |
|---|---|---|---|
| POST /v1/assess | Yes | Yes | Yes |
| POST /v1/sessions | Yes | Yes | Yes |
| GET /v1/sessions/:token | Yes | Yes | Yes |
| Compliance policy (assess) | Yes | Yes | Yes |
| Custom policies | No | No | Yes |
| GET /v1/reputation | Grade + score | Full response | Full response |
| Support | Community | Email / Slack | Dedicated |
/v1/assess and /v1/sessions identity endpoints are open to all tiers including Free, gated by monthly quota rather than by tier; see pricing for quotas. /v1/reputation is a supplementary on-chain signal: the free tier returns a redacted response (numeric score and grade only); dimensions, confidence, payment activity, and evidence are available on paid plans.
Endpoints
| Method | Path | Description | Min Tier |
|---|---|---|---|
| POST | /v1/assess | Identity assessment with policy evaluation | Free+ |
| POST | /v1/sessions | Create verification session | Free+ |
| GET | /v1/sessions/:token | Poll session status | Free+ |
| POST | /v1/credentials | Create operator credential | Free+ |
| GET | /v1/credentials | List operator credentials | Free+ |
| DELETE | /v1/credentials/{id} | Revoke operator credential | Free+ |
| POST | /v1/credentials/wallets | Report a wallet seen paying under a credential | Free+ |
| GET | /v1/reputation/{address} | Supplementary on-chain reputation signal (redacted for free tier) | Free |
Response format
All responses are JSON. Successful responses return HTTP 200. Errors return the appropriate HTTP status code with anerror object:
Versioning
The API is versioned via the URL path (/v1/). Breaking changes will be introduced under a new version prefix.