Developer portal
POST /admin/tenants
Create a tenant workspace with default billing, policy, and key management settings.
POST /admin/tenantsAuth: admin
Summary
Create a tenant workspace with default billing, policy, and key management settings.
Example
Response
{
"tenantId": "acme-bank-emea",
"name": "Acme Bank - EMEA",
"subscription": {
"tier": "monitor"
}
}Try it live
Paste your tenant API key to call the live API with your credentials. Leave blank to use the public sandbox key when configured, or click “Show example response” for the static fixture below.
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| name | string | Yes | Display name for the tenant organization. e.g. Acme Bank - EMEA |
| tenantId | string | No | Optional stable tenant ID slug; auto-generated if omitted. e.g. acme-bank-emea |
| tier | "free" | "monitor" | "convert" | "enterprise" | No (monitor) | Initial subscription tier. |
Errors
| Code | Meaning | Typical cause | Suggested fix |
|---|---|---|---|
| 404 | Not found | Scan, schedule, share link, or resource id does not exist or expired. | Verify id and tenant scope; share links expire per expiresHours. |
| 422 | Unprocessable entity | Invalid payload shape, unsupported scenario, or infeasible constraints. | Fix field errors in response detail; relax constraints and retry. |
| 429 | Too many requests | Per-key rate limit exceeded (default 300 requests per minute) or public endpoint limit. | Backoff with jitter; cache results; request higher limit for production. |
| 500 | Internal server error | Unexpected backend failure; includes requestId in response. | Retry with exponential backoff; contact support with requestId if persistent. |
See the full errors reference.
Found an issue? Report documentation feedback