> ## 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 MAIP

> Avalia todas as políticas de agente ativas em relação a um agente específico e escopo solicitado

# Avaliar Política MAIP

`POST /v1/maip/policies/evaluate`

Avalia todas as políticas MAIP ativas para o inquilino autenticado contra um agente específico e escopo solicitado. Retorna se a ação é permitida, negada ou requer aprovação humana. Este é o ponto de verificação de aplicação em tempo de execução que os agentes chamam antes de realizar operações sensíveis.

> [!NOTE]
>
> A avaliação da política usa um modelo de **negação-prevalece**: se qualquer política ativa com um
> correspondente `deny` aciona a regra, a ação é bloqueada independentemente de qualquer `allow`
> regras. O sinalizador `requires_approval` é aditivo -- ele pode ser definido mesmo quando o
> ação é permitida.

### Autenticação

Requer cabeçalho `X-API-Key` ou token JWT de portador. Com escopo de locatário via cookie ou declaração JWT.

### Lógica de Avaliação

A avaliação realiza três verificações sequenciais:

1. **Verificação de Status do Agente** — O agente deve ter `status: "active"`. Agentes suspensos ou revogados são sempre negados.
2. **Verificação de Acesso ao Escopo** — O escopo solicitado deve estar presente nos escopos concedidos do agente. Escopos explicitamente negados (prefixados com `!`) sempre bloqueiam o acesso.
3. **Verificação de Regras de Política** -- Todas as políticas de locatário ativas são avaliadas em ordem de prioridade. As condições de cada regra são combinadas com AND. Se alguma regra `deny` corresponder, a ação é bloqueada.

### Resposta

**allowed** `boolean`

`true` se a ação for permitida, `false` se negada por qualquer verificação.

**denied\_by** `string[]`

Nomes das políticas que negaram a ação. Array vazio se permitido.

**reason** `string`

Razão legível por humanos para a negação. Uma das seguintes: - `"agent is not active"` -- Agente
está suspenso ou revogado - `"scope not granted to agent"` -- Escopo não em
escopos concedidos do agente - `"denied by policy"` -- Uma ou mais políticas bloquearam
a ação

**requires\_approval** `boolean`

`true` se qualquer regra de política correspondente tiver `requires_approval: true`, mesmo que o
ação é permitida de outra forma. O chamador deve apresentar uma aprovação humana
fluxo de trabalho antes de prosseguir.

### Exemplo

```bash theme={null}
curl -X POST https://api.truthlocks.com/v1/maip/policies/evaluate \
  -H "X-API-Key: tl_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "agent_id": "maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH",
    "scope": "data:write",
    "action": "update_customer_record",
    "resource": "customers/cust_12345"
  }'
```

```javascript theme={null}
const response = await fetch(
  "https://api.truthlocks.com/v1/maip/policies/evaluate",
  {
    method: "POST",
    headers: {
      "X-API-Key": "tl_live_...",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      agent_id: "maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH",
      scope: "data:write",
      action: "update_customer_record",
      resource: "customers/cust_12345",
    }),
  },
);
const result = await response.json();

if (!result.allowed) {
  console.error(`Denied by: ${result.denied_by.join(", ")}`);
} else if (result.requires_approval) {
  // Route to human approval workflow
}
```

```python theme={null}
import requests

response = requests.post(
    "https://api.truthlocks.com/v1/maip/policies/evaluate",
    headers={
        "X-API-Key": "tl_live_...",
        "Content-Type": "application/json",
    },
    json={
        "agent_id": "maip:t1234567:01HYX3KPZQ7RJGBN0WFMV8SDEH",
        "scope": "data:write",
        "action": "update_customer_record",
        "resource": "customers/cust_12345",
    },
)
result = response.json()
```


## OpenAPI

````yaml pt/mint-openapi.yaml POST /v1/maip/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/maip/policies/evaluate:
    post:
      tags:
        - Machine Identity
      summary: Avaliar Política MAIP
      description: >-
        Avalia todas as políticas MAIP ativas contra um agente específico e
        escopo solicitado. Usa o modelo de negação-sobreposição: qualquer regra
        de negação correspondente bloqueia a ação.
      operationId: maip.policies.evaluate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - agent_id
                - scope
              properties:
                agent_id:
                  type: string
                  description: Identificador de agente compatível com MAIP
                scope:
                  type: string
                  description: Escopo de permissão sendo solicitado
                action:
                  type: string
                  description: Ação específica sendo realizada
                resource:
                  type: string
                  description: Recurso específico sendo acessado
      responses:
        '200':
          description: Resultado da avaliação
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipPolicyEvaluateResponse'
        '400':
          description: Campos obrigatórios ausentes
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Autenticação necessária
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Agente não encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    MaipPolicyEvaluateResponse:
      type: object
      properties:
        allowed:
          type: boolean
          description: Se a ação é permitida
        denied_by:
          type: array
          items:
            type: string
          description: Nomes das políticas que negaram a ação
        reason:
          type: string
          description: Razão de negação legível por humanos
        requires_approval:
          type: boolean
          description: Se a aprovação humana é necessária
    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.