Erros públicos da API
Falhas HTTP usam o envelope aditivo abaixo. Guarde o trace_id para suporte; o campo reason é reservado ao resultado de verificações de domínio.
{
"error": "machine_readable_name",
"code": "STABLE_UPPERCASE_CODE",
"message": "Actionable public message.",
"trace_id": "..."
}| HTTP | Código | Ação |
|---|---|---|
| 400 | INVALID_JSON | Request body must be valid JSON. |
| 400 | INVALID_PAYLOAD | Request payload does not match the endpoint contract. |
| 400 | INVALID_EVIDENCE_PACK | Provide an Evidence Pack object with a proofs array. |
| 400 | INVALID_REQUEST | Review the request fields and retry. |
| 400 | INVALID_METADATA | Regulatory metadata is invalid; review the reported validation details. |
| 400 | INVALID_HASH | Provide a valid SHA-256 hash. |
| 400 | INVALID_IDEMPOTENCY_KEY | Idempotency-Key must contain 8 to 128 allowed characters. |
| 400 | VERIFICATION_FAILED | The supplied evidence could not be verified. |
| 400 | REGULATORY_METADATA_REQUIRED | Provide metadata.regulatory when binding a regulatory risk context. |
| 400 | RISK_CONTEXT_REFERENCE_REQUIRED | Provide both aiUseCaseId and riskClassificationId. |
| 400 | AI_INVENTORY_REFERENCE_REQUIRED | Provide aiSystemId and deploymentEnvironment for inventory binding. |
| 400 | AI_INVENTORY_CONTENT_EVIDENCE_BINDING_HASH_INVALID | Use a valid sha256: inventory binding hash in content evidence. |
| 400 | AI_INVENTORY_CONTENT_EVIDENCE_TRANSITION_REASON_INVALID | Use a supported inventory binding transition reason. |
| 400 | SYNTHETIC_CONTENT_CERTAINTY_CLAIM_UNSUPPORTED | Remove unsupported independent certainty claims. |
| 400 | SYNTHETIC_CONTENT_STATUS_REQUIRED | Provide syntheticContentStatus. |
| 400 | SYNTHETIC_CONTENT_CREDENTIAL_REFERENCE_REQUIRED | Provide contentCredentialReferenceHash for a content-credential declaration. |
| 400 | SYNTHETIC_CONTENT_DECLARATION_INVALID | Review the synthetic content declaration validation details. |
| 400 | CONTENT_MARKING_INDEPENDENT_VERIFICATION_CLAIM_UNSUPPORTED | Remove unsupported independent marking-verification claims. |
| 400 | CONTENT_MARKING_RECORD_INVALID | Review the content marking validation details. |
| 400 | DISCLOSURE_EVIDENCE_ARTIFACT_INVALID | Review the disclosure evidence artifact validation details. |
| 400 | DISCLOSURE_SIGNING_BINDING_INVALID | Review the disclosure signing binding validation details. |
| 401 | UNAUTHORIZED | Authentication credentials are missing or invalid. |
| 401 | API_KEY_REQUIRED | Provide an AuthenChain API key. |
| 401 | INVALID_API_KEY | Provide a valid AuthenChain API key. |
| 401 | KEY_REVOKED | Replace the revoked API key before retrying. |
| 401 | KEY_EXPIRED | Replace or renew the expired API key before retrying. |
| 402 | BILLING_INACTIVE | Restore the organization billing status before retrying. |
| 402 | SUBSCRIPTION_REQUIRED | Activate a subscription for this organization. |
| 403 | FORBIDDEN | The API key does not have the required scope. |
| 403 | ACCESS_DENIED | The user or organization has not been approved for API access. |
| 403 | SCOPE_REQUIRED | Grant the API key every scope listed in requiredScopes. |
| 403 | RISK_CONTEXT_SCOPE_REQUIRED | Grant provenance.sign:with-risk-context to the API key. |
| 403 | AI_INVENTORY_SCOPE_REQUIRED | Grant ai_inventory:bind to the API key. |
| 403 | DISCLOSURE_BIND_SCOPE_REQUIRED | Grant disclosure:bind to the API key. |
| 403 | INVALID_KEY_OWNERSHIP | Use a provenance public key owned by this organization. |
| 403 | REVOKED_KEY | Use an active, non-revoked provenance public key. |
| 404 | NOT_FOUND | The requested resource was not found. |
| 404 | RISK_CLASSIFICATION_NOT_FOUND | Create or select a risk classification for this tenant and use case. |
| 404 | AI_USE_CASE_NOT_FOUND | Create or select an AI use case owned by this tenant. |
| 404 | IMPACT_ASSESSMENT_USE_CASE_REQUIRED | Provide aiUseCaseId to evaluate the impact-assessment gate. |
| 404 | IMPACT_ASSESSMENT_STORE_UNAVAILABLE | Impact-assessment records are temporarily unavailable; retry later. |
| 404 | IMPACT_ASSESSMENT_REQUIRED | Complete and approve an AI Impact Assessment before production signing. |
| 404 | AI_INVENTORY_SYSTEM_NOT_FOUND | Use an AI inventory system owned by this tenant. |
| 404 | AI_INVENTORY_DEPLOYMENT_NOT_FOUND | Use a deployment registered for this system and environment. |
| 404 | AI_INVENTORY_MODEL_VERSION_NOT_FOUND | Use a model version registered for this AI system. |
| 409 | ORG_REQUIRED | Associate the API key with an organization. |
| 409 | IDEMPOTENCY_KEY_REUSED_WITH_DIFFERENT_REQUEST | The key was already used with a different payload. |
| 409 | IDEMPOTENCY_PREVIOUS_REQUEST_FAILED | The prior request associated with this key failed. |
| 409 | IDEMPOTENCY_REQUEST_IN_PROGRESS | A request using this key is still in progress. |
| 409 | IDEMPOTENCY_REPLAY_UNAVAILABLE | The prior result can no longer be replayed. |
| 409 | AI_USE_CASE_ARCHIVED | Select an active AI use case. |
| 409 | RISK_CLASSIFICATION_BLOCKED | Resolve the blocked risk classification before signing. |
| 409 | PROHIBITED_RISK_CONTEXT_BLOCKED | Provide an approved prohibited-risk exception reference. |
| 409 | RISK_CLASSIFICATION_STALE | Reclassify the use case against the active risk policy. |
| 409 | IMPACT_ASSESSMENT_GATE_BLOCKED | Resolve the impact-assessment gate findings before signing. |
| 409 | IMPACT_ASSESSMENT_EXPIRED | Renew and approve the expired AI Impact Assessment. |
| 409 | IMPACT_ASSESSMENT_STALE | Review and approve a current AI Impact Assessment. |
| 409 | IMPACT_ASSESSMENT_NOT_APPROVED | Approve the AI Impact Assessment before production signing. |
| 409 | IMPACT_ASSESSMENT_CONDITIONS_NOT_ACKNOWLEDGED | Acknowledge the current approval conditions. |
| 409 | IMPACT_ASSESSMENT_REFERENCE_MISMATCH | Use the assessment references and hashes bound to the current risk context. |
| 409 | IMPACT_ASSESSMENT_MITIGATION_BLOCKED | Resolve blocking or overdue mitigations. |
| 409 | IMPACT_ASSESSMENT_POLICY_BLOCKED | Resolve the impact-assessment policy findings. |
| 409 | REGULATORY_METADATA_REQUIRED_FOR_IMPACT_ASSESSMENT | Provide metadata.regulatory to bind the approved impact assessment. |
| 409 | AI_INVENTORY_SYSTEM_RETIRED | Select an active, non-retired AI system. |
| 409 | AI_INVENTORY_SYSTEM_NOT_ACTIVE | Activate the AI system before signing. |
| 409 | AI_INVENTORY_SYSTEM_HASH_MISSING | Generate the current AI system version hash. |
| 409 | AI_INVENTORY_DEPLOYMENT_ENVIRONMENT_MISMATCH | Use a deployment from the requested environment. |
| 409 | AI_INVENTORY_DEPLOYMENT_SUSPENDED | Reactivate or replace the suspended deployment. |
| 409 | AI_INVENTORY_DEPLOYMENT_RETIRED | Select a current deployment. |
| 409 | AI_INVENTORY_DEPLOYMENT_NOT_ACTIVE | Activate the production deployment before signing. |
| 409 | AI_INVENTORY_MODEL_VERSION_MISMATCH | Use the model version assigned to the deployment. |
| 409 | AI_INVENTORY_MODEL_HASH_MISMATCH | Use the registered model version hash. |
| 409 | AI_INVENTORY_DEPLOYMENT_MODEL_HASH_MISMATCH | Reconcile the deployment and model-version hashes. |
| 409 | AI_INVENTORY_MODEL_VERSION_NOT_ACTIVE | Activate the model version or record an approved exception. |
| 409 | AI_INVENTORY_ALLOWED_PURPOSE_MISMATCH | Use the allowed purpose assigned to the deployment. |
| 409 | ALLOWED_PURPOSE_REQUIRED | Assign an allowed purpose to the production deployment. |
| 409 | ALLOWED_PURPOSE_NOT_FOUND | Select an allowed purpose active for this AI system. |
| 409 | ALLOWED_PURPOSE_INACTIVE | Activate or replace the allowed purpose. |
| 409 | AI_INVENTORY_POLICY_BINDING_MISMATCH | Use the policy binding assigned to the deployment. |
| 409 | AI_INVENTORY_POLICY_REFS_MISMATCH | Use the policy version references assigned to the deployment. |
| 409 | POLICY_BINDING_REQUIRED | Assign a policy binding to the production deployment. |
| 409 | POLICY_BINDING_NOT_FOUND | Select a policy binding active for this AI system. |
| 409 | POLICY_BINDING_INACTIVE | Activate or replace the policy binding. |
| 409 | POLICY_REFS_MISSING | Add policy version references to the production deployment. |
| 409 | APPLICABLE_POLICY_REFS_MISSING | Add every required policy category to the policy binding. |
| 409 | AI_INVENTORY_OUTPUT_BINDING_MISMATCH | Bind output evidence to the signing-time inventory binding. |
| 409 | AI_INVENTORY_CONTENT_EVIDENCE_TRANSITION_REASON_REQUIRED | Provide a reason when input and output inventory bindings differ. |
| 409 | AI_INVENTORY_CONTENT_EVIDENCE_LINKAGE_INVALID | Correct the content-evidence inventory linkage. |
| 409 | SYNTHETIC_CONTENT_STATUS_UNKNOWN_BLOCKED | Provide a known synthetic-content status required by policy. |
| 409 | SYNTHETIC_CONTENT_DECLARATION_HASH_STALE | Regenerate the synthetic content declaration hash. |
| 409 | CONTENT_MARKING_HASH_STALE | Regenerate the content marking hash. |
| 409 | DISCLOSURE_EVIDENCE_ARTIFACT_HASH_STALE | Regenerate the disclosure evidence hash. |
| 409 | DISCLOSURE_POLICY_BLOCKED | Resolve the disclosure policy findings before signing. |
| 409 | DISCLOSURE_BINDING_HASH_STALE | Regenerate the disclosure binding hash. |
| 413 | PAYLOAD_TOO_LARGE | Request body exceeds the endpoint limit. |
| 428 | IDEMPOTENCY_KEY_REQUIRED | Idempotency-Key is required for signing. |
| 429 | RATE_LIMITED | Rate limit exceeded; follow Retry-After. |
| 429 | QUOTA_EXCEEDED | The endpoint quota is exhausted for the current window. |
| 429 | MONTHLY_QUOTA_EXCEEDED | The monthly API quota is exhausted. |
| 429 | MONTHLY_USAGE_LIMIT_REACHED | The monthly usage limit is exhausted. |
| 429 | USAGE_HARD_CAP_REACHED | The configured usage hard cap is exhausted. |
| 503 | RATE_LIMIT_BACKEND_UNAVAILABLE | Rate limiting is temporarily unavailable. |
| 503 | USAGE_BACKEND_UNAVAILABLE | Usage enforcement is temporarily unavailable. |
| 503 | PLAN_NOT_CONFIGURED | Configure an organization plan before using this endpoint. |
| 503 | WRITES_DISABLED | API writes are temporarily disabled; retry later. |
| 503 | TRUST_ROOT_UNAVAILABLE | The public trust root is temporarily unavailable. |
| 500 | API_KEY_SCOPE_CONFIG_INVALID | The endpoint scope configuration is invalid; contact support with trace_id. |
| 500 | INTERNAL_ERROR | The request failed unexpectedly. Contact support with trace_id. |
Headers operacionais
Retry-After, X-RateLimit-*, X-Quota-*, X-Usage-* e X-Billing-* descrevem limites e consumo. Todas as respostas documentadas incluem X-AuthenChain-API-Version: 1.