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

# Criar Verificação de Conformidade

> Executar uma verificação de conformidade automatizada contra uma regulamentação para uma entidade

Executa uma avaliação de conformidade automatizada para uma entidade específica (agente, modelo, conjunto de dados ou fluxo de trabalho) contra uma regulamentação suportada. A verificação avalia a configuração da entidade, padrões de acesso, tratamento de dados e trilha de auditoria em relação aos requisitos da regulamentação e produz uma determinação de conformidade com descobertas detalhadas.

As verificações de conformidade são idempotentes para o mesmo par entidade-regulamentação dentro de uma janela de 24 horas. Chamadas repetidas dentro dessa janela retornam o resultado em cache.

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

Identificador único para o registro de verificação de conformidade. Formato: `maip-cc:ULID`.

**entity\_type** `string`

O tipo de entidade que foi avaliada.

**entity\_id** `string`

O identificador da entidade avaliada.

**regulation** `string`

A regulamentação que foi avaliada.

**scope** `string`

O escopo da avaliação. `full` se nenhum escopo foi especificado.

**status** `string`

A determinação de conformidade. Uma de: - `compliant` -- a entidade atende a todos
requisitos avaliados - `non_compliant` -- entidade falha em um ou mais requisitos críticos
requisitos - `partial` -- a entidade atende a alguns, mas não a todos os requisitos

**findings** `object[]`

Lista detalhada de descobertas individuais da avaliação.

**Finding fields**

**findings\[].control\_id** `string`

O identificador de controle dentro do regulamento (por exemplo, `CC6.1` para SOC2, `A.9.1.1` para ISO27001).

**findings\[].control\_name** `string`

Nome legível do controle.

**findings\[].status** `string`

Status deste controle específico: `pass`, `fail`, `partial`, `not_applicable`.

**findings\[].severity** `string`

Gravidade da descoberta se não passar: `critical`, `high`, `medium`, `low`.

**findings\[].description** `string`

Descrição detalhada da descoberta e orientação de remediação.

**receipt\_id** `string`

O recibo MAIP emitido para esta verificação de conformidade, fornecendo um
registro de auditoria.

**checked\_at** `string`

Carimbo de data/hora ISO 8601 de quando a avaliação foi realizada.

### Regulamentações Suportadas

| Regulamentação | Controles Avaliados | Duração Típica |
| :- | :- | :- |
| `SOC2` | Critérios de Serviço de Confiança (CC1-CC9) | 2-5 segundos |
| `ISO27001` | Controles do Anexo A (A.5-A.18) | 2-5 segundos |
| `GDPR` | Artigos 5, 6, 12-22, 25, 32-34 | 3-8 segundos |
| `HIPAA` | Salvaguardas Administrativas, Físicas, Técnicas | 3-8 segundos |
| `EU_AI_ACT` | Classificação de risco, transparência, supervisão humana | 5-10 segundos |


## OpenAPI

````yaml pt/mint-openapi.yaml POST /v1/compliance/check
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/compliance/check:
    post:
      tags:
        - Machine Identity
      summary: Criar Verificação de Conformidade
      description: >
        Inicia uma verificação de conformidade para um agente contra uma
        estrutura regulatória

        especificada. Retorna descobertas com classificações de severidade.
      operationId: maip.compliance.check
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                auditor_id:
                  type: string
                check_type:
                  type: string
                entity_id:
                  type: string
                entity_type:
                  type: string
                evidence_hash:
                  nullable: true
                  type: string
                metadata: {}
                notes:
                  type: string
                regulation:
                  type: string
                requirement_id:
                  type: string
                result:
                  type: string
                ttl_days:
                  type: integer
              type: object
              required:
                - entity_id
                - regulation
                - requirement_id
                - result
                - auditor_id
      responses:
        '201':
          description: Verificação de conformidade criada
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MaipComplianceCheck'
        '400':
          description: Erro de validação
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '401':
          description: Autenticação necessária
          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:
    MaipComplianceCheck:
      type: object
      properties:
        check_id:
          type: string
          format: uuid
        agent_id:
          type: string
          format: uuid
        framework:
          type: string
          enum:
            - soc2
            - iso27001
            - hipaa
            - gdpr
        scope:
          type: object
          additionalProperties: true
        status:
          type: string
          enum:
            - pending
            - passed
            - failed
            - partial
        findings:
          type: array
          items:
            type: object
            properties:
              finding_id:
                type: string
              severity:
                type: string
                enum:
                  - low
                  - medium
                  - high
                  - critical
              title:
                type: string
              description:
                type: string
        created_at:
          type: string
          format: date-time
    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.