← Documentação

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": "..."
}
HTTPCódigoAção
400INVALID_JSONRequest body must be valid JSON.
400INVALID_PAYLOADRequest payload does not match the endpoint contract.
400INVALID_EVIDENCE_PACKProvide an Evidence Pack object with a proofs array.
400INVALID_REQUESTReview the request fields and retry.
400INVALID_METADATARegulatory metadata is invalid; review the reported validation details.
400INVALID_HASHProvide a valid SHA-256 hash.
400INVALID_IDEMPOTENCY_KEYIdempotency-Key must contain 8 to 128 allowed characters.
400VERIFICATION_FAILEDThe supplied evidence could not be verified.
400REGULATORY_METADATA_REQUIREDProvide metadata.regulatory when binding a regulatory risk context.
400RISK_CONTEXT_REFERENCE_REQUIREDProvide both aiUseCaseId and riskClassificationId.
400AI_INVENTORY_REFERENCE_REQUIREDProvide aiSystemId and deploymentEnvironment for inventory binding.
400AI_INVENTORY_CONTENT_EVIDENCE_BINDING_HASH_INVALIDUse a valid sha256: inventory binding hash in content evidence.
400AI_INVENTORY_CONTENT_EVIDENCE_TRANSITION_REASON_INVALIDUse a supported inventory binding transition reason.
400SYNTHETIC_CONTENT_CERTAINTY_CLAIM_UNSUPPORTEDRemove unsupported independent certainty claims.
400SYNTHETIC_CONTENT_STATUS_REQUIREDProvide syntheticContentStatus.
400SYNTHETIC_CONTENT_CREDENTIAL_REFERENCE_REQUIREDProvide contentCredentialReferenceHash for a content-credential declaration.
400SYNTHETIC_CONTENT_DECLARATION_INVALIDReview the synthetic content declaration validation details.
400CONTENT_MARKING_INDEPENDENT_VERIFICATION_CLAIM_UNSUPPORTEDRemove unsupported independent marking-verification claims.
400CONTENT_MARKING_RECORD_INVALIDReview the content marking validation details.
400DISCLOSURE_EVIDENCE_ARTIFACT_INVALIDReview the disclosure evidence artifact validation details.
400DISCLOSURE_SIGNING_BINDING_INVALIDReview the disclosure signing binding validation details.
401UNAUTHORIZEDAuthentication credentials are missing or invalid.
401API_KEY_REQUIREDProvide an AuthenChain API key.
401INVALID_API_KEYProvide a valid AuthenChain API key.
401KEY_REVOKEDReplace the revoked API key before retrying.
401KEY_EXPIREDReplace or renew the expired API key before retrying.
402BILLING_INACTIVERestore the organization billing status before retrying.
402SUBSCRIPTION_REQUIREDActivate a subscription for this organization.
403FORBIDDENThe API key does not have the required scope.
403ACCESS_DENIEDThe user or organization has not been approved for API access.
403SCOPE_REQUIREDGrant the API key every scope listed in requiredScopes.
403RISK_CONTEXT_SCOPE_REQUIREDGrant provenance.sign:with-risk-context to the API key.
403AI_INVENTORY_SCOPE_REQUIREDGrant ai_inventory:bind to the API key.
403DISCLOSURE_BIND_SCOPE_REQUIREDGrant disclosure:bind to the API key.
403INVALID_KEY_OWNERSHIPUse a provenance public key owned by this organization.
403REVOKED_KEYUse an active, non-revoked provenance public key.
404NOT_FOUNDThe requested resource was not found.
404RISK_CLASSIFICATION_NOT_FOUNDCreate or select a risk classification for this tenant and use case.
404AI_USE_CASE_NOT_FOUNDCreate or select an AI use case owned by this tenant.
404IMPACT_ASSESSMENT_USE_CASE_REQUIREDProvide aiUseCaseId to evaluate the impact-assessment gate.
404IMPACT_ASSESSMENT_STORE_UNAVAILABLEImpact-assessment records are temporarily unavailable; retry later.
404IMPACT_ASSESSMENT_REQUIREDComplete and approve an AI Impact Assessment before production signing.
404AI_INVENTORY_SYSTEM_NOT_FOUNDUse an AI inventory system owned by this tenant.
404AI_INVENTORY_DEPLOYMENT_NOT_FOUNDUse a deployment registered for this system and environment.
404AI_INVENTORY_MODEL_VERSION_NOT_FOUNDUse a model version registered for this AI system.
409ORG_REQUIREDAssociate the API key with an organization.
409IDEMPOTENCY_KEY_REUSED_WITH_DIFFERENT_REQUESTThe key was already used with a different payload.
409IDEMPOTENCY_PREVIOUS_REQUEST_FAILEDThe prior request associated with this key failed.
409IDEMPOTENCY_REQUEST_IN_PROGRESSA request using this key is still in progress.
409IDEMPOTENCY_REPLAY_UNAVAILABLEThe prior result can no longer be replayed.
409AI_USE_CASE_ARCHIVEDSelect an active AI use case.
409RISK_CLASSIFICATION_BLOCKEDResolve the blocked risk classification before signing.
409PROHIBITED_RISK_CONTEXT_BLOCKEDProvide an approved prohibited-risk exception reference.
409RISK_CLASSIFICATION_STALEReclassify the use case against the active risk policy.
409IMPACT_ASSESSMENT_GATE_BLOCKEDResolve the impact-assessment gate findings before signing.
409IMPACT_ASSESSMENT_EXPIREDRenew and approve the expired AI Impact Assessment.
409IMPACT_ASSESSMENT_STALEReview and approve a current AI Impact Assessment.
409IMPACT_ASSESSMENT_NOT_APPROVEDApprove the AI Impact Assessment before production signing.
409IMPACT_ASSESSMENT_CONDITIONS_NOT_ACKNOWLEDGEDAcknowledge the current approval conditions.
409IMPACT_ASSESSMENT_REFERENCE_MISMATCHUse the assessment references and hashes bound to the current risk context.
409IMPACT_ASSESSMENT_MITIGATION_BLOCKEDResolve blocking or overdue mitigations.
409IMPACT_ASSESSMENT_POLICY_BLOCKEDResolve the impact-assessment policy findings.
409REGULATORY_METADATA_REQUIRED_FOR_IMPACT_ASSESSMENTProvide metadata.regulatory to bind the approved impact assessment.
409AI_INVENTORY_SYSTEM_RETIREDSelect an active, non-retired AI system.
409AI_INVENTORY_SYSTEM_NOT_ACTIVEActivate the AI system before signing.
409AI_INVENTORY_SYSTEM_HASH_MISSINGGenerate the current AI system version hash.
409AI_INVENTORY_DEPLOYMENT_ENVIRONMENT_MISMATCHUse a deployment from the requested environment.
409AI_INVENTORY_DEPLOYMENT_SUSPENDEDReactivate or replace the suspended deployment.
409AI_INVENTORY_DEPLOYMENT_RETIREDSelect a current deployment.
409AI_INVENTORY_DEPLOYMENT_NOT_ACTIVEActivate the production deployment before signing.
409AI_INVENTORY_MODEL_VERSION_MISMATCHUse the model version assigned to the deployment.
409AI_INVENTORY_MODEL_HASH_MISMATCHUse the registered model version hash.
409AI_INVENTORY_DEPLOYMENT_MODEL_HASH_MISMATCHReconcile the deployment and model-version hashes.
409AI_INVENTORY_MODEL_VERSION_NOT_ACTIVEActivate the model version or record an approved exception.
409AI_INVENTORY_ALLOWED_PURPOSE_MISMATCHUse the allowed purpose assigned to the deployment.
409ALLOWED_PURPOSE_REQUIREDAssign an allowed purpose to the production deployment.
409ALLOWED_PURPOSE_NOT_FOUNDSelect an allowed purpose active for this AI system.
409ALLOWED_PURPOSE_INACTIVEActivate or replace the allowed purpose.
409AI_INVENTORY_POLICY_BINDING_MISMATCHUse the policy binding assigned to the deployment.
409AI_INVENTORY_POLICY_REFS_MISMATCHUse the policy version references assigned to the deployment.
409POLICY_BINDING_REQUIREDAssign a policy binding to the production deployment.
409POLICY_BINDING_NOT_FOUNDSelect a policy binding active for this AI system.
409POLICY_BINDING_INACTIVEActivate or replace the policy binding.
409POLICY_REFS_MISSINGAdd policy version references to the production deployment.
409APPLICABLE_POLICY_REFS_MISSINGAdd every required policy category to the policy binding.
409AI_INVENTORY_OUTPUT_BINDING_MISMATCHBind output evidence to the signing-time inventory binding.
409AI_INVENTORY_CONTENT_EVIDENCE_TRANSITION_REASON_REQUIREDProvide a reason when input and output inventory bindings differ.
409AI_INVENTORY_CONTENT_EVIDENCE_LINKAGE_INVALIDCorrect the content-evidence inventory linkage.
409SYNTHETIC_CONTENT_STATUS_UNKNOWN_BLOCKEDProvide a known synthetic-content status required by policy.
409SYNTHETIC_CONTENT_DECLARATION_HASH_STALERegenerate the synthetic content declaration hash.
409CONTENT_MARKING_HASH_STALERegenerate the content marking hash.
409DISCLOSURE_EVIDENCE_ARTIFACT_HASH_STALERegenerate the disclosure evidence hash.
409DISCLOSURE_POLICY_BLOCKEDResolve the disclosure policy findings before signing.
409DISCLOSURE_BINDING_HASH_STALERegenerate the disclosure binding hash.
413PAYLOAD_TOO_LARGERequest body exceeds the endpoint limit.
428IDEMPOTENCY_KEY_REQUIREDIdempotency-Key is required for signing.
429RATE_LIMITEDRate limit exceeded; follow Retry-After.
429QUOTA_EXCEEDEDThe endpoint quota is exhausted for the current window.
429MONTHLY_QUOTA_EXCEEDEDThe monthly API quota is exhausted.
429MONTHLY_USAGE_LIMIT_REACHEDThe monthly usage limit is exhausted.
429USAGE_HARD_CAP_REACHEDThe configured usage hard cap is exhausted.
503RATE_LIMIT_BACKEND_UNAVAILABLERate limiting is temporarily unavailable.
503USAGE_BACKEND_UNAVAILABLEUsage enforcement is temporarily unavailable.
503PLAN_NOT_CONFIGUREDConfigure an organization plan before using this endpoint.
503WRITES_DISABLEDAPI writes are temporarily disabled; retry later.
503TRUST_ROOT_UNAVAILABLEThe public trust root is temporarily unavailable.
500API_KEY_SCOPE_CONFIG_INVALIDThe endpoint scope configuration is invalid; contact support with trace_id.
500INTERNAL_ERRORThe 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.

Erros da API | AuthenChain - AuthenChain