Todas as operações
O contrato do cliente KYT na versão 8.5.1 tem 24 operações, todas relativas a https://crypto-api.sentinexrisk.com/api/v1. Cada uma tem página própria, gerada a partir do contrato. O arquivo do contrato está em openapi.yaml e openapi.json.
Sobre o contrato
Seção intitulada “Sobre o contrato”Contrato público da integração de KYT (monitoramento de transações) da Sentinex Risk Crypto. Ele lista só as operações que a API de produção serve a uma integração autenticada por chave de API.
Autenticação
Seção intitulada “Autenticação”Toda operação deste contrato usa a chave de API da empresa no header
X-API-Key. A chave identifica a empresa e carrega os escopos; nenhum header
extra de empresa é necessário. Em produção, o grupo /vasp aceita apenas chave
do ambiente live. A chave é criada no painel, na área de desenvolvedores, por
um administrador da empresa.
Recomendação e decisão
Seção intitulada “Recomendação e decisão”POST /vasp/screenings devolve a recomendação ALLOW, REVIEW, HOLD ou
DENY, com o detalhamento do score e das regras acionadas. A decisão
operacional é do cliente e é registrada em
PATCH /vasp/screenings/{id}/client-decision.
Convenções da integração
Seção intitulada “Convenções da integração”Campos JSON usam snake_case. Enums de recomendação, ação e estado de
negócio usam caixa alta. Datas e horas usam RFC 3339 em UTC. amount
representa quantidade decimal do ativo; campos _brl representam reais,
não centavos; campos _ms representam milissegundos; scores KYT usam 0 a
100. Listagens /vasp usam limit, com default 50 e teto 200; alertas
paginam com offset (as leituras de ledger também, fora do contrato do
cliente KYT), e clientes com o cursor cursor_before, devolvido em
next_cursor. Depois da autenticação valem o limite da empresa, 2.000 por
minuto somando todas as chaves e usuários, e o limite por minuto da API key,
que usa 60 por minuto quando a credencial não define outro valor e é
informado por headers. O laudo KYT acrescenta 120 emissões por hora,
contadas por IP de origem. Rota inexistente sob /vasp, com chave válida,
responde 404 com error.code route_not_found.
info.version é a versão deste contrato do cliente. Ela é própria: não acompanha
a especificação interna nem os SDKs, e só sobe quando este contrato muda. A
política de versão e o changelog estão em
https://docs-crypto.sentinexrisk.com/concepts/versionamento-e-changelog/.
info.x-snx-congelamento diz em que fase a linha está. Com pre-integracao, ainda
não há integrador em produção, e uma operação que não serve ao produto KYT pode sair
do contrato, sempre com a operação nomeada no changelog. Quando o primeiro integrador
recebe a chave, o valor passa a congelado desde dd/mm/aaaa, e daí em diante a linha
só recebe mudança compatível.
Suporte
Seção intitulada “Suporte”Operações por grupo
Seção intitulada “Operações por grupo”VASP - Screening
Seção intitulada “VASP - Screening”Decisão KYT em tempo real (POST /vasp/screenings), consulta de decisões e feedback 2-way. Endpoint principal da integração.
| Operação | Resumo |
|---|---|
POST /vasp/screenings |
Recomendação de risco para transação em tempo real (KYT) |
GET /vasp/screenings/{id} |
Busca uma recomendação de screening anterior |
PATCH /vasp/screenings/{id}/decision (obsoleta) |
Registra a decisão do cliente pelo alias legado |
PATCH /vasp/screenings/{id}/client-decision |
Registra a decisão operacional pertencente ao cliente |
PATCH /vasp/screenings/{id}/tx-hash |
Anexa o hash da transação transmitida ao screening (pré-checagem em dois passos) |
POST /vasp/kyt-report |
Gera laudo KYT por API key |
VASP - Clientes
Seção intitulada “VASP - Clientes”Enrollment de clientes finais (PF/PJ) com identificadores pseudonimizados (SHA-256) e idempotência via Idempotency-Key.
| Operação | Resumo |
|---|---|
POST /vasp/customers |
Cadastra cliente final do VASP (PF ou PJ) |
GET /vasp/customers |
Lista clientes finais da empresa (paginação por cursor) |
POST /vasp/customers/search |
Busca clientes finais por identificador pseudonimizado |
GET /vasp/customers/{id} |
Busca cliente final por id |
POST /vasp/customers/batch |
Cadastra clientes finais do VASP em lote (até 1.000 por chamada) |
VASP - Carteiras
Seção intitulada “VASP - Carteiras”Enrollment de carteiras de clientes finais com screening fail-closed (sync ou async).
| Operação | Resumo |
|---|---|
POST /vasp/wallets |
Cadastra carteira de cliente final com screening fail-closed |
GET /vasp/wallets/{id} |
Consulta o enrollment e o status de screening de uma carteira |
DELETE /vasp/wallets/{id} |
Desativa a carteira (desativação lógica, o wallet_id continua válido) |
PATCH /vasp/wallets/{id} |
Reativa a carteira, reenvia o endereço ou declara a custódia |
VASP - Alertas
Seção intitulada “VASP - Alertas”Poll de alertas no escopo da empresa (complementa o webhook outbound).
| Operação | Resumo |
|---|---|
GET /vasp/alerts |
Lista alertas da empresa (poll server-to-server) |
VASP - Webhooks
Seção intitulada “VASP - Webhooks”Self-service de subscriptions de webhook outbound.
| Operação | Resumo |
|---|---|
POST /vasp/webhooks |
Cadastra subscription de webhook outbound |
GET /vasp/webhooks |
Lista subscriptions de webhook outbound da empresa |
POST /vasp/webhooks/{id}/test |
Enfileira um evento de teste para a subscription |
DELETE /vasp/webhooks/{id} |
Remove uma subscription de webhook outbound |
VASP - Compliance
Seção intitulada “VASP - Compliance”SARs pendentes (read-only) e relatórios DeCripto da empresa.
| Operação | Resumo |
|---|---|
GET /vasp/sars |
Lista SARs pendentes da empresa VASP |
GET /vasp/sars/{id} |
Busca detalhe de um SAR da empresa VASP |
GET /vasp/decripto/monthly |
Prepara artefato DeCripto mensal interno |
GET /vasp/decripto/annual |
Prepara artefato DeCripto anual interno |