Pular para o conteúdo
Sentinex Risk Crypto

API Reference: Visão Geral

A API REST do Sentinex Risk Crypto segue convenções consistentes em todos os endpoints. Aprenda essas convenções uma vez e qualquer endpoint passa a ser previsível.

Base URLs

Seção intitulada “Base URLs”
Ambiente URL Uso
Produção https://api.crypto.sentinexrisk.com/api/v1 Tráfego real, dados reais, billing ativo
Produção (host do dashboard) https://crypto.sentinexrisk.com/api/v1 Mesmo backend
Dashboard https://crypto.sentinexrisk.com Console humano (JWT + MFA), UI Pages

Convenções universais

Seção intitulada “Convenções universais”
Tópico Convenção
Encoding UTF-8, sempre
Casing snake_case em campos JSON e query params
IDs UUID v4 string (ex: 9c2a1b3e-1d0a-4b7f-8e2c-7a1b3c5d7e9f)
Data/hora ISO 8601 UTC com sufixo Z (ex: 2026-05-18T14:32:11Z)
Valores monetários string decimal de unidades-base (ex: "1500.00" BRL) ou raw integer (ex: "50000000" satoshis), sempre string para precisão
Enums UPPER_SNAKE_CASE (ex: KYC_TIER_STANDARD, RISK_RED)
Booleanos prefixos is_, has_, requires_
Paginação Não é uniforme: a maioria das listagens usa ?page=…&limit=…, e algumas rotas de busca usam ?pagination=cursor&cursor_before=… (ver Paginação)
Versionamento URL versioning: /api/v1/... é estável; /api/v2/... (futuro) é breaking

Headers obrigatórios

Seção intitulada “Headers obrigatórios”

Superfície de integração (/vasp/*), autenticada por API key:

X-API-Key: snxc_live_<sua_chave_aqui>
Content-Type: application/json
Accept: application/json

A API key carrega o tenant e os escopos: não existe header X-Tenant-ID. Rotas de dashboard usam Authorization: Bearer <JWT> (ver Authentication).

Headers opcionais úteis:

Header Para que serve
Idempotency-Key Retry-safe para POST/PATCH (ver Idempotência)
X-Request-ID Correlation id que volta no X-Request-ID da resposta. Útil para suporte
Accept-Language pt-BR (default) ou en-US. Afeta mensagens de erro

Estrutura padrão de resposta

Seção intitulada “Estrutura padrão de resposta”

Sucesso

Seção intitulada “Sucesso”
{
  "success": true,
  "data": { /* recurso ou collection */ }
}

Listas trazem o bloco de paginação da rota. No modelo offset, que é o mais comum:

{
  "success": true,
  "data": [ /* items */ ],
  "meta": {
    "page": 1,
    "limit": 20,
    "total": 137
  }
}

Parte da superfície /vasp/* usa a chave pagination com total, limit e offset, e as rotas de busca com cursor devolvem next_cursor como irmão de data. Ver Paginação.

Erro

Seção intitulada “Erro”

O formato de erro não é único. O mais comum é o envelope com error como string:

{
  "success": false,
  "error": "O campo external_id é obrigatório."
}

Parte dos handlers acrescenta code ao lado de error, e parte usa error como objeto com code e message. O identificador de correlação não vem no corpo: ele volta no header X-Request-ID. Ver Erros e códigos antes de escrever tratamento de erro.

Grupos de endpoints

Seção intitulada “Grupos de endpoints”
Grupo Prefixo Resumo
Identidade /customers, /clients KYC PF/PJ, screening, ciclo de vida
Carteiras /wallets, /vasp/wallets Screening on-chain, blocklist, attribution
Transações /transactions, /vasp/transactions KYT scoring síncrono (~95ms p50), histórico
Operações /alerts, /cases, /queue Mesa de trabalho compliance
Compliance /compliance/coaf, /compliance/decripto, /compliance/travelrule Preparação interna e capacidades condicionadas
LGPD /lgpd/me, /lgpd/me/export, /lgpd/me/erase Confirmação autenticada, exportação parcial e redirecionamento canônico sem exclusão
Webhooks /vasp/webhooks (API key), /admin/outbound-webhooks/* e /webhooks/endpoints (JWT) Subscrições outbound, entregas e DLQ
Plataforma /auth/*, /billing/*, /admin/* Autenticação, billing, admin

Próximos passos

Seção intitulada “Próximos passos”