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

> Endpoint de avaliação de risco unificado. Ingesta um sinal, avalia-o em relação às políticas do seu inquilino, cria uma decisão de risco assinada e, opcionalmente, cunha um recibo de decisão de fraude para não repúdio.

## Como a avaliação funciona

1. O sinal é ingerido em `risk_signals`
2. Suas regras de política ativas são avaliadas (a correspondência de maior prioridade vence)
3. Um registro `risk_decision` é criado com o resultado
4. Se `mint_receipt: true` e `issuer_id`/`kid` forem fornecidos, um `fraud_decision_receipt` é cunhado através do serviço de atestado

## Resultados da decisão

| Ação | Significado |
| - | - |
| `allow` | Nenhuma política correspondente ou pontuação abaixo de todos os limites |
| `challenge` | MFA ou autenticação de etapa adicional necessária |
| `block` | Rejeitar a ação inteiramente |
| `review` | Encaminhar para fila de revisão manual de fraude |

## Tipos de recibo incorporados

| Tipo de Recibo | Finalidade |
| - | - |
| `fraud_decision_receipt` | Registra decisão de permitir/desafiar/bloquear/revisar |
| `ato_alert_receipt` | Registra eventos de alerta ATO |
| `risk_block_receipt` | Prova que uma ação foi bloqueada |
| `deepfake_detection_receipt` | Registra resultados de varredura de deepfake |

## Resposta

**decision** `string`

`allow` | `challenge` | `block` | `review`

**decision\_id** `string`

UUID do registro de decisão de risco.

**signal\_id** `string`

UUID do sinal de risco ingerido.

**policy\_id** `string`

UUID da regra de política correspondente (se houver).

**receipt\_id** `string`

UUID do recibo cunhado (somente se `mint_receipt: true` e bem-sucedido).


## OpenAPI

````yaml pt/mint-openapi.yaml POST /v1/risk/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/risk/evaluate:
    post:
      tags:
        - Risk
      summary: Avaliar risco
      description: >-
        Avaliação de risco unificada. Ingesta um sinal, avalia contra políticas,
        cria uma decisão de risco assinada.
      operationId: risk.evaluate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - signal_type
                - subject_id
                - risk_score
              properties:
                signal_type:
                  type: string
                  enum:
                    - velocity
                    - ato
                    - deepfake
                    - impersonation
                    - geo_anomaly
                    - behavior
                    - device_fingerprint
                subject_id:
                  type: string
                risk_score:
                  type: integer
                  minimum: 0
                  maximum: 100
                subject_type:
                  type: string
                  default: user
                mint_receipt:
                  type: boolean
                issuer_id:
                  type: string
                kid:
                  type: string
      responses:
        '200':
          description: Decisão de risco
          content:
            application/json:
              schema:
                type: object
                properties:
                  decision_id:
                    type: string
                  signal_id:
                    type: string
                  decision:
                    type: string
                    enum:
                      - allow
                      - challenge
                      - block
                      - review
                  policy_id:
                    nullable: true
                    type: string
                  receipt_id:
                    nullable: true
                    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.