> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Avaliar política

> Simule uma avaliação de política contra uma entrada de amostra para testar as regras antes de aplicá-las.

Avalia todas as políticas ativas que correspondem à ação e ao alvo fornecidos em relação à entrada fornecida. Use este endpoint para testar como suas políticas se comportam antes de ativá-las em produção.

A resposta inclui quais regras foram correspondidas, se a solicitação seria permitida e um `decision_id` para consultas de trilha de auditoria.

> [!NOTE]
>
> O campo `reasons` é preenchido apenas quando a solicitação é negada. Respostas permitidas retornam um array vazio. Se você anteriormente dependia de `evaluation_ms` para monitoramento de desempenho, esse campo foi removido — consulte `resource_type=policy_decision` no [registro de auditoria de decisão](https://docs.truthlocks.com/pt/security/audit.md#policy-decision-audit-trail) em vez disso.

> [!NOTE]
>
> Cada avaliação é registrada no log de auditoria com um hash SHA-256 da entrada para evidência de adulteração. Use o `decision_id` para consultar a decisão em [consultas de auditoria](https://docs.truthlocks.com/pt/security/audit.md).

### Respostas

### Campos de resposta

| Campo | Tipo | Descrição |
| :- | :- | :- |
| `allowed` | boolean | Se a solicitação seria permitida sob as políticas ativas atuais. |
| `matched_rules` | string\[] | IDs das regras que corresponderam à entrada. Vazio quando nenhuma regra correspondeu e o efeito padrão foi aplicado. |
| `reasons` | string\[] | Explicação do motivo pelo qual a solicitação foi negada. Sempre um array vazio quando `allowed` é `true`. |
| `decision_id` | string | Identificador único para esta avaliação. Use-o para consultar o registro de decisão completo na [trilha de auditoria](https://docs.truthlocks.com/pt/security/audit.md#policy-decision-audit-trail). |


## OpenAPI

````yaml pt/mint-openapi.yaml POST /v1/policies/evaluate
openapi: 3.0.3
info:
  title: Truthlocks API
  description: >-
    Truthlocks é uma infraestrutura de verificação universal para documentos,
    credenciais e ativos digitais.

    Esta especificação define a API canônica para interagir com os serviços
    Truthlocks.


    ## URLs Base

    - **Produção**: `https://api.truthlocks.com`

    - **Sandbox**: `https://sandbox-api.truthlocks.com`


    ## Autenticação

    - **Chaves de API**: Use o cabeçalho `X-API-Key` para operações máquina a
    máquina

    - **Tokens de Portador**: Use `Authorization: Bearer <jwt>` para operações
    iniciadas pelo usuário


    ## Identidade do Inquilino

    Em produção, a identidade do inquilino é derivada do contexto autenticado
    (chave de API ou JWT).

    O cabeçalho `X-Tenant-ID` é ignorado em produção para evitar falsificação.
  version: 1.0.0
  contact:
    name: Truthlocks Support
    url: https://truthlocks.com/support
    email: support@truthlocks.com
servers:
  - url: https://api.truthlocks.com
    description: API de Produção
  - url: https://sandbox-api.truthlocks.com
    description: Ambiente Sandbox
security:
  - APIKey: []
  - BearerAuth: []
tags:
  - name: Authentication
    description: Gerenciamento de chaves e tokens de API
  - name: Issuers
    description: Registro do emissor e gerenciamento de confiança
  - name: Keys
    description: Gerenciamento de chaves criptográficas para emissores
  - name: Attestations
    description: Ciclo de vida da atestação (cunhar, revogar, substituir)
  - name: Verification
    description: Verificação de atestado e pacotes de prova
  - name: Governance
    description: Fluxos de trabalho de governança do emissor (somente administrador)
  - name: Identity
    description: Gerenciamento de organização, usuário e função
  - name: Audit
    description: Consultas de eventos de auditoria
  - name: Tenant Console
    description: Endpoints de perfil e ciclo de vida do locatário
  - name: Health
    description: Endpoints de saúde e prontidão do serviço
  - name: Risk
    description: Ingestão de sinal de risco e detecção de fraude
  - name: Risk Enforcement
    description: Ações de aplicação de risco — bloqueio, desafio, quarentena e configuração
  - name: Billing
    description: Gerenciamento de faturamento, assinatura e complementos
  - name: Machine Identity
    description: >-
      Protocolo de Identidade de Agente de Máquina (MAIP) — registro de agente,
      sessões, confiança, testemunha, conformidade, orquestração e
      observabilidade
externalDocs:
  description: API somente leitura de transparência (especificação de serviço separada)
  url: >-
    https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
  /v1/policies/evaluate:
    post:
      tags:
        - Policies
      summary: Avaliar políticas
      description: Avalia todas as políticas ativas contra uma ação e contexto específicos.
      operationId: policies.evaluate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                action:
                  type: string
                input:
                  additionalProperties: {}
                  type: object
                target_id:
                  format: uuid
                  nullable: true
                  type: string
                target_type:
                  type: string
              type: object
      responses:
        '200':
          description: Resultado da avaliação
          content:
            application/json:
              schema:
                type: object
                properties:
                  decision:
                    type: string
                    enum:
                      - ALLOW
                      - DENY
                  matched_policy:
                    nullable: true
                    type: string
                  matched_rule:
                    nullable: true
                    type: string
                  reason:
                    type: string
        '401':
          description: Autenticação necessária
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    ErrorEnvelope:
      type: object
      required:
        - code
        - message
        - http_status
      properties:
        code:
          type: string
          description: Código de erro legível por máquina
          enum:
            - AUTH_REQUIRED
            - AUTH_INVALID
            - PERMISSION_DENIED
            - TENANT_IDENTITY_UNVERIFIED
            - NOT_FOUND
            - VALIDATION_ERROR
            - CONFLICT
            - PAYLOAD_TOO_LARGE
            - RATE_LIMIT_EXCEEDED
            - QUOTA_EXCEEDED
            - SERVICE_UNAVAILABLE
            - INTERNAL_ERROR
        message:
          type: string
          description: Mensagem de erro legível por humanos
        http_status:
          type: integer
          description: Código de status HTTP
        retry_after_ms:
          type: integer
          description: >-
            Milissegundos para aguardar antes de tentar novamente (para limites
            de taxa)
        details:
          type: object
          description: Contexto de erro adicional
      example:
        code: AUTH_REQUIRED
        message: Authentication required
        http_status: 401
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: X-API-Key
      description: Chave de API para autenticação máquina a máquina
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT para operações iniciadas pelo usuário

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.