Glossário
Know Your Transaction. Produto atual para analisar risco de operações e acompanhar alertas. Não executa a decisão financeira da exchange.
Know Your Customer, identificação e diligência sobre o cliente. O KYC próprio, /api/v1/kyc/* e eventos kyc.* estão indisponíveis no produto KYT atual. Cases B2B passam por gate com HTTP 403 PRODUCT_MODULE_DISABLED após autenticação e acesso da conta. Produto contratado e habilitado, módulos, escopos e configuração são requisitos separados, sem data prometida.
Know Your Business, diligência de pessoa jurídica. Também pertence à família de KYC próprio, fora do produto KYT atual.
VASP e PSAV
Seção intitulada “VASP e PSAV”Prestadora de serviços de ativos virtuais. A exchange integradora é responsável por sua decisão operacional e obrigações aplicáveis.
Organização cliente isolada. A API key identifica o tenant; ids de outro tenant não dão acesso ao recurso.
Screening
Seção intitulada “Screening”Análise de uma intenção ou operação. POST /api/v1/vasp/screenings cria a análise; GET por id consulta o snapshot.
Recomendação
Seção intitulada “Recomendação”Orientação auxiliar em data.recommendation: ALLOW, REVIEW, HOLD ou DENY. Não é execução de transferência nem decisão do cliente.
Nenhum sinal avaliado exigiu revisão ou bloqueio. Exige leitura da cobertura e dos controles próprios antes da decisão da exchange.
Recomendação de revisão humana por risco. Não é valor aceito em operational_action.
Retenção temporária por evidência incompleta ou indisponível. Deve ser tratada antes de nova análise; pode chegar com HTTP 200 e fail_closed true.
Recomendação de negar por base de sanção ou bloqueio configurado pelo tenant. Uma base válida prevalece sobre uma lacuna em outra evidência.
client_decision
Seção intitulada “client_decision”Registro do cliente em PATCH /vasp/screenings/{id}/client-decision. É imutável e separado da recomendação.
PENDING_CLIENT_DECISION e RECORDED
Seção intitulada “PENDING_CLIENT_DECISION e RECORDED”Estados da decisão do cliente: pendente ou registrada. Pendência não significa que o screening síncrono ainda está executando.
operational_action
Seção intitulada “operational_action”Ação da exchange: ALLOW, HOLD ou DENY. O registro não movimenta fundos nem altera saldo.
suspicion_outcome
Seção intitulada “suspicion_outcome”Conclusão de suspeição do cliente: SUSPICIOUS ou NOT_SUSPICIOUS. Precisa de fundamento próprio, não decorre automaticamente de score ou falha técnica.
rationale e authority
Seção intitulada “rationale e authority”Justificativa e autoridade da decisão. O servidor atribui CLIENT_EXCHANGE ao registro B2B.
Fail-closed
Seção intitulada “Fail-closed”Falha de evidência não libera a análise. Pode resultar em HOLD registrado com HTTP 200; falha que impede gravar a análise retorna erro HTTP.
risk_score e risk_level
Seção intitulada “risk_score e risk_level”Score entre 0 e 100 e faixa de risco. A recomendação também depende de cobertura e política, portanto score alto não é tabela direta para DENY.
score_ledger
Seção intitulada “score_ledger”Trilha do cálculo: base, itens, operações MAX, FLOOR e ADD, limites, quantização HALF_UP e valor final. Evita inferir score pela soma de pesos.
rule_hits
Seção intitulada “rule_hits”Regras acionadas, com rule_id, name, severity e weight. Não é lista de todas as regras avaliadas.
rule_id, severity e weight
Seção intitulada “rule_id, severity e weight”Identificador da regra, severidade do achado e peso declarado. Peso zero pode registrar lacuna, como agregado indisponível.
coverage
Seção intitulada “coverage”Snapshot de cobertura do motor, com versão, estado, regras avaliáveis, degradadas, desabilitadas e causas.
coverage.input_assessments
Seção intitulada “coverage.input_assessments”Medição por insumo, incluindo amount_brl, aggregate_7d, travel_rule e suspicion_policy quando sua leitura falha.
MEASURED
Seção intitulada “MEASURED”Dado medido, inclusive negativo ou zero. Não significa que toda a operação ou todas as dimensões foram medidas.
NOT_MEASURED
Seção intitulada “NOT_MEASURED”Dado não obtido ou dimensão não medida. Não substitua por zero, false, percentual ou lista vazia conclusiva.
NOT_EVALUATED
Seção intitulada “NOT_EVALUATED”Avaliação do insumo não executada, por exemplo agregado sem referência ou com política monetária desativada. Não é estado das cinco capabilities.
capabilities
Seção intitulada “capabilities”Cinco dimensões separadas: sanctions (sanções), labels (etiquetas), exposures (exposições), graph (grafo) e typologies (tipologias). Cada uma é MEASURED ou NOT_MEASURED.
sanctions.hit e sanctions.state
Seção intitulada “sanctions.hit e sanctions.state”Resultado da sanção da contraparte: hit null com NOT_MEASURED; false com MEASURED é negativo medido. Evidência verificada sustenta o hit positivo.
label_evidence e LABEL_ONLY
Seção intitulada “label_evidence e LABEL_ONLY”Evidência de etiqueta de bloqueio de emissor. Não é sanção e não fabrica exposição ou score.
direct_exposure e indirect_exposure
Seção intitulada “direct_exposure e indirect_exposure”Exposição direta e indireta por categoria. Ficam null quando exposures não foi medida.
not_covered
Seção intitulada “not_covered”Dimensões não analisadas por desenho. CAPABILITY_NOT_OFFERED indica capacidade não oferecida; NETWORK_NOT_COVERED indica rede fora de um feed. Pode coexistir com ALLOW sem provar negativo.
ACTIVE_READY, ACTIVE_DEGRADED e DISABLED
Seção intitulada “ACTIVE_READY, ACTIVE_DEGRADED e DISABLED”Estados da cobertura do motor: pronto para regras elegíveis, degradado por lacuna ou sem cobertura decisória ativa. Leia as listas e as causas junto do estado.
evaluable_rules, degraded_rules e disabled_rules
Seção intitulada “evaluable_rules, degraded_rules e disabled_rules”Regras aptas, regras com causa de degradação e regras fora da avaliação decisória. Disabled pode refletir inatividade, shadow ou inaplicabilidade.
REQUIRED_INPUT_MISSING, SOURCE_UNAVAILABLE e SOURCE_STALE
Seção intitulada “REQUIRED_INPUT_MISSING, SOURCE_UNAVAILABLE e SOURCE_STALE”Causas de degradação: insumo requerido ausente, fonte indisponível ou evidência vencida. MANIFEST_MISSING e ENGINE_UNAVAILABLE indicam falta de declaração ou motor indisponível.
Manifesto snx-rule-capabilities
Seção intitulada “Manifesto snx-rule-capabilities”Versão da declaração de fontes, insumos, frescor e pipelines por regra. Não confunda versão do manifesto com versão da API.
Pipeline
Seção intitulada “Pipeline”Caminho que alimenta o motor: wallet_screening para o POST B2B; transaction_analysis e kyc_orchestration são caminhos distintos. KYC orchestration depende do produto correspondente habilitado.
source, required_inputs e freshness_seconds
Seção intitulada “source, required_inputs e freshness_seconds”Fonte, insumos exigidos e frescor máximo da declaração. Frescor 0 não dispensa medição, apenas não define janela nessa declaração.
configured_state e readiness
Seção intitulada “configured_state e readiness”Estado configurado e requisito de prontidão do catálogo. runtime_evidence_required não é prova de capacidade medida.
Regras de alerta e Configuração de regras
Seção intitulada “Regras de alerta e Configuração de regras”Áreas logadas do catálogo e dos overrides por tenant. GET /api/v1/rules é do painel, sem acesso pela API key B2B.
Política de decisão KYT
Seção intitulada “Política de decisão KYT”Escolhas do tenant para bloqueio por score ou combinação e opções suportadas. Não remove sanção nem retenção por evidência incompleta.
Regras de monitoramento
Seção intitulada “Regras de monitoramento”Regras da varredura contínua, gerenciadas separadamente em /kyt/monitor-rules. Não são sinônimo das regras do screening pontual.
Shadow e shadow_mode
Seção intitulada “Shadow e shadow_mode”Observação sem efeito na decisão, quando há base real de avaliação. shadow_observations fica separado dos hits decisórios. Shadow global exige autoridade de plataforma.
tenantconfig
Seção intitulada “tenantconfig”Configuração runtime isolada por tenant. Política ausente é diferente de política inválida ou leitura indisponível.
screening.suspicion_policy
Seção intitulada “screening.suspicion_policy”Política monetária interna, com tenant_id, version, enabled, single_brl e aggregate_brl. Opt-in, padrão desligado, limiares 0; não cria piso legal de comunicação.
Score thresholds
Seção intitulada “Score thresholds”screening.score_monitor_threshold, screening.score_review_threshold, screening.score_block_threshold e screening.score_critical_threshold. Padrões 25, 50, 75 e 90; overrides só endurecem.
rules.holder_cross_policy
Seção intitulada “rules.holder_cross_policy”Parâmetros versionados do tenant para cruzamento de titular, capacidade financeira, PEP, relacionamento e validade de KYC. Ausência de parâmetro mantém regra dependente não medida.
customer_ref
Seção intitulada “customer_ref”Referência opaca enviada pelo integrador, protegida por HMAC versionado e isolado por tenant, por exemplo prefixo h:v1:. Não é o customer_id nem um eco em claro no screening.
customer_id e holder_resolution
Seção intitulada “customer_id e holder_resolution”UUID da matrícula do titular e sua resolução. RESOLVED confirma pertencimento ao tenant, não KYC enriquecido; NOT_FOUND cobre inexistente e outro tenant.
amount, amount_brl e declared_fiat_value_brl
Seção intitulada “amount, amount_brl e declared_fiat_value_brl”Quantidade do ativo, valor em reais medido pelo servidor e valor em reais declarado pelo integrador. O declarado não decide regras; o medido pode ser null.
aggregate_7d
Seção intitulada “aggregate_7d”Leitura do valor acumulado em sete dias, avaliada apenas com referência e limiar agregado ativo. Indisponível nessa condição não equivale a soma zero.
Idempotency-Key e replay
Seção intitulada “Idempotency-Key e replay”Chave da intenção de negócio. Nas operações suportadas, mesmos bytes e chave reconciliam o snapshot original, sem nova medição. KYT_IDEMPOTENCY_CONFLICT indica outro corpo; KYT_IDEMPOTENCY_IN_PROGRESS informa disputa em andamento.
Reprocessamento
Seção intitulada “Reprocessamento”Nova análise após corrigir a causa, com nova chave e vínculo rastreável com a anterior no sistema da exchange. GET e replay não reprocessam.
API key live, sand e test
Seção intitulada “API key live, sand e test”Ambientes da credencial. Produção aceita live; sandbox aceita sand. Test não é credencial de homologação da produção.
Escopo e RBAC
Seção intitulada “Escopo e RBAC”Escopo limita o que a API key pode fazer. RBAC limita ações da sessão humana no painel, junto com gates de produto, módulo e MFA.
Rate limit e Retry-After
Seção intitulada “Rate limit e Retry-After”Limites por chave, tenant, IP ou operação. HTTP 429 exige espera; Retry-After informa segundos quando presente. Contador indisponível pode retornar 503.
route_not_found
Seção intitulada “route_not_found”Código do HTTP 404 para método ou caminho inexistente sob /vasp após gates anteriores. Recurso de outro tenant também recebe 404 próprio, sem revelar existência.
Webhook, subscription e HMAC
Seção intitulada “Webhook, subscription e HMAC”Evento assinado enviado ao receptor HTTPS cadastrado. HMAC SHA-256 usa timestamp, ponto e bytes crus do corpo. O secret pertence ao integrador e não é ecoado.
event_id, delivery_id e attempt
Seção intitulada “event_id, delivery_id e attempt”Ids estáveis de evento e entrega, mais número da tentativa. Use o par de ids para deduplicar, não o corpo inteiro que muda em retry.
Retentativa, pausa e DLQ
Seção intitulada “Retentativa, pausa e DLQ”Nova tentativa após falha de entrega. Na subscription VASP há até dez tentativas; dez falhas consecutivas pausam o destino. Entrega dead fica para tratamento governado, sem replay pela API key.
Evento aceito e evento emitido
Seção intitulada “Evento aceito e evento emitido”Nome aceito na subscription não garante emissor. alert.escalated, customer.updated, customer.deleted e kyc.completed ainda não são emitidos; kyc.* está fora do KYT atual.
Alerta, sla_deadline e sla_breached
Seção intitulada “Alerta, sla_deadline e sla_breached”Item de investigação, prazo de fila e indicador de vencimento. Alertas do screening: CRITICAL em 1 hora e HIGH em 4 horas, sem inferir SLA do suporte.
COAF, SAR e ROS
Seção intitulada “COAF, SAR e ROS”Órgão e termos de comunicação de atividade ou operação suspeita. Alerta interno e decisão SUSPICIOUS não comprovam envio nem recebimento pelo órgão.
coaf_sar e coaf_objective
Seção intitulada “coaf_sar e coaf_objective”Campo legado MONITOR e prévia de obrigação objetiva. Prévia com final false e lacunas não é decisão jurídica final ou protocolo de comunicação.
Travel Rule
Seção intitulada “Travel Rule”Dados e obrigações de intercâmbio entre prestadoras. Declarar travel_rule na triagem não habilita transmissão no produto KYT; UNKNOWN não é dispensa legal.
DeCripto
Seção intitulada “DeCripto”Reporte regulatório fiscal relacionado a criptoativos. Leitura ou prévia técnica não comprova entrega aceita pela autoridade.
BCB, AML, PEP e LGPD
Seção intitulada “BCB, AML, PEP e LGPD”Banco Central do Brasil, prevenção à lavagem de dinheiro, pessoa exposta politicamente e Lei Geral de Proteção de Dados. PEP exige diligência, não é sinônimo de sanção.
MFA, JWT e X-Request-ID
Seção intitulada “MFA, JWT e X-Request-ID”Autenticação adicional, token da sessão humana e correlação da chamada HTTP. Guarde o request id sem credenciais ou PII ao acionar suporte.
Veja Como as regras decidem e Dúvidas frequentes para exemplos.