Authorization error codes
Every public API error code emitted by Authorization, with its HTTP status, its type and a page per code.
Error codes emitted by Authorization. Each code links to its own page with the cause and the action to take.
| Code | Type | HTTP | Description |
|---|---|---|---|
addon_not_active | authorization_error | 403 | The functionality belongs to an add-on that is not active for the company right now. |
feature_not_available_in_plan | authorization_error | 403 | The feature is not included in the company plan. |
forbidden_action | authorization_error | 403 | The action is blocked for this resource even though the scope is right: the resource belongs to a shared catalogue, or the change travels through a different endpoint. |
insufficient_scope | authorization_error | 403 | The key authenticates correctly but does not carry the scope this operation requires. Scopes are granted when the key is issued and are not widened at call time. |
max_api_keys_exceeded | authorization_error | 422 | The company reached the number of API keys its plan allows. |
max_webhook_endpoints_exceeded | authorization_error | 422 | The company reached the number of webhook endpoints its add-on tier allows. |
module_not_available_in_sandbox | authorization_error | 403 | The resource belongs to a module vetoed in test mode. Sandbox never touches AEAT, banks or real billing, so those modules stay out on purpose. |
portfolio_max_api_keys_exceeded | authorization_error | 422 | The portfolio already holds the maximum number of ACTIVE credentials. The cap is counted over the managing company and its active children together, not per company, so onboarding another child to mint its credential will not let you create this one either. |
scope_not_allowed_by_plan | authorization_error | 422 | One of the requested scopes belongs to a module that the plan does not include, so the key would be born with a permission that could never be exercised. |
scope_not_allowed_in_sandbox | authorization_error | 422 | A test key cannot be born with scopes of modules vetoed in sandbox. |
Related
Error codes by category
Find an error by the category that emits it.
Full reference table
All codes, HTTP statuses, types and descriptions in one reference.
Error model
Interpret the error envelope and handle errors by code.