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

# Verificação de similaridade de conteúdo

> Verifique se um hash de conteúdo já possui proteções públicas existentes.

GET
`/v1/consumer/similarity`

Verifique se um hash de conteúdo SHA-256 já possui proteções públicas. Isso detecta correspondências exatas de hash público; não realiza análise de similaridade perceptual ou semântica nem estabelece propriedade de direitos autorais.

Envie uma sessão autenticada usando a autorização mostrada em Try It. As proteções pertencentes ao seu espaço de trabalho são excluídas. O parâmetro de consulta `hash` obrigatório é o resumo SHA-256 que você deseja comparar.

Apenas as proteções com `visibility: "public"` são pesquisadas. As proteções privadas nunca são devolvidas.

### Respostas

### Campos de resposta

| Campo | Tipo | Descrição |
| - | - | - |
| `content_hash` | string | O hash que você enviou, repetido para confirmação. |
| `exact_match` | boolean | `true` se existir pelo menos uma proteção pública para este hash. |
| `matches` | array | Até 10 proteções correspondentes, ordenadas por data de criação. |
| `matches[].attestation_id` | string | ID de atestado da proteção correspondente. |
| `matches[].title` | string | Título da proteção correspondente. |
| `matches[].category` | string | Categoria de conteúdo (por exemplo, `photography`, `code`, `design`). |
| `matches[].similarity_score` | number | Sempre `1.0` para correspondências exatas de hash. |
| `matches[].protected_at` | string | Carimbo de data/hora ISO 8601 de quando o conteúdo foi protegido. |
| `total` | integer | Número de correspondências retornadas, não um total ilimitado. |


## OpenAPI

````yaml pt/mint-openapi.yaml GET /v1/consumer/similarity
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/consumer/similarity:
    get:
      tags:
        - Consumer
      summary: Encontrar correspondências exatas de hash público
      description: >-
        Pesquise proteções públicas por hash de conteúdo exato. Isso não realiza
        análise de similaridade semântica ou perceptual, não estabelece
        propriedade de direitos autorais, nem pesquisa registros privados.
        Resultados pertencentes ao espaço de trabalho autenticado são excluídos.
      operationId: consumer.similarity
      parameters:
        - in: query
          name: hash
          required: true
          description: Resumo de conteúdo SHA-256 para comparar, como texto hexadecimal.
          schema:
            type: string
      responses:
        '200':
          description: >-
            Até dez registros públicos correspondentes, excluindo este espaço de
            trabalho.
          content:
            application/json:
              schema:
                type: object
                properties:
                  content_hash:
                    type: string
                  exact_match:
                    type: boolean
                  total:
                    type: integer
                    description: Número de registos devolvidos, não um total ilimitado.
                  matches:
                    type: array
                    items:
                      type: object
                      properties:
                        attestation_id:
                          type: string
                        title:
                          type: string
                        category:
                          type: string
                        similarity_score:
                          type: number
                          enum:
                            - 1
                        protected_at:
                          type: string
                          format: date-time
        '400':
          description: Hash obrigatório ausente
        '401':
          description: Autenticação necessária
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - BearerAuth: []
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.