POST /vasp/webhooks

Cadastra subscription de webhook outbound

Permite que a empresa VASP, autenticado por API-key, cadastre uma URL HTTPS pública para receber eventos outbound da Sentinex Risk Crypto. O cliente gera o secret HMAC, envia no corpo e o servidor nunca o ecoa.

Cada entrega traz no header X-Sentinex-Event-Type um dos eventos assinados, ou webhook.test quando disparada por POST /vasp/webhooks/{id}/test. webhook.test não pode ser assinado em events.

Situação de cada evento aceito em events, numa integração de KYT:

Evento	Situação
customer.created	emitido
customer.updated	aceito na assinatura, ainda não emitido
customer.deleted	aceito na assinatura, ainda não emitido
wallet.linked	emitido
wallet.deactivated	emitido
kyc.completed	aceito na assinatura, ainda não emitido
kyc.provider_status_changed	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.provider_decision_conflict	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.provider_evidence_refreshed	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.assessment_finalized	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.decision_proposal_created	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.decision_approval_recorded	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.decision_finalized	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.rekyc_scheduled	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.rekyc_started	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.rekyc_failed	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.partner_admitted	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.partner_relationship_ended	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.actor_invitation.expired	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyc.actor_invitation.reminder_rotated	aceito na assinatura; emitido só pelo produto de KYC, não numa integração de KYT
kyt.screening.completed	emitido
kyt.screening.sanction_hit	emitido
kyt.case.client_decision.recorded	emitido
alert.created	emitido
alert.escalated	emitido
alert.resolved	emitido

Item	Valor
Método	POST
Caminho	/vasp/webhooks
URL	https://crypto-api.sentinexrisk.com/api/v1/vasp/webhooks
Grupo	VASP - Webhooks
operationId	createVASPWebhookSubscription
Versão do contrato	8.5.1

Autenticação

Chave de API do tenant no header X-API-Key (esquema ApiKeyAuth). A chave identifica o tenant e carrega os escopos; não existe header de tenant. Detalhes em Autenticação.

Parâmetros

Esta operação não declara parâmetros.

Corpo da requisição

Corpo obrigatório.

Tipo de mídia application/json.

Tipo objeto.

Campo	Tipo	Obrigatório	Descrição
target_url	string (uri)	sim	URL HTTPS pública que receberá os eventos. Formato (expressão regular): ^https://. Exemplo: https://vasp.example/webhooks/sentinex.
events	lista de string	não	Lista de eventos. Array vazio assina todos. A situação de cada evento (emitido, ou aceito na assinatura e ainda não emitido numa integração de KYT) está na tabela da descrição da operação.
description	string	não	Descrição operacional da subscription.
secret	string	sim	De 32 a 128 caracteres. Só de escrita: a API nunca devolve este campo.

Exemplo de chamada

curl -X POST "https://crypto-api.sentinexrisk.com/api/v1/vasp/webhooks" \
  -H "X-API-Key: $SENTINEX_API_KEY" \
  -H "Content-Type: application/json" \
  -d @corpo.json

O arquivo corpo.json segue o schema do corpo acima.

Respostas de sucesso

Status	Descrição
201	Subscription criada sem ecoar o secret HMAC

201

Subscription criada sem ecoar o secret HMAC

Tipo de mídia application/json.

Tipo objeto.

Campo	Tipo	Obrigatório	Descrição
success	boolean	não
id	string (uuid)	não
target_url	string (uri)	não
events	lista de string	não

Códigos de erro declarados

Estes são os códigos que o contrato declara para esta operação. Os limites que valem para toda a API, antes da autenticação, estão em Limites de requisição.

Status	Descrição
400	Corpo ilegível, target_url ausente ou não HTTPS, secret fora de 32 a 128 bytes ou evento inválido.
401	A chave de API não autenticou a requisição, e nenhuma camada adiante rodou. error.code é missing_api_key (nenhuma chave em X-API-Key nem em Authorization: Bearer snxc_...) ou invalid_api_key (chave desconhecida, revogada ou expirada). Quando a plataforma não consegue verificar a chave, a resposta é 503 com api_key_verification_unavailable, e não 401: repita com backoff.
402	Conta sem direito comercial (TRIAL_EXPIRED): trial vencido, trial sem data ou empresa sem contrato. A requisição NÃO foi processada; uma triagem recusada assim é transação não triada, nunca aprovada.
403	Acesso recusado antes da operação, nesta ordem de camadas: o escudo de borda recusa travessia de diretório na URL (ErroTexto); a chave é recusada pelo IP de origem (api_key_ip_not_allowed); o ambiente da chave não é aceito por esta implantação (api_key_environment_required ou api_key_environment_not_allowed); a conta não pode usar a API (TenantAccessRefusalResponse: empresa_SUSPENDED, empresa_NOT_OPERATIONAL, API_ACCESS_DISABLED ou empresa_ACCESS_DENIED); a chave não tem o escopo da rota (insufficient_scope, com o escopo na mensagem). Não repita sem corrigir a causa.
404	Com chave válida, o caminho ou o método não corresponde a operação servida por esta implantação (error.code route_not_found). Confira método, caminho e o prefixo /api/v1.
413	Corpo acima de 1 MiB, recusado pelo escudo de borda antes da autenticação (code BODY_TOO_LARGE). Nada foi processado.
429	Limite de requisições atingido; nada foi processado. Formas, pela camada que recusou: limite da chave (ErrorResponseCoded, api_key_rate_limit_exceeded, 60 por minuto quando a chave não define outro valor, Retry-After: 60); limite global por hora (ErroLimite, retry_after 3600 e Retry-After: 3600); escudo de borda por IP (ErroLimite: RATE_LIMIT_HARD acima de 1.000 por minuto, com 300 segundos; IP_BANNED no bloqueio temporário; e a rajada com intervalo menor que 50 ms, que vem sem Retry-After e sem retry_after). A busca de clientes tem limite próprio (error rate_limited, com retry_after e detail) e o laudo também (error RATE_LIMIT_EXCEEDED, 120 por hora por IP, Retry-After: 3600). No sandbox, chamadas VASP autenticadas também usam sandbox_simulator_rate_limit_exceeded: 60 por minuto por key, 300 por minuto por empresa e 10.000 por dia UTC por empresa. Essa recusa inclui Retry-After, X-RateLimit-Limit e X-RateLimit-Remaining: 0. Espere o Retry-After quando ele vier.
500	Falha inesperada. A mensagem é genérica de propósito; guarde o X-Request-ID da resposta para o suporte e repita com espera.
503	Webhooks de saída indisponíveis ou cofre do segredo indisponível. As camadas anteriores à operação também respondem 503, nada processado: limitador por IP ou da empresa sem contagem (ErroTexto), estado da conta (empresa_ACCESS_STATE_UNAVAILABLE) e limitador da chave (rate_limit_unavailable) e verificação da chave (api_key_verification_unavailable).

400

Corpo ilegível, target_url ausente ou não HTTPS, secret fora de 32 a 128 bytes ou evento inválido.

Tipo de mídia application/json.

Schema ErroTexto, do tipo objeto.

Envelope de erro com a mensagem em texto no campo error, sem código. É o formato dos handlers de cadastro, carteira, webhooks, ledger e leituras regulatórias, da recuperação de falha inesperada (500), da indisponibilidade das camadas de borda (503) e da recusa do escudo de borda por padrão de ataque (403). Ramifique pelo status HTTP; a mensagem é texto livre e pode mudar.

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Valores: false.
error	string	sim	Exemplo: Carteira não encontrada..

401

A chave de API não autenticou a requisição, e nenhuma camada adiante rodou. error.code é missing_api_key (nenhuma chave em X-API-Key nem em Authorization: Bearer snxc_...) ou invalid_api_key (chave desconhecida, revogada ou expirada). Quando a plataforma não consegue verificar a chave, a resposta é 503 com api_key_verification_unavailable, e não 401: repita com backoff.

Resposta compartilhada ErroChaveNaoAutenticada do contrato.

Tipo de mídia application/json.

Schema ErrorResponseCoded, do tipo objeto.

Envelope de erro codificado (middlewares de API key e erros de negócio da superfície VASP). Trate error.code como contrato estável; error.message é texto livre.

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Exemplo: false.
error	objeto	sim
error.code	string	sim	Exemplo: missing_api_key.
error.message	string	sim	Exemplo: X-API-Key header required.

402

Conta sem direito comercial (TRIAL_EXPIRED): trial vencido, trial sem data ou empresa sem contrato. A requisição NÃO foi processada; uma triagem recusada assim é transação não triada, nunca aprovada.

Resposta compartilhada TenantAccessPaymentRequired do contrato.

Tipo de mídia application/json.

Schema TenantAccessRefusalResponse, do tipo objeto.

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Valores: false.
error	string	sim	Exemplo: Seu período de teste terminou. Fale com a Sentinex Risk para estender o teste ou contratar um plano..
code	string	sim	Valores: TRIAL_EXPIRED, TENANT_SUSPENDED, TENANT_NOT_OPERATIONAL, API_ACCESS_DISABLED, TENANT_ACCESS_DENIED, TENANT_ACCESS_STATE_UNAVAILABLE.
details	objeto	não
details.reason	string	não	Presente em TRIAL_EXPIRED. Valores: TRIAL_WITHOUT_END_DATE, TRIAL_ENDED, POC_TRIAL_RETIRED, DEMO_WITHOUT_COMMERCIAL_ACCESS, NO_COMMERCIAL_ACCESS.
details.trial_ends_at	string (date-time)	não	Presente em TRIAL_EXPIRED quando o trial tem data.
details.lifecycle_state	string	não	Presente em empresa_NOT_OPERATIONAL.

403

Acesso recusado antes da operação, nesta ordem de camadas: o escudo de borda recusa travessia de diretório na URL (ErroTexto); a chave é recusada pelo IP de origem (api_key_ip_not_allowed); o ambiente da chave não é aceito por esta implantação (api_key_environment_required ou api_key_environment_not_allowed); a conta não pode usar a API (TenantAccessRefusalResponse: empresa_SUSPENDED, empresa_NOT_OPERATIONAL, API_ACCESS_DISABLED ou empresa_ACCESS_DENIED); a chave não tem o escopo da rota (insufficient_scope, com o escopo na mensagem). Não repita sem corrigir a causa.

Resposta compartilhada ErroAcessoNegado do contrato.

Tipo de mídia application/json.

Tipo um de: ErrorResponseCoded, TenantAccessRefusalResponse, ErroTexto.

Alternativa do corpo: ErrorResponseCoded

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Exemplo: false.
error	objeto	sim
error.code	string	sim	Exemplo: missing_api_key.
error.message	string	sim	Exemplo: X-API-Key header required.

Alternativa do corpo: TenantAccessRefusalResponse

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Valores: false.
error	string	sim	Exemplo: Seu período de teste terminou. Fale com a Sentinex Risk para estender o teste ou contratar um plano..
code	string	sim	Valores: TRIAL_EXPIRED, TENANT_SUSPENDED, TENANT_NOT_OPERATIONAL, API_ACCESS_DISABLED, TENANT_ACCESS_DENIED, TENANT_ACCESS_STATE_UNAVAILABLE.
details	objeto	não
details.reason	string	não	Presente em TRIAL_EXPIRED. Valores: TRIAL_WITHOUT_END_DATE, TRIAL_ENDED, POC_TRIAL_RETIRED, DEMO_WITHOUT_COMMERCIAL_ACCESS, NO_COMMERCIAL_ACCESS.
details.trial_ends_at	string (date-time)	não	Presente em TRIAL_EXPIRED quando o trial tem data.
details.lifecycle_state	string	não	Presente em empresa_NOT_OPERATIONAL.

Alternativa do corpo: ErroTexto

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Valores: false.
error	string	sim	Exemplo: Carteira não encontrada..

404

Com chave válida, o caminho ou o método não corresponde a operação servida por esta implantação (error.code route_not_found). Confira método, caminho e o prefixo /api/v1.

Resposta compartilhada ErroRotaNaoEncontrada do contrato.

Tipo de mídia application/json.

Schema ErrorResponseCoded, do tipo objeto.

Envelope de erro codificado (middlewares de API key e erros de negócio da superfície VASP). Trate error.code como contrato estável; error.message é texto livre.

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Exemplo: false.
error	objeto	sim
error.code	string	sim	Exemplo: missing_api_key.
error.message	string	sim	Exemplo: X-API-Key header required.

413

Corpo acima de 1 MiB, recusado pelo escudo de borda antes da autenticação (code BODY_TOO_LARGE). Nada foi processado.

Resposta compartilhada ErroCorpoAcimaDoLimite do contrato.

Tipo de mídia application/json.

Schema ErroTextoComCodigo, do tipo objeto.

Envelope de erro com a mensagem em texto em error e o código estável em code, na raiz do corpo. Na API de KYT aparece no corpo acima de 1 MiB (BODY_TOO_LARGE, 413) e na leitura do módulo contratado que não pôde ser feita (MODULE_STORE_UNAVAILABLE, 503).

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Valores: false.
error	string	sim
code	string	sim	Exemplo: BODY_TOO_LARGE.

429

Limite de requisições atingido; nada foi processado. Formas, pela camada que recusou: limite da chave (ErrorResponseCoded, api_key_rate_limit_exceeded, 60 por minuto quando a chave não define outro valor, Retry-After: 60); limite global por hora (ErroLimite, retry_after 3600 e Retry-After: 3600); escudo de borda por IP (ErroLimite: RATE_LIMIT_HARD acima de 1.000 por minuto, com 300 segundos; IP_BANNED no bloqueio temporário; e a rajada com intervalo menor que 50 ms, que vem sem Retry-After e sem retry_after). A busca de clientes tem limite próprio (error rate_limited, com retry_after e detail) e o laudo também (error RATE_LIMIT_EXCEEDED, 120 por hora por IP, Retry-After: 3600). No sandbox, chamadas VASP autenticadas também usam sandbox_simulator_rate_limit_exceeded: 60 por minuto por key, 300 por minuto por empresa e 10.000 por dia UTC por empresa. Essa recusa inclui Retry-After, X-RateLimit-Limit e X-RateLimit-Remaining: 0. Espere o Retry-After quando ele vier.

Resposta compartilhada ErroLimiteDeRequisicoes do contrato.

Header	Tipo	Descrição
Retry-After	integer	Segundos a esperar antes de repetir. Vem nos 429 dos limitadores (salvo a rajada do escudo) e no 503 de transação que conflitou (1 segundo).
X-RateLimit-Limit	integer	Teto da janela do limitador que respondeu, quando ele informa.
X-RateLimit-Remaining	integer	Requisições restantes na janela, quando o limitador informa.

Tipo de mídia application/json.

Tipo um de: ErrorResponseCoded, ErroLimite.

Alternativa do corpo: ErrorResponseCoded

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Exemplo: false.
error	objeto	sim
error.code	string	sim	Exemplo: missing_api_key.
error.message	string	sim	Exemplo: X-API-Key header required.

Alternativa do corpo: ErroLimite

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Valores: false.
error	string	sim	Exemplo: Too many requests. Please try again later..
retry_after	integer	não	Mínimo: 1. Exemplo: 3600.
code	string	não	Exemplo: RATE_LIMIT_HARD.
reference	string	não	Identificador curto do bloqueio, para citar ao suporte.
detail	string	não

500

Falha inesperada. A mensagem é genérica de propósito; guarde o X-Request-ID da resposta para o suporte e repita com espera.

Resposta compartilhada ErroInterno do contrato.

Tipo de mídia application/json.

Schema ErroTexto, do tipo objeto.

Envelope de erro com a mensagem em texto no campo error, sem código. É o formato dos handlers de cadastro, carteira, webhooks, ledger e leituras regulatórias, da recuperação de falha inesperada (500), da indisponibilidade das camadas de borda (503) e da recusa do escudo de borda por padrão de ataque (403). Ramifique pelo status HTTP; a mensagem é texto livre e pode mudar.

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Valores: false.
error	string	sim	Exemplo: Carteira não encontrada..

503

Webhooks de saída indisponíveis ou cofre do segredo indisponível. As camadas anteriores à operação também respondem 503, nada processado: limitador por IP ou da empresa sem contagem (ErroTexto), estado da conta (empresa_ACCESS_STATE_UNAVAILABLE) e limitador da chave (rate_limit_unavailable) e verificação da chave (api_key_verification_unavailable).

Header	Tipo	Descrição
Retry-After	integer	Segundos a esperar antes de repetir. Vem nos 429 dos limitadores (salvo a rajada do escudo) e no 503 de transação que conflitou (1 segundo).

Tipo de mídia application/json.

Tipo um de: ErroTexto, TenantAccessRefusalResponse, ErrorResponseCoded.

Alternativa do corpo: ErroTexto

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Valores: false.
error	string	sim	Exemplo: Carteira não encontrada..

Alternativa do corpo: TenantAccessRefusalResponse

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Valores: false.
error	string	sim	Exemplo: Seu período de teste terminou. Fale com a Sentinex Risk para estender o teste ou contratar um plano..
code	string	sim	Valores: TRIAL_EXPIRED, TENANT_SUSPENDED, TENANT_NOT_OPERATIONAL, API_ACCESS_DISABLED, TENANT_ACCESS_DENIED, TENANT_ACCESS_STATE_UNAVAILABLE.
details	objeto	não
details.reason	string	não	Presente em TRIAL_EXPIRED. Valores: TRIAL_WITHOUT_END_DATE, TRIAL_ENDED, POC_TRIAL_RETIRED, DEMO_WITHOUT_COMMERCIAL_ACCESS, NO_COMMERCIAL_ACCESS.
details.trial_ends_at	string (date-time)	não	Presente em TRIAL_EXPIRED quando o trial tem data.
details.lifecycle_state	string	não	Presente em empresa_NOT_OPERATIONAL.

Alternativa do corpo: ErrorResponseCoded

Campo	Tipo	Obrigatório	Descrição
success	boolean	sim	Exemplo: false.
error	objeto	sim
error.code	string	sim	Exemplo: missing_api_key.
error.message	string	sim	Exemplo: X-API-Key header required.