Documentação Técnica

Visão Geral da API

A API ComplianceOS é uma interface REST autenticada via JWT (RS256) que expõe todos os recursos da plataforma. Todos os endpoints seguem o versionamento /v1/ e retornam JSON.

A solução é desenvolvida e operada por CHUANGXIN TECNOLOGIA DA INFORMACAO LTDA (CNPJ 65.089.671/0001-16), em conformidade com a LGPD e normas do BACEN.

Quick Start — 5 minutos

3 passos para realizar sua primeira due diligence via API.

Passo 1 — Autenticar

curl -X POST https://api.complianceos.com.br/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{
    "email": "cco@sua-empresa.com.br",
    "password": "SuaSenha@2026"
  }'

# Resposta
{
  "data": {
    "accessToken": "eyJhbGciOiJSUzI1NiJ9...",
    "expiresIn": 900
  }
}

Passo 2 — Criar Entidade

curl -X POST https://api.complianceos.com.br/v1/entities \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Chuangxin Tecnologia da Informacao Ltda",
    "cnpj": "65089671000116",
    "entityType": "FORNECEDOR",
    "sector": "Tecnologia da Informação"
  }'

# Resposta 201
{
  "data": { "id": "01HQ7XK2N...", "riskLevel": "UNKNOWN" },
  "meta": { "kybJobId": "job_01HQ...", "message": "KYB iniciado automaticamente." }
}

Passo 3 — Executar Checklist PLD

# Listar checklists disponíveis
curl "https://api.complianceos.com.br/v1/checklists?module=PLD_FT" \
  -H "Authorization: Bearer <access_token>"

# Iniciar execução
curl -X POST https://api.complianceos.com.br/v1/checklists/run \
  -H "Authorization: Bearer <access_token>" \
  -H "Content-Type: application/json" \
  -d '{
    "checklistId": "01HQ...",
    "entityId": "01HQ7XK2N...",
    "answers": []
  }'

Autenticação

Todos os endpoints (exceto /v1/auth/*) requerem Bearer Token JWT RS256 com expiração de 15 minutos.

Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...

Payload do JWT

{
  "sub": "uuid-do-usuario",
  "tenantId": "uuid-do-tenant",
  "role": "COMPLIANCE_OFFICER",
  "plan": "PROFESSIONAL",
  "modules": ["PLD_FT", "LGPD", "ANTICORRUPCAO"],
  "iat": 1708123456,
  "exp": 1708124356
}

Roles disponíveis

Renovação de Token

curl -X POST https://api.complianceos.com.br/v1/auth/refresh \
  -H "Content-Type: application/json" \
  -d '{ "refreshToken": "eyJhbGci..." }'

Formato de Erros (RFC 7807)

Todos os erros seguem o padrão Problem Details (RFC 7807) para interoperabilidade.

{
  "type": "https://complianceos.com.br/errors/VALIDATION_ERROR",
  "title": "Erro de validação",
  "status": 400,
  "detail": "CNPJ deve ter 14 dígitos numéricos",
  "instance": "/v1/entities",
  "requestId": "01HQ7XK2N3P4Q5R6S7T8U9V0",
  "timestamp": "2026-03-03T22:10:00Z"
}

Paginação (Cursor-based)

GET /v1/entities?cursor=01HQ7XK...&limit=25&sort=created_at:desc

// Response
{
  "data": [...],
  "meta": {
    "total": 142,
    "limit": 25,
    "hasMore": true,
    "nextCursor": "01HQ7XL..."
  }
}

Rate Limits

# Headers de resposta
X-RateLimit-Limit: 600
X-RateLimit-Remaining: 487
X-RateLimit-Reset: 1708123500
Retry-After: 45   # apenas quando 429

API — Entidades

Gerencie o portfólio de entidades (clientes, fornecedores, parceiros) sujeitas à due diligence.

API — Checklists

Execute due diligences baseadas nas regulamentações Lei 9.613/98, Lei 12.846/13 e LGPD.

API — Documentos

Gere documentos regulatórios em PDF com assinatura digital (PKCS#7/PAdES) e carimbo de tempo (TSA).

// Request
{ "docType": "POLITICA_PLD", "entityId": null, "params": { "vigenciaAnos": 1 } }

// Response 202
{
  "data": { "jobId": "job_01HR...", "status": "GENERATING", "estimatedSeconds": 30 },
  "meta": { "webhookEvent": "document.ready", "pollUrl": "/v1/documents/jobs/job_01HR..." }
}

API — Audit Trail

API — Usuários

API — Dashboard

// Response 200
{
  "data": {
    "entities": { "total": 142, "byRisk": { "CRITICAL": 3, "HIGH": 18, "MEDIUM": 67, "LOW": 54 } },
    "checklists": { "overdue": 7, "dueSoon": 12, "completedThisMonth": 34 },
    "alerts": { "critical": 1, "warning": 5, "unread": 4 }
  }
}

Webhooks (Enterprise)

Receba notificações em tempo real no seu sistema. Disponível no plano Enterprise.

Payload e Validação de Assinatura

// POST para URL configurada — HMAC-SHA256
{
  "webhookId": "wh_01HR...",
  "event": "entity.risk.escalated",
  "tenantId": "uuid",
  "timestamp": "2026-03-03T22:10:00Z",
  "data": {
    "entityName": "Chuangxin Tecnologia da Informacao Ltda",
    "cnpj": "65089671000116",
    "previousLevel": "MEDIUM",
    "newLevel": "HIGH"
  },
  "signature": "sha256=a1b2c3..."
}

// Validação (TypeScript)
import { createHmac } from 'crypto'

function verifyWebhook(rawBody: string, signature: string, secret: string): boolean {
  const computed = 'sha256=' + createHmac('sha256', secret).update(rawBody, 'utf8').digest('hex')
  return computed === signature
}

Integração — API de CNPJ

// GET /v1/cnpj/65089671000116
{
  "data": {
    "cnpj": "65.089.671/0001-16",
    "razaoSocial": "CHUANGXIN TECNOLOGIA DA INFORMACAO LTDA",
    "situacaoCadastral": "ATIVA",
    "dataAbertura": "2022-01-10",
    "naturezaJuridica": "Sociedade Empresária Limitada",
    "atividadePrincipal": "Desenvolvimento de programas de computador sob encomenda",
    "capitalSocial": 100000.00,
    "porte": "MICRO",
    "municipio": "São Paulo",
    "uf": "SP"
  }
}

Integração — Screening de Sanções

SAML SSO (Enterprise)

Suporte a SAML 2.0 com Okta, Azure AD, Google Workspace e Auth0.

Entity ID: https://api.complianceos.com.br/auth/saml/metadata
ACS URL:   https://api.complianceos.com.br/auth/saml/callback
Metadata:  https://api.complianceos.com.br/auth/saml/metadata.xml

Módulo — PLD/FT

Prevenção à Lavagem de Dinheiro. Baseado na Lei 9.613/98, Res. BACEN 4.753/2019 e Circular BACEN 3.978/2020.

Módulo — LGPD

Conformidade com a Lei 13.709/18 e Resoluções da ANPD.

Módulo — Anticorrupção

Programa de Integridade baseado na Lei 12.846/13 e Decreto 11.129/2022 — 5 pilares da CGU.