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

# Obter Consenso de Testemunhas

> Recupere o resultado de consenso para uma solicitação de verificação de testemunha

Retorna o estado de consenso atual para uma solicitação de testemunha, incluindo contagens de votos e determinação final. Use este endpoint para pesquisar a conclusão do consenso ou para recuperar o resultado final após as testemunhas terem atestado.

O consenso é calculado automaticamente quando o número de atestações atinge o limite `required_witnesses`. Uma maioria simples de veredictos `confirm` ou `deny` determina o resultado. Os votos `abstain` contam para o quórum, mas não influenciam o cálculo da maioria.

### Autenticação

Requer cabeçalho `X-API-Key` ou token JWT de portador. O espaço de trabalho é derivado da credencial autenticada; não envie `X-Tenant-ID`.

### Resposta

**id** `string`

O identificador da solicitação de testemunha.

**claim\_id** `string`

A reivindicação de verdade que estava sendo testemunhada.

**status** `string`

Status atual da solicitação de testemunha. Um de: - `pending` -- ainda aguardando
atestações - `confirmed` -- consenso alcançado, reivindicação confirmada - `denied`
\-- consenso alcançado, reivindicação negada - `expired` -- TTL decorrido sem
atingindo o quórum

**required\_witnesses** `integer`

Número de atestados necessários para o consenso.

**confirmations** `integer`

Número de veredictos `confirm` recebidos.

**denials** `integer`

Número de veredictos `deny` recebidos.

**abstentions** `integer`

Número de veredictos `abstain` recebidos.

**consensus\_reached** `boolean`

Se o quórum exigido foi atingido e uma determinação foi feita.

**consensus\_at** `string`

Carimbo de data/hora ISO 8601 de quando o consenso foi alcançado. `null` se ainda pendente ou
expirou sem consenso.

**expires\_at** `string`

Carimbo de data/hora ISO 8601 de quando a solicitação de testemunha expira (ou expirou).

### Lógica de Consenso

| Cenário | Resultado |
| :- | :- |
| Quórum atingido, maioria `confirm` | `confirmed` |
| Quórum atingido, maioria `deny` | `denied` |
| Quórum atingido, `confirm`/`deny` iguais | Ponderado por pontuações de confiança; a maior confiança agregada vence |
| TTL expira antes do quórum | `expired` |


## OpenAPI

````yaml pt/mint-openapi.yaml GET /v1/witness/{witnessRequestID}/consensus
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/witness/{witnessRequestID}/consensus:
    get:
      tags:
        - Machine Identity
      summary: Verificar Consenso
      description: >-
        Verifica se o grupo de testemunhas atingiu o limite de atestado
        necessário. Retorna a contagem atual de atestados e as assinaturas
        coletadas.
      operationId: maip.witness.consensus
      parameters:
        - name: witnessRequestID
          in: path
          required: true
          schema:
            type: string
            format: uuid
          description: Identificador do grupo de testemunhas
      responses:
        '200':
          description: Status do consenso
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipConsensus'
        '401':
          description: Autenticação necessária
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '404':
          description: Grupo de testemunhas não encontrado
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - APIKey: []
components:
  schemas:
    MaipConsensus:
      type: object
      properties:
        reached:
          type: boolean
        attestation_count:
          type: integer
        required:
          type: integer
        signatures:
          type: array
          items:
            type: string
    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.