Receba eventos de recebimento, mudanças do cadastro, KYC, termos e habilitações.
Cadastrar e testar
Seu backend expõe uma URL pública HTTPS e cadastra POST /v1/webhooks com sua chave Everbridge e Idempotency-Key. Use o escopo webhooks:write para configurar e webhooks:read para consultar. São permissões específicas: uma chave antiga não as recebe automaticamente. O destino pertence à organização, compartilhado entre suas chaves autorizadas, e recebe os pagamentos de seus clientes finais.
Guarde o id do endpoint e o signing_secret retornado. O segredo é próprio do webhook, separado da chave de API, e não aparece nas consultas. Repetir a mesma intenção com a mesma chave de idempotência recupera o resultado original. Há limite de cinco endpoints. Não inclua segredos na URL; eles podem aparecer no histórico de configuração.
Implemente a validação de assinatura e envie POST /v1/webhooks/{id}/test com {}. O teste tem event_type=webhook.test, test=true e nenhum pagamento. Não gere crédito com testes. Consulte GET /v1/webhooks/{id}/deliveries para confirmar a entrega.
Categorias disponíveis
As cinco categorias abaixo podem compartilhar o mesmo endpoint e o mesmo segredo de assinatura. Consulte GET /v1/webhooks/{id} para conferir a seleção atual; uma categoria disponível na API só é entregue quando está incluída em event_categories nesse endpoint.
Categoria
Informação principal
virtual_account.activity
Etapas do depósito na conta virtual, em event_object.type.
transfer
Mudanças da transferência, com estado em event_object.state.
wallet.activity
Atividades da wallet, incluindo depósitos cripto; a origem fica em event_object.source.from_address, quando disponível.
customer
Estado do cadastro, aceite dos termos e habilitações resumidas.
kyc_link
Estados do KYC e dos termos associados ao link.
Novos endpoints sem seleção explícita incluem as três categorias de pagamentos. customer e kyc_link exigem seleção explícita. Endpoints existentes preservam sua configuração.
Clientes, KYC, termos e habilitações
Selecione customer e kyc_link em event_categories para receber mudanças de cadastro no mesmo endpoint de pagamentos, usando a mesma assinatura HMAC. Elas não são adicionadas automaticamente a assinaturas antigas. Para receber todas as cinco categorias, use PATCH /v1/webhooks/{id} com uma nova Idempotency-Key:
A lista substitui a seleção anterior: inclua todas as categorias que deseja manter. URL, status ativo/pausado, signing_secret e secret_version permanecem iguais. Não é necessário trocar a chave da API ou chamar rotate-secret. Para gerenciar pela API, a chave precisa de webhooks:write; para consultar configurações e entregas, webhooks:read. Um 403 insufficient_scope deve ser tratado com a equipe responsável pela sua chave, preservando o endpoint existente.
Na categoria customer, event_object.id é o customer_id. Leia status, has_accepted_terms_of_service e endorsements[].name/status. Tipos de evento incluem customer.created, customer.updated, customer.updated.status_transitioned e customer.deleted. Uma habilitação pode mudar em customer.updated mesmo com cadastro já ativo; não filtre apenas transições de status.
Na categoria kyc_link, event_object.id identifica o link e customer_id relaciona o titular, quando disponível. Leia kyc_status e tos_status. Tipos incluem kyc_link.created, kyc_link.updated e kyc_link.updated.status_transitioned.
Para avisar o lojista que a verificação foi aprovada, use kyc_status: "approved". Para liberar uma operação financeira, confira também o customer active, o aceite dos termos e a habilitação da rota approved. Início ou envio de documentos não significa aprovação. Eventos podem chegar repetidos ou fora de ordem: deduplique por event_id e confirme o estado atual por GET antes de liberar serviços ou regredir um cadastro. Um evento de exclusão não representa aprovação. O feed /v1/events continua disponível para recuperação.
Essas notificações levam IDs, estados e habilitações resumidas. Não contêm nome, e-mail, CPF, endereço, fotos, documentos, selfie, URLs de KYC/termos, motivos internos ou o dossiê completo. Campos adicionais podem faltar conforme o evento; para requisitos e pendências, consulte o cadastro autorizado pela API. As novas categorias recebem somente eventos gravados após sua ativação; não há reenvio automático de histórico.
Qual evento libera a antecipação?
Para um Pix na conta virtual, filtre event_category=virtual_account.activity e event_object.type=funds_received. O evento é enviado assim que chega à Everbridge e entra na fila de entrega; não aguarda conversão ou payment_processed. A latência depende da confirmação do pagamento, da chegada do evento e da disponibilidade do seu endpoint; não existe garantia de aviso no exato instante em que o pagador confirma o Pix.
event_type descreve a criação ou atualização do evento; a etapa financeira da conta virtual fica em event_object.type. Em transferências (event_category=transfer), consulte event_object.state. O mesmo webhook recebe etapas posteriores e devoluções. Campos e estados adicionais podem surgir; preserve desconhecidos para conciliação, sem tratá-los como sucesso.
funds_received confirma recebimento, não liquidação final nem irreversibilidade. Liberar crédito nessa etapa é uma política de antecipação da sua plataforma. Trate eventos de revisão, falha e devolução, inclusive após o recebimento. payment_processed confirma processamento ao destino.
Creditar o valor correto uma única vez
Valide assinatura e horário, e rejeite teste ou ambiente incompatível.
Associe customer_id e virtual_account_id ao cliente da sua plataforma. Não identifique o pagador apenas pelo valor.
No recebimento Pix, confira amount e currency=brl. Preserve strings decimais; use centavos inteiros ou uma biblioteca decimal. R$ 90 recebidos em uma cobrança de R$ 100 permitem contabilizar R$ 90, deixando R$ 10 pendentes. Não use o valor esperado da cobrança.
Se faltarem valor, moeda de entrada ou deposit_id, mantenha pendente e reconcilie pelo histórico. Não estime BRL usando o montante convertido. Em transferências, amount pode representar o valor solicitado; valide o recebimento real no recurso e comprovante antes de creditar.
Em uma transação do seu banco, persista o evento com unicidade por event_id. Faça o lançamento com unicidade por organização + conta virtual + deposit_id. Atualizações, retentativas e payment_processed do mesmo depósito não geram um segundo crédito.
Responda 2xx após gravar de forma durável. Se o processamento for assíncrono, confirme somente depois de persistir o evento na sua fila. Uma resposta duplicada válida também deve ser 2xx.
Não há ordem garantida entre eventos. Um recebimento entregue com atraso não deve reabrir crédito de um depósito já devolvido. Consulte o histórico quando houver conflito e preserve os estágios separados do lançamento contábil. O webhook não cria sua cobrança e não informa que alguém “não pagou”; sua aplicação compara recebimentos e vencimentos.
Depósitos cripto em wallet de tesouraria
Assine wallet.activity para receber as atividades das wallets vinculadas à sua organização. event_object.wallet_id identifica a wallet que recebeu a atividade. Uma entrada direta on-chain usa type=direct_deposit; outras entradas podem usar deposit. Saídas e devoluções são atividades diferentes: não credite qualquer evento desta categoria.
O endereço remetente fica em event_object.source.from_address. O indicador source_address_status será available ou unavailable; na ausência de evidência, from_address será null. Para depósitos vinculados a uma transferência da própria organização, a Everbridge busca a origem na transferência quando ela falta na atividade. Se essa consulta falhar, a entrega é tentada novamente. Quando resolvido, o conteúdo é persistido para as retentativas. Não inventamos endereço com base no saldo nem usamos o endereço de destino como se fosse remetente.
source.wallet_id pode identificar a wallet remetente quando ela é um recurso da mesma organização. Em depósitos de wallets externas esse ID pode não existir. destination.tx_hash e payment_route.transfer_id são referências de conciliação quando fornecidas. A rede é informada nos dados da rota quando disponível; payment_rail=wallet é uma modalidade de carteira, não o nome de uma blockchain. Para a rede da wallet, consulte o recurso e seu campo chain.
Endereço remetente não garante identidade de usuário. Exchanges, contratos e wallets compartilhadas podem originar pagamentos de várias pessoas pelo mesmo endereço. Vincule endereços previamente verificados no seu sistema e mantenha origens desconhecidas ou ambíguas em conciliação. Depósito on-chain não torna qualquer rede ou token suportado.
Deduplique notificações por event_id e lançamentos por wallet_id + event_object.id. Criação e atualização da mesma atividade podem ter event_id diferentes. A atividade de wallet e os eventos de transfer/conta virtual podem representar o mesmo dinheiro: cruze payment_route e não faça crédito duplo. available_balance é o saldo informado nessa atividade, não o valor novo do depósito nem a soma dos recebimentos.
Confirme valor, currency, tipo, wallet e situação atual antes de liberar saldo. Para recuperar dados, use GET /v1/wallets/{id}/history ou GET /v1/customers/{customer_id}/wallets/{id}/history, com wallets:read. O histórico usa data e paginação por starting_after/ending_before; o feed mantém os dados originais disponíveis e o webhook pode complementar a origem pela transferência. O endereço pode não estar disponível em todas as rotas, especialmente entradas originalmente em fiat.
Habilitar em um webhook existente
Endpoints anteriores não são alterados automaticamente. Consulte GET /v1/webhooks/{id} e envie PATCH /v1/webhooks/{id}, com uma nova Idempotency-Key e a lista completa de categorias desejadas. O exemplo abaixo inclui wallet.activity e mantém os eventos de pagamentos, cadastro e KYC. A lista substitui a seleção atual e preserva URL, signing_secret, secret_version e estado active:
Após o PATCH, consulte o endpoint novamente e confirme wallet.activity na seleção. Novos endpoints sem event_categories incluem as três categorias de pagamentos. A categoria acrescentada recebe somente eventos gravados depois da ativação; não há reenvio automático das atividades antigas. Prepare seu receptor para reconhecer wallet.activity e sua política de crédito antes de ativá-la.
Validar a assinatura
Enviamos X-Everbridge-Signature: t=TIMESTAMP,v1=HEX, calculado com HMAC-SHA256 sobre TIMESTAMP + "." + corpo_original, usando signing_secret como string UTF-8. O timestamp está em segundos Unix. Use comparação em tempo constante e tolerância de cinco minutos, com relógio sincronizado. A assinatura e o timestamp são recalculados a cada tentativa; não faça JSON.parse/stringify antes de verificar.
import { createHmac, timingSafeEqual } from 'node:crypto';
// rawBody precisa ser o Buffer original, antes de JSON.parse().
// secrets contém o segredo atual e, durante rotação, o anterior.
export function verifyEverbridge(rawBody, header, secrets, now = Date.now()) {
if (!Buffer.isBuffer(rawBody) || typeof header !== 'string') return false;
const match = /^t=(\d{10}),v1=([a-f0-9]{64})$/.exec(header);
if (!match || Math.abs(now / 1000 - Number(match[1])) > 300) return false;
const received = Buffer.from(match[2], 'hex');
return secrets.some(secret => {
const expected = createHmac('sha256', secret)
.update(match[1] + '.').update(rawBody).digest();
return timingSafeEqual(received, expected);
});
}
Outros cabeçalhos: X-Everbridge-Delivery-Id, X-Everbridge-Event-Id e X-Everbridge-Secret-Version. O corpo assinado é a fonte confiável do evento; esses cabeçalhos servem para rastreio e escolha do segredo. POST /v1/webhooks/{id}/rotate-secret gera nova versão. Novas tentativas usam o novo segredo; mantenha o anterior temporariamente para entregas que já estavam em voo.
Fila, retentativas e recuperação
Eventos são persistidos antes da confirmação de recebimento. A fila retoma após reinícios. Cada entrega tem até oito tentativas automáticas. Após falhas, os intervalos são 10 segundos, 30 segundos, 2 minutos, 10 minutos, 30 minutos, 2 horas e 6 horas, contados após cada tentativa. Respostas fora de 200–299, redirecionamentos, falhas de conexão ou timeout geram nova tentativa. O limite da chamada HTTPS é 10 segundos, além de até 3 segundos para DNS. Responda rapidamente.
A entrega é ao menos uma vez dentro desse ciclo, com possibilidade de duplicatas, e não garante sucesso se seu endpoint permanecer indisponível. Após esgotar tentativas, o estado é failed. Corrija o receptor e use POST /v1/webhooks/{id}/deliveries/{delivery}/retry para abrir novo ciclo com os mesmos IDs e conteúdo. Os estados pending, delivering, retrying, delivered, failed e canceled descrevem a entrega HTTP, não o pagamento.
Pause com PATCH /v1/webhooks/{id} e {"active":false}; a fila fica guardada e continua acumulando eventos. Reativar retoma pendências. A suspensão da organização também interrompe novos envios. Excluir cancela pendências. Entregas em voo podem terminar. A URL não é editável: cadastre outro endpoint para trocar o destino. Para editar categorias, use PATCH no endpoint com event_categories; a lista substitui a seleção atual. Novas categorias começam nos eventos gravados após a ativação, sem backfill. Entregas já enfileiradas são preservadas. Mantenha a deduplicação durante mudanças de assinatura.
O cadastro recebe eventos novos, sem backfill automático. Eventos inicialmente sem vínculo só são encaminhados após identificar sua organização. Use GET /v1/events e o histórico da conta como recuperação e conciliação, deduplicando entre todas as fontes. As consultas de entregas começam pelas mais recentes e paginam com before=next_cursor.
GUIAS DE INTEGRAÇÃO
KYC com a interface Everbridge ou via API
Reaproveite dados do seu cadastro, envie documentos e acompanhe a análise.
Interface Everbridge
Seu backend cria POST /v1/kyc_sessions com type e, opcionalmente, prefill e endorsements. O Pix é incluído no envio; outras habilitações solicitadas são preservadas. Envie ao titular a url retornada. O formulário guia o titular por telas curtas: dados pessoais ou empresariais, atividade, documentos, selfie quando aplicável e aceite dos termos. Uma barra discreta indica cinco etapas, com perguntas e documentos apresentados conforme o perfil. A chave da organização nunca deve ir ao navegador. Campos obrigatórios são marcados com asterisco e validados em cada etapa; documentos incompletos e ausência de selfie impedem o avanço. Campos opcionais e exigências condicionais são identificados no formulário.
O link permite atuar somente naquele cadastro por 24 horas. Revogar a chave que o criou ou suspender a organização também bloqueia o acesso. Para continuar um cadastro existente, informe customer_id ao criar outra sessão. Uma nova sessão sem esse ID representa uma intenção de criar outro cadastro: reutilize a sessão ou preserve o vínculo existente.
Quando o cadastro é criado?
Para um novo usuário, POST /v1/kyc_sessions cria somente uma sessão de pré-cadastro vinculada à organização autenticada. O prefill preenche o formulário, mas ainda não envia o perfil para análise. Por isso a resposta inicial contém customer_id: null.
Seu backend gera a sessão e envia a URL ao titular.
O titular preenche os dados, adiciona documentos e conclui o aceite dos termos.
Ao clicar em Enviar para análise, a Everbridge solicita a criação do customer com esses dados.
Após a resposta de criação, a sessão recebe seu customer_id. Consulte GET /v1/kyc_sessions/{id} para obtê-lo e acompanhar o cadastro.
Uma sessão ainda não enviada não representa KYC aprovado, em análise ou customer já criado. Se ocorrer uma resposta incerta, confirme o último envio; não crie outra sessão para duplicar o cadastro. Para continuar um customer existente, informe seu customer_id ao gerar a sessão.
Sua própria interface
Solicite POST /v1/customers/tos_links com corpo vazio e encaminhe o titular ao aceite legítimo. O retorno do fluxo fornece signed_agreement_id.
Envie POST /v1/customers com o perfil, esse aceite e as evidências. O Pix é solicitado por padrão; a aprovação depende da elegibilidade.
Salve customer_id e consulte GET /v1/customers/{customer}. Aceite de termos, envio de selfie ou resposta HTTP 2xx não significam aprovação.
Envie pendências com PUT /v1/customers/{customer}. Para sócios e representantes, use as rotas /associated_persons do mesmo cliente. Após a criação, não atualize representantes pelo PUT do cliente.
Como enviar a selfie
liveness_check_selfies recebe uma lista de objetos com image. O conteúdo é uma imagem em data URI Base64, por exemplo data:image/jpeg;base64,...; não é um vídeo. A interface Everbridge usa a câmera para capturar uma foto, sem áudio ou gravação de vídeo. A evidência é enviada para a análise de identidade e presença. Não trate a captura da foto como prova de vida aprovada.
Use selfie nítida com no mínimo 200 × 200 pixels. Tipos aceitos: JPEG/JPG, PNG, HEIC/HEIF, TIFF/TIF. Cada selfie pode ter até 15 MB; envie até três. O exemplo acima é ilustrativo e não é um arquivo válido. Os campos verified_* não são aceitos: o integrador não pode declarar a própria aprovação.
Documentos e limites
Envie identifying_information[].image_front e image_back em data URI. Cada lado aceita até 15 MB; o par, até 24 MB. documents[] permite comprovantes adicionais com purposes, file e, quando necessário, description. Um comprovante aceita até 24 MB. PDF é permitido para documentos, não para selfie.
O limite da Everbridge por requisição de cadastro é 24 MB de arquivos decodificados no total e 36 MiB de JSON. Divida grandes conjuntos em atualizações do mesmo cadastro. Outras operações continuam limitadas a 1 MiB. Use JSON sem compressão, MIME correto e Base64 completo; URLs de arquivos externos e vídeos não são aceitos.
Empresas e representantes
Use type: "business", razão social, registro, endereços, atividades, origem de recursos e os documentos exigidos. A lista associated_persons na criação identifica sócios, controladores e signatários. Para incluir ou atualizar pessoas depois, utilize POST /v1/customers/{customer}/associated_persons e PUT /v1/customers/{customer}/associated_persons/{id}. Os IDs devem pertencer ao mesmo cliente e organização. Os campos exigidos variam com o país e o perfil; não preencha declarações de atividade ou controle com valores presumidos.
Termos e verificações complementares
A última etapa carrega automaticamente um link para ler e aceitar os termos aplicáveis, com opção de leitura na própria página. O envio fica bloqueado até o aceite ser confirmado e os dados obrigatórios estarem completos. Não substitua o aceite real por um checkbox próprio ou por um identificador inventado. Alguns perfis e jurisdições exigem uma etapa complementar hospedada; nesses casos o formulário oferece o acesso ao fluxo exigido. A coleta por API não dispensa essas exigências. Clientes abrangidos pelas regras do Espaço Econômico Europeu podem precisar concluir a selfie nessa etapa.
Resultado e pendências
Consulte customer.status, has_accepted_terms_of_service e endorsements[].requirements. A interface distingue aprovação, análise, pendência e reprovação. Uma habilitação específica pode continuar pendente mesmo com cadastro ativo. Assine as categorias customer e kyc_link no webhook para acompanhar cadastro, verificação, termos e habilitações. Deduplique os eventos e consulte o cadastro ou o feed GET /v1/events para confirmar a situação atual.
Retentativas e proteção dos dados
Preserve a chave de idempotência e o corpo para repetir um envio. Uma resposta incerta não autoriza criar outro cadastro. A interface oferece confirmação do último envio quando há pendência. Evidências em trânsito para análise ficam criptografadas no servidor durante as retentativas, por até 24 horas, e são removidas da fila após sucesso. O formulário não salva imagens no armazenamento persistente do navegador. Prefill expira com a sessão. Não registre imagens, CPF ou Base64 em logs.
Consultar um cadastro retorna sua situação e os dados disponibilizados pela API; não é exportação do dossiê completo, das fotos ou da selfie coletada em outro fluxo.
GUIAS DE INTEGRAÇÃO
Habilitações: cripto para cripto
Solicite crypto_to_crypto para movimentar recursos entre wallets e acompanhe a aprovação por customer.
Qual código usar?
O código da habilitação para transferências cripto é crypto_to_crypto. Envie esse valor no array endorsements. A habilitação pertence ao customer, não à chave de API nem a uma wallet específica. Ela também não substitui as habilitações de Pix ou de outras rotas.
1. Solicitar para um cliente existente
Use PUT /v1/customers/{customer}, com o ID do titular já vinculado à sua organização. Não crie outro customer para pedir uma nova funcionalidade. O token precisa de customers:write.
Esse pedido solicita a habilitação. HTTP 200/201 não significa aprovação. Preserve a mesma chave e os mesmos dados nas retentativas da mesma intenção; consulte o guia de idempotência em caso de erro ou timeout.
2. Solicitar durante o cadastro
Para um novo titular por link, envie endorsements: ["crypto_to_crypto"] em POST /v1/kyc_links. O token precisa de kyc:write. Exemplo com dados fictícios:
A criação direta em POST /v1/customers também aceita esse array, junto dos dados, documentos e aceite exigidos para o cadastro. O mesmo código se aplica a pessoa física (individual) e empresa (business), sujeito à elegibilidade e aos requisitos do titular.
Uma sessão nova só envia o pedido ao concluir o formulário e o aceite. Para continuar um titular existente nessa interface, informe também customer_id. Novos cadastros continuam solicitando pix automaticamente; incluir cripto para cripto não muda esse comportamento. Outras habilitações pedidas no mesmo array são preservadas.
3. Conferir se foi aprovado
Consulte GET /v1/customers/{customer}, com customers:read. Procure o item de endorsements cujo name seja crypto_to_crypto e confira se status é approved. Exemplo parcial de resposta aprovada:
As listas de requisitos foram resumidas no exemplo. Cadastro active e wallet criada, isoladamente, não comprovam a aprovação dessa habilitação. Se o item estiver ausente ou em outro estado, não o trate como aprovado.
Quando houver pendências, leia requirements.missing para informações ou aceites faltantes, pending para itens em análise e issues para impedimentos. Use os fluxos de KYC e termos para resolver o que for solicitado. Para obter o link de verificação de um customer existente, a consulta aceita GET /v1/customers/{customer}/kyc_link?endorsement=crypto_to_crypto. Encaminhe ao titular somente a URL efetivamente retornada. A aprovação e o prazo dependem da análise e da elegibilidade; não há liberação automática garantida.
Para pagar outro cliente da sua organização, use o titular da origem em on_behalf_of, sua carteira em source.wallet_id e a carteira recebedora em destination.wallet_id, ambas com payment_rail: "wallet". Veja o JSON completo de transferência entre wallets.
Confira também GET /v1/me: são necessários o escopo transfers:write, policy.transfers_enabled: true e limites configurados na moeda de origem. Essas permissões da organização são independentes de endorsements. IDs de wallets de outras organizações permanecem inacessíveis. Aprovar uma habilitação não garante qualquer combinação de moeda e rede; acompanhe state até o resultado da transferência.
Acompanhar mudanças
Consulte o customer ou processe os eventos dele em GET /v1/events e confirme a situação atual por GET. Assine customer no webhook para receber as mudanças do cadastro e de endorsements, incluindo customer.updated. A categoria kyc_link acompanha verificação e termos. Elas são opcionais; adicione-as à seleção do endpoint preservando as categorias de pagamentos.
EVERBRIDGE / DOCUMENTAÇÃO
Uma integração. Todas as possibilidades.
Conecte sua plataforma a contas, carteiras e pagamentos com uma API pensada para o seu negócio.
API v1REST + JSONIntegração entre servidores
URL BASE · PRODUÇÃOhttps://api2.everbridge.com.br
Sua primeira integração
Receba sua chave Everbridge, confirme as permissões e conecte o primeiro cliente. Todos os recursos ficam associados à sua organização.
Uma organização pode ter várias chaves e vários clientes finais. Entenda a relação em Organização, chaves e clientes antes de estruturar sua integração.
Use links de verificação para cadastrar pessoas e empresas. Depois da aprovação e habilitação da rota, crie carteiras, contas virtuais ou destinos bancários.
Moedas, redes e meios de pagamento dependem do cadastro, das habilitações e da política da sua organização. Consulte GET /v1/me antes de habilitar funcionalidades na sua aplicação.
Use a mesma integração para cadastrar e atender diferentes clientes finais.
Como os recursos se relacionam
Sua organização representa a plataforma que integra com a Everbridge. Ela pode ter várias chaves de API e vários cadastros de pessoas ou empresas. Cada chave pertence a uma organização e permite acessar seus recursos conforme os escopos concedidos.
Recurso
Representa
Identificação
Organização
Sua plataforma e o conjunto de recursos aos quais ela tem acesso.
tenant_id, consultável em GET /v1/me.
Chave de API
Credencial utilizada pelo backend da sua plataforma.
Enviada no cabeçalho Authorization: Bearer.
Cliente (customer)
Pessoa ou empresa titular do cadastro financeiro, sujeita a KYC/KYB.
customer_id.
Conta virtual
Instruções de recebimento e destino configurado para um titular.
virtual_account_id, vinculado ao customer_id.
Exemplo: uma plataforma, vários clientes finais
Organização: Plataforma ABC
│
├── Chave 1 ─┐
├── Chave 2 ─┴── Acessam recursos da organização conforme permissões
│
├── João — customer_id: cus_JOAO
│ └── Conta virtual BRL: va_JOAO
│ ├── Instruções Pix do João
│ └── Destino configurado para essa conta
│
└── Maria — customer_id: cus_MARIA
└── Conta virtual BRL: va_MARIA
├── Instruções Pix da Maria
└── Destino configurado para essa conta
O backend da Plataforma ABC pode usar a mesma chave para cadastrar João e Maria e criar uma conta virtual para cada um, depois da aprovação e habilitação necessárias. A quantidade e os tipos de contas disponíveis dependem do titular e da rota; o exemplo não implica contas ilimitadas.
João e Maria usam o aplicativo da Plataforma ABC e concluem seus próprios cadastros. Eles não precisam receber uma chave Everbridge. A credencial fica no backend da plataforma.
Várias chaves compartilham os recursos da organização
Os cadastros pertencem à organização, não à chave que os criou. Duas chaves da mesma organização, com os mesmos escopos e válidas no mesmo ambiente, acessam os mesmos recursos. Uma chave com apenas leitura não poderá criar contas, mesmo pertencendo à mesma organização.
Criar uma chave nova não cria uma conta recebedora, não separa clientes finais e não cria um extrato financeiro exclusivo. Identifique cada cliente e sua movimentação por customer_id e virtual_account_id. Recursos de outra organização permanecem inacessíveis.
Onde entra o dinheiro?
O depósito entra na conta virtual cujas instruções foram utilizadas. A chave autentica chamadas à API; ela não recebe dinheiro e não tem uma conta de depósito padrão.
Ao criar uma conta virtual, o caminho /v1/customers/{customer_id}/virtual_accounts identifica o titular. No corpo, source.currency: "brl" define a entrada em reais; destination define a moeda, a rede e a carteira ou endereço de destino, conforme a rota habilitada. IDs de recursos utilizados juntos devem respeitar a titularidade exigida pela operação.
A resposta traz o ID da conta e source_deposit_instructions. Para Pix, apresente ao cliente o br_code dessa conta como copia e cola ou QR. Usar o código da conta de João encaminha o depósito para essa conta; usar o código da conta de Maria encaminha para a dela. Os recursos recebidos seguem o processamento e o destino configurados na respectiva conta.
Fluxo de integração
Consulte GET /v1/me para confirmar organização, ambiente e permissões da chave.
Crie um link em POST /v1/kyc_links para cada cliente final, ou use POST /v1/customers no cadastro direto. Os recursos criados pela integração ficam vinculados à organização autenticada; no fluxo por link, consulte-o para obter customer_id quando disponível.
Associe o customer_id ao usuário correspondente no seu banco de dados e acompanhe aprovação, termos e habilitações.
Consulte ou crie as contas virtuais sob /v1/customers/{customer_id}/virtual_accounts. Salve o ID de cada conta e apresente suas instruções ao cliente correspondente.
Consulte o histórico dessa conta ou os eventos da organização. Use os IDs para identificar o cliente e deposit_id para conciliar cada recebimento uma única vez.
Se sua própria empresa for o titular dos recursos, ela também precisa de um cadastro business e da aprovação correspondente. Ter uma chave de API não substitui KYC/KYB.
Do recebimento da chave ao primeiro cliente cadastrado.
1. Receba suas credenciais
A equipe Everbridge provisiona sua organização e emite uma chave com os escopos acordados. Guarde-a no gerenciador de segredos do backend ou em uma variável de ambiente protegida. A documentação não solicita nem armazena sua chave.
Verifique tenant_id, environment, scopes e policy. Cada chave acessa uma organização. Produção e sandbox usam credenciais e recursos separados; solicite o endereço de sandbox quando ele for provisionado.
Salve o id do link e, quando retornado, customer_id. Encaminhe o titular às URLs retornadas para verificação e aceite. Em produção, use dados reais e autorizados.
4. Acompanhe a aprovação
Consulte o link de KYC e os eventos. Se o cliente for criado depois do link, recupere customer_id pela consulta. Cadastro criado não equivale a cadastro aprovado.
5. Provisione recursos
Com o titular aprovado e habilitado, crie a carteira e a conta virtual, ou vincule uma conta externa. Respeite a titularidade exigida por cada operação. Em transferências entre wallets, o destino pode ser de outro customer da mesma organização; veja o guia de transferências.
Os exemplos contêm dados fictícios. Substitua-os pelos recursos da sua organização. Preserve a mesma chave de idempotência ao repetir uma intenção de operação.
COMECE AQUI
Chaves e autenticação
Uma ou mais chaves Everbridge, com acesso controlado aos recursos da sua organização.
Sua chave Everbridge
A chave é uma credencial opaca, normalmente iniciada por abs_live_. O prefixo não define o ambiente: confirme environment em /v1/me. A chave não é JWT e não precisa ser decodificada ou descriptografada. Envie-a em todas as requisições autenticadas.
Authorization: Bearer SUA_CHAVE_EVERBRIDGE
A organização é identificada automaticamente. Não envie tenant_id no corpo. Sua chave não concede acesso a recursos de outras organizações.
Uma organização, várias chaves
Uma organização pode ter várias chaves e vários clientes finais. Os recursos pertencem à organização; chaves com os mesmos escopos acessam os mesmos recursos. Gerar outra chave não separa cadastros, contas ou depósitos. Veja Organização, chaves e clientes.
Emissão, rotação e revogação
Solicite sua chave à equipe Everbridge, informando integração, operações necessárias e validade desejada. Para rotacionar: receba uma chave nova, atualize o segredo do backend, valide /v1/me e solicite revogação da anterior. A troca da chave não altera os cadastros e contas vinculados à organização. Chaves revogadas ou expiradas deixam de autenticar imediatamente.
Somente no backend
Não inclua a chave em JavaScript do navegador, aplicativos distribuídos, links, repositórios ou logs. Seu frontend chama seu backend; seu backend chama a Everbridge. Requisições autenticadas com Origin são rejeitadas com server_to_server_only. Não há CORS para chamadas autenticadas.
Escopos de acesso
Escopo
Permissão
customers:read / write
Clientes.
kyc:read / write
Verificação e termos.
wallets:read / write
Carteiras.
accounts:read / write
Contas externas, virtuais e liquidação.
transfers:read / write
Consultar, criar e cancelar transferências.
compliance:write
Travel Rule.
events:read
Feed de eventos.
webhooks:read / write
Consultar entregas ou configurar destinos e segredos de pagamentos da organização.
audit:read
Registros de requisições.
rates:read
Cotações.
read / write representa escopos separados, como customers:read e customers:write. Escopos não eliminam verificações de propriedade, habilitação, limite e política.
FUNDAMENTOS
Convenções da API
URLs, formatos, identificação e paginação.
Requisições e respostas
Use HTTPS, caminhos sob /v1 e JSON UTF-8. Envie Content-Type: application/json em POST e PUT. Operações sem campos aceitam {}; DELETE dispensa corpo. O limite é 1 MiB; corpos comprimidos não são aceitos.
Criações podem responder 200 ou 201. Remoções sem conteúdo são normalizadas para 200 com {"status":"deleted"}. Erros seguem o envelope em Erros e limites. Ignore novos campos de resposta e preserve estados desconhecidos para investigação.
Valores e identificadores
Valores monetários e percentuais são strings decimais: "10.50". Não use vírgulas, separadores de milhar ou notação científica. Evite ponto flutuante para conciliação. Datas e horários usam ISO 8601. IDs são opacos; não deduza dados pelo prefixo.
IDs nos caminhos aceitam letras, números, hífen e underscore, com 1 a 160 caracteres. Referências são verificadas dentro da organização e do titular correspondente.
Paginação
Coleções de contas, carteiras e transferências aceitam limit de 1 a 100 e starting_after ou ending_before. Avance pelo ID do último item, preservando filtros. Pare em página vazia ou menor que o limite solicitado. Não combine direções no mesmo fluxo.
GET /v1/customers/cus_EXEMPLO/wallets?limit=20
GET /v1/customers/cus_EXEMPLO/wallets?limit=20&starting_after=wal_ULTIMO
Eventos e auditoria usam after numérico, começando em 0. Inventário usa kind e after textual. Esses endpoints retornam até 100 itens: avance pelo next_cursor. Eventos e inventário também retornam has_more; uma página cheia pode exigir outra consulta mesmo sem itens restantes.
Inventário
Não há GET global em /v1/customers ou /v1/transfers. Descubra IDs vinculados com /v1/resources?kind=customer ou kind=transfer. Consulte cada recurso para obter seu estado atual; transferências de um titular também podem ser listadas sob /customers/{customer}/transfers.
FUNDAMENTOS
Idempotência e retentativas
Repita chamadas sem duplicar a intenção de uma operação.
Uma chave por intenção
POST, PUT e DELETE exigem Idempotency-Key, com 8 a 160 caracteres: letras, números, hífen e underscore. Gere e salve uma chave única antes da primeira tentativa.
Idempotency-Key: pedido-2026-0001
A chave vale em toda a organização. Preserve método, caminho, parâmetros e corpo ao repetir. Outra requisição com a mesma chave retorna 409 idempotency_conflict. Respostas concluídas são reapresentadas sem nova execução; chamadas simultâneas recebem 409 request_in_progress.
Solicitação recusada
Uma recusa definitiva fica registrada como concluída. Repetir a mesma chave e os mesmos dados reapresenta o erro salvo, inclusive após 24 horas, sem executar novamente. Leia error.reason, error.message e error.fields. Para corrigir os dados ou iniciar uma nova tentativa após confirmar a recusa, use outra chave; alterar o corpo mantendo a chave anterior retorna 409 idempotency_conflict.
Resultado incerto
Timeout não comprova falha. Consulte eventos ou o recurso e repita com a mesma chave e dados. Para 429 e falhas transitórias, use espera exponencial com jitter e tentativas limitadas. O motivo request_outcome_uncertain, inclusive em HTTP 422, indica que o resultado ainda precisa ser confirmado: preserve a chave e não inicie outra operação para contornar a pendência.
Pendências há mais de 24 horas, ou transferências pendentes desde outro dia UTC, retornam 409 reconciliation_required. Envie à equipe Everbridge a chave da operação e o request_id; não gere outra chave para contornar a reconciliação.
Limites monetários
Os limites usam a moeda de origem, com per_transfer e daily em /v1/me. O dia é UTC. Uma recusa definitiva libera a reserva da tentativa. Resultados incertos mantêm a reserva até confirmação ou reconciliação. Moeda sem limite configurado não autoriza transferências.
GUIAS DE INTEGRAÇÃO
Clientes, KYC e termos
Cadastre pessoas e empresas e acompanhe suas habilitações.
Cadastro por link
Crie /v1/kyc_links com nome, e-mail e tipo individual ou business. Salve id, customer_id quando existir, kyc_link e tos_link. Use as URLs retornadas, sem reconstruí-las.
Para redirect_uri, autorize previamente a origem HTTPS em sua política. O retorno do navegador não comprova aprovação: confirme por consulta autenticada ou evento.
Cadastro direto
POST /v1/customers atende integrações que coletam os dados diretamente. Requisitos pessoais, societários e de identificação variam por país e habilitação. Os campos da referência não formam uma lista universal de documentos obrigatórios. Alinhe seu esquema de coleta com a equipe Everbridge.
O aceite dos termos deve corresponder ao titular. signed_agreement_id é aceito na criação, quando aplicável, e não no PUT. Não fabrique identificadores de aceite.
Status do cliente: como operacionalizar
Use o status do cliente como referência operacional após obter customer_id. O kyc_status acompanha a verificação por link e também pode refletir restrições. approved no KYC não substitui active no cliente. Confira has_accepted_terms_of_service e endorsements da rota. Estados ausentes ou desconhecidos não autorizam operações.
Consulte GET /v1/customers/{customer_id} e leia status. Não é necessário criar dois controles na interface: apresente uma situação de cadastro e preserve os estados originais no backend.
status
Significado
Ação na plataforma
not_started
Verificação não iniciada.
Orientar a iniciar o cadastro.
incomplete
Dados ou documentos incompletos.
Retomar o link e concluir pendências.
awaiting_questionnaire
Questionário pendente.
Preencher o questionário solicitado.
awaiting_ubo
Beneficiários finais da empresa pendentes.
Completar informações das pessoas que possuem ou controlam a empresa.
under_review
Cadastro em análise.
Mostrar “Cadastro em análise”.
active
Cadastro ativo.
Conferir termos e habilitação Pix antes de operar.
rejected
Cadastro não aprovado.
Não liberar operações.
paused
Cadastro pausado para revisão.
Suspender novas operações.
deposits_restricted
Novos depósitos restritos.
Bloquear novos depósitos.
offboarded
Cadastro encerrado após revisão.
Bloquear operações.
Status do KYC
Consulte GET /v1/kyc_links/{kyc_link_id} e leia kyc_status, especialmente enquanto ainda não houver customer_id. KYC verifica a pessoa; para empresas, a verificação inclui o negócio (KYB). Os dois campos compartilham estados, mas não são garantia de sincronização entre consultas.
kyc_status
Significado
not_started
Verificação não iniciada.
incomplete
Dados ou documentos incompletos.
awaiting_questionnaire
Questionário pendente.
awaiting_ubo
Beneficiários finais da empresa pendentes.
under_review
Cadastro em análise.
approved
Verificação aprovada.
rejected
Cadastro não aprovado.
paused
Cadastro pausado para revisão.
deposits_restricted
Novos depósitos restritos.
offboarded
Cadastro encerrado após revisão.
Termos e aprovação Pix
No link, tos_status pode ser pending ou approved. No cliente, confira has_accepted_terms_of_service: true e a aprovação das habilitações necessárias em endorsements. Consulte suas pendências em requirements.
Novos cadastros por POST /v1/kyc_links ou POST /v1/customers solicitam pix automaticamente, incluindo on-ramp e off-ramp, mesmo sem endorsements no pedido. Solicitação não significa aprovação; outras habilitações enviadas são preservadas.
Retomada e clientes existentes
Os endpoints /kyc_link e /tos_acceptance_link do cliente retomam verificação e aceite. Para utilizar um cadastro anterior à integração, confirme seu vínculo com sua organização junto à equipe Everbridge; conhecer um ID não concede acesso.
GUIAS DE INTEGRAÇÃO
Carteiras, contas e Pix
Escolha recursos conforme a origem e o destino do dinheiro.
Carteira custodial
Crie a carteira em /customers/{customer}/wallets com chain. Salve ID, endereço e rede; consulte saldos no recurso. Para uma rota de pagamento, use payment_rail: "wallet" e wallet_id, respeitando moeda, rede e titularidade.
Conta externa e saída Pix
Para chave Pix, use currency: "brl", account_type: "pix" e o objeto pix_key com pix_key e document_number. Alternativamente, br_code recebe código Pix e documento. Use dados do titular validado.
Salve o ID da conta e referencie-o como external_account_id na transferência. Confira moeda e estado. Veja o exemplo completo.
Conta virtual e recebimento
Configure source.currency e destination. Exiba somente as instruções de depósito retornadas; não invente dados bancários, códigos Pix ou referências. BRL/Pix depende de habilitação.
Acompanhe /virtual_accounts/{id}/history e eventos. Uma conta criada não comprova depósito. Instruções, valores e etapas variam pela rota.
Pix: copia e cola, QR e expiração
Para BRL/Pix, source_deposit_instructions contém currency, br_code (copia e cola), account_holder_name e payment_rails. Gere a imagem QR a partir do br_code exato; não há imagem PNG/base64 garantida. A conta é reutilizável, sem expires_at documentado neste formato. Isso não garante disponibilidade permanente: consulte seu estado. Não há suporte a BR Code com valor fixo; não altere o código para inserir o valor da cobrança.
Exemplo parcial de source_deposit_instructions; o texto abaixo é um marcador, não um código pagável:
Mostre o valor da cobrança separadamente e confirme o valor efetivamente recebido. Veja Conciliação Pix por cobrança.
Endereços de liquidação
Associe rede, ativo, conta externa e rota de saída. Consulte /liquidation_addresses/{id}/drains para acompanhar execuções. Confirme rede e instruções de devolução antes de exibir um endereço de depósito.
GUIAS DE INTEGRAÇÃO
Transferências e câmbio
Crie, acompanhe e concilie cada movimentação.
Pré-requisitos
Exigem-se transfers:write, transfers_enabled: true, limites na moeda de origem e titular habilitado. Para transferências cripto entre wallets, solicite crypto_to_crypto em endorsements e confira status: "approved" no item correspondente do customer. Veja como solicitar e acompanhar a habilitação.
Todos os IDs referenciados precisam pertencer à sua organização. A carteira de origem deve pertencer ao customer indicado em on_behalf_of. Em POST /v1/transfers, a carteira indicada diretamente em destination.wallet_id pode pertencer a outro customer da mesma organização. As demais referências continuam vinculadas ao titular da operação.
Entre carteiras de clientes da organização
Para um pagamento de um pagador a um lojista, informe o customer do pagador em on_behalf_of, a wallet dele na origem e a wallet do lojista no destino. Exemplo com IDs fictícios e carteiras compatíveis com USDC:
Envie com Authorization: Bearer e uma Idempotency-Key por pagamento. O destino pode ser do próprio pagador ou de outro customer da organização; uma wallet de outra organização é recusada. A transferência permanece associada ao pagador e não altera o titular das wallets. A execução depende de saldo, moeda, rede e habilitações compatíveis: acompanhe o state retornado até a conclusão.
Essa permissão vale para o destino da transferência. Contas virtuais e endereços de liquidação continuam exigindo que a wallet referenciada pertença ao customer indicado no caminho.
Criar e acompanhar
Envie amount, on_behalf_of, source e destination em POST /v1/transfers. Salve ID e chave de idempotência. Apresente exatamente as instruções de financiamento retornadas, quando existirem. Consulte o recurso e processe eventos.
Criação não comprova liquidação. Preserve state e confirme execução antes de concluir o pedido. Pendências de análise e compliance exigem tratamento.
Saque de USDC para Pix
Para usar uma carteira custodial, mantenha source.payment_rail: "wallet" e informe source.wallet_id. No destino, use payment_rail: "pix", currency: "brl" e o external_account_id da conta Pix do titular. A rede da carteira e a rota precisam ser compatíveis.
amount é o valor de USDC debitado da origem, não o valor em reais a receber. Nessa rota, envie até duas casas decimais, por exemplo "2.01". A API não arredonda pagamentos automaticamente. Se houver recusa por precisão, o erro 422 poderá informar fields[].code: "invalid_precision" e max_decimal_places. Corrija o valor e use uma nova chave de idempotência para a nova intenção, após confirmar que a anterior foi recusada. Em respostas incertas, reconcilie antes de iniciar outra transferência.
Estados da transferência
Consulte GET /v1/transfers/{id} e leia state. Estados conhecidos:
state
Significado
awaiting_funds
Aguardando recursos.
in_review
Operação em análise.
funds_received
Recursos recebidos; processamento pendente.
payment_submitted
Pagamento enviado; confirmação pendente.
payment_processed
Entrega ao destino concluída.
undeliverable
Não foi possível entregar ao destino.
returned
Pagamento retornou; devolução ao remetente em andamento.
missing_return_policy
Falta configurar a política de devolução de cripto.
refund_in_flight
Devolução em processamento.
refunded
Recursos devolvidos.
refund_failed
Falha na devolução; requer tratamento.
canceled
Transferência cancelada.
error
Processamento bloqueado por erro.
Fluxo de sucesso: awaiting_funds → funds_received → payment_submitted → payment_processed. Sua aplicação pode não observar todas as etapas. O hash em payment_submitted pode ser preliminar; use o hash final de payment_processed. Cancelamento é permitido a partir de awaiting_funds. Trate estados desconhecidos como pendência de conciliação, nunca como sucesso.
Cotações e tarifas
/v1/exchange_rates?from=usd&to=brl fornece referência de câmbio; não reserva preço nem inclui necessariamente todas as tarifas. Concilie com valores e taxas efetivos da operação executada.
Cancelamento e templates
DELETE /v1/transfers/{id} solicita cancelamento, sujeito ao estado. Consulte novamente o recurso. Templates estáticos exigem política explícita; flexible_amount e allow_any_from_address também dependem de template autorizado.
GUIAS DE INTEGRAÇÃO
Eventos e conciliação
Sincronize seu sistema com um feed autenticado.
Receba atualizações
Cadastre POST /v1/webhooks para receber notificações assinadas de pagamentos no seu backend, incluindo funds_received sem aguardar a conclusão. Selecione também customer e kyc_link para acompanhar cadastro, KYC, termos e habilitações. Consulte o guia de webhooks. O feed GET /v1/events continua disponível para conciliação e recuperação; deduplique por event_id entre as duas fontes.
Processamento confiável
Leia o cursor confirmado no seu banco; comece em 0.
Busque /v1/events?after=CURSOR.
Em transação local, grave os eventos com unicidade por event.event_id, aplique atualizações e persista next_cursor.
Se has_more for verdadeiro, continue; caso contrário, aguarde antes de consultar.
Não avance o cursor antes de confirmar a gravação. Eventos podem chegar atrasados ou fora de ordem de negócio. A sequência controla leitura, não causalidade financeira; reconcilie pelo estado atual do recurso.
As categorias configuradas incluem cliente, KYC, transferência, conta externa, atividade de conta virtual e liquidação. Eventos aparecem apenas após reconhecimento da propriedade. Concilie carteiras e outros recursos também por consulta; não suponha que toda mudança gera evento neste feed.
Frequência
Como ponto inicial, consulte a cada 10 segundos sem páginas pendentes e ajuste à sua política. Aumente o intervalo após 429. Grave localmente o histórico necessário; não há garantia pública de retenção indefinida do feed.
GUIAS DE INTEGRAÇÃO
Conciliação Pix por cobrança
Identifique o valor recebido, os pagamentos parciais e as etapas de cada depósito.
Cobrei R$ 100. Como confirmar o pagamento?
A atividade usa type; a transferência usa state. Agrupe etapas pelo deposit_id dentro da conta e organização. Compare a cobrança com o valor bruto de entrada amount e currency=brl no recebimento; não use o líquido após taxas nem o valor convertido. R$ 100 cobrados e R$ 90 recebidos significam pagamento parcial, com R$ 10 pendentes. A aplicação vincula depósitos às cobranças e trata vencimentos, excedentes e devoluções.
Salve sua cobrança com ID interno, estabelecimento, customer_id, virtual_account_id, moeda BRL, valor e vencimento.
Consulte GET /v1/customers/{customer_id}/virtual_accounts/{virtual_account_id}/history, percorrendo todas as páginas, ou consuma GET /v1/events?after=CURSOR. No feed, a atividade fica em event.event_object.
Identifique o recebimento em BRL, valide os IDs e grave o depósito uma única vez. Preserve valor bruto, moeda e etapas separadamente.
Vincule o depósito à cobrança de acordo com sua regra de negócio e compare os valores em centavos inteiros ou aritmética decimal.
Parcial: faltam R$ 10; saldo atrasado após o vencimento.
R$ 100
R$ 100
Valor integral recebido.
R$ 100
R$ 110
Valor integral recebido e R$ 10 excedentes a tratar.
Um depósito, várias etapas
Recebimento, envio e conclusão com o mesmo deposit_id representam o mesmo dinheiro. Não some seus valores. No feed, deduplique entregas por event.event_id; no histórico, por id da atividade. Para contabilizar dinheiro, mantenha unicidade por organização, conta virtual e deposit_id, inclusive quando consultar as duas fontes.
Um segundo Pix confirmado de R$ 10 terá outro deposit_id. Se for vinculado à mesma cobrança já paga parcialmente em R$ 90, o total recebido será R$ 100. O valor de entrada em BRL não deve ser sobrescrito por valores líquidos ou convertidos de etapas posteriores. Se faltar valor ou moeda de origem, consulte o histórico e mantenha a conciliação pendente.
Qual cobrança esse depósito paga?
A conta virtual vinculada ao estabelecimento identifica o cadastro que recebeu o depósito; deposit_id identifica o recebimento, não sua cobrança interna. Defina uma regra explícita, como abater a parcela vencida mais antiga, e salve quanto de cada depósito foi aplicado a cada cobrança. Não reutilize o mesmo saldo em duas cobranças.
Uma conta compartilhada por vários pagadores não identifica automaticamente quem pagou só pelo valor. Não suponha que todo depósito de R$ 100 corresponde à cobrança de R$ 100 que estiver aberta.
Recebimento e conclusão
Guarde separadamente o valor recebido e a etapa do processamento. funds_received confirma entrada; payment_processed indica entrega on-chain. Defina quando seu produto concede quitação e trate devoluções revisando os valores aplicados. Eventos atrasados ou fora de ordem exigem reconciliação; não regrida o estado apenas pela ordem de chegada.
type da atividade
Significado
funds_received
Entrada de recursos.
payment_submitted
Envio ao destino iniciado.
payment_processed
Entrega on-chain confirmada.
in_review
Depósito em análise.
refunded
Recursos devolvidos.
funds_scheduled
Entrada programada, específica de ACH.
account_update
Conta atualizada.
activation
Conta ativada.
deactivation
Conta desativada.
reactivation
Conta reativada.
microdeposit
Microdepósito de verificação, sem conversão.
refund_in_flight
Devolução em andamento.
refund
Devolução concluída.
refund_failed
Falha na devolução.
drain
Saída de recursos da conta.
close
Conta encerrada.
Atualização, desativação e reativação da conta não são pagamentos. Microdepósitos e entradas apenas programadas não devem quitar cobranças Pix.
Transações da sua organização
A chave Everbridge dá acesso aos recursos da organização, conforme seus escopos. Chaves diferentes da mesma organização não criam extratos financeiros separados. Use os IDs de clientes e contas para segmentar sua conciliação. O calendário, as parcelas e os estados “pago”, “parcial” e “atrasado” são controles da sua aplicação.
GUIAS DE INTEGRAÇÃO
Travel Rule e dados complementares
Responda a exigências de identificação das partes.
Origem e beneficiário
Quando solicitado, envie originator, beneficiary ou ambos para POST /v1/travel_rule_data/{id}. Alguns endpoints também aceitam travel_rule_data na criação.
O formato varia conforme rota e carteira. wallet_type e is_self são exemplos; um payload mínimo não dispensa dados adicionais exigidos.
Recurso correto
O ID deve representar transferência, conta virtual, endereço de liquidação ou atividade conhecida e vinculada à organização. Consulte histórico ou liquidações para registrar atividades antes de anexar dados. IDs arbitrários não são aceitos.
Dados pessoais
Envie apenas dados necessários e autorizados. Restrinja acesso a documentos e payloads no backend. Para suporte, use IDs da requisição e do recurso; não exponha documentos ou credenciais em erros públicos.
JSON sem compressão: até 36 MiB nas escritas de cadastro e representantes; 1 MiB nas demais operações. Consulte os limites de arquivos no guia de KYC direto.
422
provider_rejected_request.
Verificar requisitos do titular e da rota.
429
Limite local ou provider_rate_limited.
Reduzir ritmo e aplicar backoff.
500 / 502 / 503
Erro interno ou indisponibilidade.
Tentativas limitadas com mesma chave; reconciliar resultados incertos.
Motivo da recusa
O HTTP 422 mantém error.code: "provider_rejected_request". Em cadastros, KYC, contas e transferências, leia também message, reason e, quando disponíveis, fields. Os caminhos usam os nomes públicos da API; as mensagens não reproduzem dados pessoais ou respostas internas.
Os motivos incluem invalid_parameters, duplicate_record, insufficient_funds, endorsement_not_approved, customer_not_active e unsupported_route. Quando não houver detalhe reconhecido, request_rejected orienta a conferir os requisitos. request_outcome_uncertain exige preservar a chave e reconciliar antes de iniciar outra operação. Um e-mail já em uso pode aparecer como fields[].code: "already_in_use": confira o cadastro existente e a identidade do titular antes de reutilizá-lo.
{
"error": {
"code": "provider_rejected_request",
"request_id": "IDENTIFICADOR_DA_REQUISICAO",
"reason": "invalid_parameters",
"message": "Confira os campos indicados antes de enviar a transferência novamente.",
"fields": [{
"path": "amount",
"code": "invalid_precision",
"message": "Use no máximo 2 casas decimais neste campo.",
"max_decimal_places": 2
}]
}
}
Nem toda recusa identifica um campo; nesses casos, guarde o request_id para suporte. Para repetir a mesma intenção, preserve corpo e chave. Um corpo corrigido exige nova chave, depois de confirmar a recusa da tentativa anterior.
Requisições por minuto
Confira policy.rate_per_minute. O padrão é 120, compartilhado entre tokens da organização; sua política pode ter outro limite. Não dependa de Retry-After: use espera exponencial, jitter e teto de tentativas.
Diagnóstico
Confira /v1/me e, com permissão, /v1/audit. Envie o request_id à equipe Everbridge para correlação sem expor sua chave.
OPERAÇÃO
Entrada em produção
Valide os fluxos que sua aplicação utiliza.
Ambientes
https://api2.everbridge.com.br é produção. Confirme em /v1/me. Sandbox depende de provisionamento separado; alterar o prefixo de uma chave não troca o ambiente. A simulação de aprovação é bloqueada em produção.
Antes de disponibilizar
Confirme escopos, origens de retorno e limites.
Valide cadastro completo, pendências, reprovação e termos.
Salve IDs e chaves de idempotência antes de operações dependentes.
Teste perda de conexão, repetição, 429 e eventos duplicados.
Confira titular, moeda, rede e destino.
Concilie valores pelo recurso executado e salve eventos.
Valide rotação de chaves sem exposição no frontend.
Contrato
Esta documentação cobre /v1, contrato 1.4.0. Campos de resposta podem ser adicionados; trate estados desconhecidos explicitamente e alinhe mudanças incompatíveis com a equipe.
Transferências começam desabilitadas. A liberação exige escopos, limites e habilitações do titular e da rota.
REFERÊNCIA / Cotações
Consultar cotação
A operação acessa somente recursos vinculados à sua organização.
GET/v1/exchange_rates
Autenticação BearerEscopo rates:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/exchange_rates?from=usd&to=brl' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/exchange_rates?from=usd&to=brl', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/exchange_rates?from=usd&to=brl',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de consulta
Campo
Descrição
fromstringObrigatório*
Moeda de origem em minúsculas.
tostringObrigatório*
Moeda de destino em minúsculas.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / KYC e termos
Criar link de KYC
A operação acessa somente recursos vinculados à sua organização. Salve o id retornado e associe-o ao registro correspondente no seu sistema. O recurso fica vinculado à organização autenticada, não exclusivamente à chave que o criou. Todo novo cadastro solicita pix automaticamente, incluindo on-ramp e off-ramp, mesmo quando endorsements é omitido ou vazio. Outras habilitações solicitadas são preservadas. A aprovação depende da análise e da elegibilidade do titular. Para solicitar a habilitação de cripto para cripto, envie endorsements: ["crypto_to_crypto"] na criação ou no PUT do customer existente. Consulte endorsements[].name e status no GET do customer; aguarde crypto_to_crypto com status approved. Guia: https://docs.everbridge.com.br/#endorsements. Envie ao titular os links retornados de verificação e aceite. A criação do link não significa aprovação. kyc_status: not_started: Verificação não iniciada. incomplete: Dados ou documentos incompletos. awaiting_questionnaire: Questionário pendente. awaiting_ubo: Beneficiários finais da empresa pendentes. under_review: Cadastro em análise. approved: Verificação aprovada. rejected: Cadastro não aprovado. paused: Cadastro pausado para revisão. deposits_restricted: Novos depósitos restritos. offboarded: Cadastro encerrado após revisão. tos_status: pending (aceite pendente) ou approved (termos aceitos). Use o status do cliente como referência operacional após obter customer_id. O kyc_status acompanha a verificação por link e também pode refletir restrições. approved no KYC não substitui active no cliente. Confira has_accepted_terms_of_service e endorsements da rota. Estados ausentes ou desconhecidos não autorizam operações.
POST/v1/kyc_links
Autenticação BearerEscopo kyc:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/kyc_links',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"full_name\":\"Marina Exemplo\",\"email\":\"marina@example.com\",\"type\":\"individual\"}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
full_namestringObrigatório*
Nome completo da pessoa ou razão social.
emailstringObrigatório*
E-mail do titular.
typestringObrigatório*
Tipo de cliente.
individualbusiness
endorsementsarray [string]
Habilitações solicitadas por customer. Para transferências cripto entre wallets, solicite crypto_to_crypto e aguarde status approved. Consulte o guia de habilitações; solicitar não aprova nem cria uma carteira.
redirect_uristring
URL HTTPS de retorno. A origem precisa estar autorizada na política do cliente.
Resposta
200 / 201 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / KYC e termos
Consultar link de KYC
A operação acessa somente recursos vinculados à sua organização. kyc_status: not_started: Verificação não iniciada. incomplete: Dados ou documentos incompletos. awaiting_questionnaire: Questionário pendente. awaiting_ubo: Beneficiários finais da empresa pendentes. under_review: Cadastro em análise. approved: Verificação aprovada. rejected: Cadastro não aprovado. paused: Cadastro pausado para revisão. deposits_restricted: Novos depósitos restritos. offboarded: Cadastro encerrado após revisão. tos_status: pending (aceite pendente) ou approved (termos aceitos). Use o status do cliente como referência operacional após obter customer_id. O kyc_status acompanha a verificação por link e também pode refletir restrições. approved no KYC não substitui active no cliente. Confira has_accepted_terms_of_service e endorsements da rota. Estados ausentes ou desconhecidos não autorizam operações.
GET/v1/kyc_links/{id}
Autenticação BearerEscopo kyc:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/kyc_links/recurso_EXEMPLO' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/kyc_links/recurso_EXEMPLO', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/kyc_links/recurso_EXEMPLO',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Clientes
Obter termos para novo cadastro
Solicite o aceite legítimo dos termos antes da criação direta do cliente. Envie corpo vazio. O titular lê e aceita os termos; o retorno fornece signed_agreement_id. Não fabrique aceites. Guia: https://docs.everbridge.com.br/#kyc-direct.
POST/v1/customers/tos_links
Autenticação BearerEscopo kyc:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/tos_links',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Corpo da requisição
Envie um objeto vazio: {}.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
application/json
{
"url": "URL_DE_ACEITE_RETORNADA"
}
Erros e operação
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Clientes
Listar países e regiões
Catálogo para preencher o cadastro. A presença de um país nesta lista não significa aprovação ou disponibilidade de todas as rotas.
GET/v1/lists/countries
Autenticação BearerEscopo kyc:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/lists/countries' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/lists/countries', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/lists/countries',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Clientes
Listar ocupações
Catálogo para preencher o cadastro. A presença de um país nesta lista não significa aprovação ou disponibilidade de todas as rotas.
GET/v1/lists/occupation_codes
Autenticação BearerEscopo kyc:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/lists/occupation_codes' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/lists/occupation_codes', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/lists/occupation_codes',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
application/json
[
{
"code": "132011",
"display_name": "Accountant and auditor"
}
]
Erros e operação
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Clientes
Criar cliente
A operação acessa somente recursos vinculados à sua organização. Salve o id retornado e associe-o ao registro correspondente no seu sistema. O recurso fica vinculado à organização autenticada, não exclusivamente à chave que o criou. Todo novo cadastro solicita pix automaticamente, incluindo on-ramp e off-ramp, mesmo quando endorsements é omitido ou vazio. Outras habilitações solicitadas são preservadas. A aprovação depende da análise e da elegibilidade do titular. Para solicitar a habilitação de cripto para cripto, envie endorsements: ["crypto_to_crypto"] na criação ou no PUT do customer existente. Consulte endorsements[].name e status no GET do customer; aguarde crypto_to_crypto com status approved. Guia: https://docs.everbridge.com.br/#endorsements. Cadastro direto: o tipo é obrigatório; os demais documentos e campos exigidos variam conforme pessoa, país e habilitação. Para a interface guiada Everbridge, use POST /v1/kyc_sessions. Inclua signed_agreement_id de um aceite legítimo quando exigido. Suporta evidências de identidade; limite de 24 MB de arquivos decodificados e 36 MiB de JSON. Campos verified_* são bloqueados. Guia: https://docs.everbridge.com.br/#kyc-direct. Status do cliente: not_started: Verificação não iniciada. incomplete: Dados ou documentos incompletos. awaiting_questionnaire: Questionário pendente. awaiting_ubo: Beneficiários finais da empresa pendentes. under_review: Cadastro em análise. active: Cadastro ativo. rejected: Cadastro não aprovado. paused: Cadastro pausado para revisão. deposits_restricted: Novos depósitos restritos. offboarded: Cadastro encerrado após revisão. Use o status do cliente como referência operacional após obter customer_id. O kyc_status acompanha a verificação por link e também pode refletir restrições. approved no KYC não substitui active no cliente. Confira has_accepted_terms_of_service e endorsements da rota. Estados ausentes ou desconhecidos não autorizam operações.
POST/v1/customers
Autenticação BearerEscopo customers:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"type\":\"individual\",\"first_name\":\"Marina\",\"last_name\":\"Exemplo\",\"email\":\"marina@example.com\"}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
typestringObrigatório*
Tipo de cliente.
individualbusiness
first_namestring
Primeiro nome.
middle_namestring
Nome intermediário.
last_namestring
Sobrenome.
transliterated_first_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
transliterated_middle_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
transliterated_last_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
emailstring
E-mail do titular.
phonestring
Telefone com código internacional.
residential_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
transliterated_residential_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
birth_datestring
Data de nascimento no formato YYYY-MM-DD.
signed_agreement_idstring
Identificador de aceite válido dos termos. Não fabrique este valor.
endorsementsarray [string]
Habilitações solicitadas por customer. Para transferências cripto entre wallets, solicite crypto_to_crypto e aguarde status approved. Consulte o guia de habilitações; solicitar não aprova nem cria uma carteira.
account_purposestring
Finalidade da conta.
account_purpose_otherstring
Descrição quando a finalidade exigir complemento.
employment_statusstring
Situação profissional.
expected_monthly_payments_usdstring,integer
Pessoa física: faixa 0_4999, 5000_9999, 10000_49999 ou 50000_plus. Empresa: valor inteiro esperado em USD.
acting_as_intermediaryboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
most_recent_occupationstring
Ocupação mais recente.
source_of_fundsstring
Origem dos recursos conforme a classificação aprovada para o cadastro.
nationalitystring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
nationalitiesarray [string]
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
place_of_birthobject
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.Campos do objeto
countrystring
Campo específico do recurso.
citystring
Campo específico do recurso.
liveness_check_selfiesarray [object]
Imagens de selfie para análise, não vídeos. Data URI Base64, no mínimo 200 × 200 pixels, até 15 MB cada, até três imagens. Não significa prova de vida aprovada. Alguns perfis exigem verificação complementar hospedada.Campos de cada item
imagestring
Campo específico do recurso.
identifying_informationarray [object]
Identificação fiscal e documentos. image_front/image_back usam data URI Base64; até 15 MB por lado e 24 MB pelo par.Campos de cada item
Comprovantes adicionais. Informe purposes, file em data URI Base64 e description quando exigido. Até 24 MB por arquivo; finalidades aceitas dependem de individual/business.Campos de cada item
purposesarray [string]
Campo específico do recurso.
filestring
Campo específico do recurso.
descriptionstring
Campo específico do recurso.
client_reference_idstring
Referência da operação no seu sistema. Não substitui Idempotency-Key.
business_legal_namestring
Razão social.
transliterated_business_legal_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
business_trade_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
transliterated_business_trade_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
business_descriptionstring
Descrição das atividades.
has_foreign_tax_registrationboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
business_typestring
Tipo jurídico.
primary_websitestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
other_websitesarray [string]
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
registered_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
transliterated_registered_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
physical_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
transliterated_physical_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
is_daoboolean
Indica organização autônoma descentralizada.
compliance_screening_explanationstring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
associated_personsarray [object]
Sócios, controladores e representantes na criação. Atualizações posteriores utilizam as rotas associated_persons do cliente.Campos de cada item
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Clientes
Consultar cliente
A operação acessa somente recursos vinculados à sua organização. Para solicitar a habilitação de cripto para cripto, envie endorsements: ["crypto_to_crypto"] na criação ou no PUT do customer existente. Consulte endorsements[].name e status no GET do customer; aguarde crypto_to_crypto com status approved. Guia: https://docs.everbridge.com.br/#endorsements. Status do cliente: not_started: Verificação não iniciada. incomplete: Dados ou documentos incompletos. awaiting_questionnaire: Questionário pendente. awaiting_ubo: Beneficiários finais da empresa pendentes. under_review: Cadastro em análise. active: Cadastro ativo. rejected: Cadastro não aprovado. paused: Cadastro pausado para revisão. deposits_restricted: Novos depósitos restritos. offboarded: Cadastro encerrado após revisão. Use o status do cliente como referência operacional após obter customer_id. O kyc_status acompanha a verificação por link e também pode refletir restrições. approved no KYC não substitui active no cliente. Confira has_accepted_terms_of_service e endorsements da rota. Estados ausentes ou desconhecidos não autorizam operações.
GET/v1/customers/{customer}
Autenticação BearerEscopo customers:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Clientes
Atualizar cliente
A operação acessa somente recursos vinculados à sua organização. Para solicitar a habilitação de cripto para cripto, envie endorsements: ["crypto_to_crypto"] na criação ou no PUT do customer existente. Consulte endorsements[].name e status no GET do customer; aguarde crypto_to_crypto com status approved. Guia: https://docs.everbridge.com.br/#endorsements. Suporta evidências de identidade; limite de 24 MB de arquivos decodificados e 36 MiB de JSON. Campos verified_* são bloqueados. Guia: https://docs.everbridge.com.br/#kyc-direct. Status do cliente: not_started: Verificação não iniciada. incomplete: Dados ou documentos incompletos. awaiting_questionnaire: Questionário pendente. awaiting_ubo: Beneficiários finais da empresa pendentes. under_review: Cadastro em análise. active: Cadastro ativo. rejected: Cadastro não aprovado. paused: Cadastro pausado para revisão. deposits_restricted: Novos depósitos restritos. offboarded: Cadastro encerrado após revisão. Use o status do cliente como referência operacional após obter customer_id. O kyc_status acompanha a verificação por link e também pode refletir restrições. approved no KYC não substitui active no cliente. Confira has_accepted_terms_of_service e endorsements da rota. Estados ausentes ou desconhecidos não autorizam operações.
PUT/v1/customers/{customer}
Autenticação BearerEscopo customers:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO',
method='PUT',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"endorsements\":[\"crypto_to_crypto\"]}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
typestring
Tipo de cliente.
individualbusiness
first_namestring
Primeiro nome.
middle_namestring
Nome intermediário.
last_namestring
Sobrenome.
transliterated_first_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
transliterated_middle_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
transliterated_last_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
emailstring
E-mail do titular.
phonestring
Telefone com código internacional.
residential_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
transliterated_residential_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
birth_datestring
Data de nascimento no formato YYYY-MM-DD.
signed_agreement_idstring
Identificador de aceite válido dos termos. Não fabrique este valor.
endorsementsarray [string]
Habilitações solicitadas por customer. Para transferências cripto entre wallets, solicite crypto_to_crypto e aguarde status approved. Consulte o guia de habilitações; solicitar não aprova nem cria uma carteira.
account_purposestring
Finalidade da conta.
account_purpose_otherstring
Descrição quando a finalidade exigir complemento.
employment_statusstring
Situação profissional.
expected_monthly_payments_usdstring,integer
Pessoa física: faixa 0_4999, 5000_9999, 10000_49999 ou 50000_plus. Empresa: valor inteiro esperado em USD.
acting_as_intermediaryboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
most_recent_occupationstring
Ocupação mais recente.
source_of_fundsstring
Origem dos recursos conforme a classificação aprovada para o cadastro.
nationalitystring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
nationalitiesarray [string]
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
place_of_birthobject
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.Campos do objeto
countrystring
Campo específico do recurso.
citystring
Campo específico do recurso.
liveness_check_selfiesarray [object]
Imagens de selfie para análise, não vídeos. Data URI Base64, no mínimo 200 × 200 pixels, até 15 MB cada, até três imagens. Não significa prova de vida aprovada. Alguns perfis exigem verificação complementar hospedada.Campos de cada item
imagestring
Campo específico do recurso.
identifying_informationarray [object]
Identificação fiscal e documentos. image_front/image_back usam data URI Base64; até 15 MB por lado e 24 MB pelo par.Campos de cada item
Comprovantes adicionais. Informe purposes, file em data URI Base64 e description quando exigido. Até 24 MB por arquivo; finalidades aceitas dependem de individual/business.Campos de cada item
purposesarray [string]
Campo específico do recurso.
filestring
Campo específico do recurso.
descriptionstring
Campo específico do recurso.
client_reference_idstring
Referência da operação no seu sistema. Não substitui Idempotency-Key.
business_legal_namestring
Razão social.
transliterated_business_legal_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
business_trade_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
transliterated_business_trade_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
business_descriptionstring
Descrição das atividades.
has_foreign_tax_registrationboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
business_typestring
Tipo jurídico.
primary_websitestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
other_websitesarray [string]
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
registered_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
transliterated_registered_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
physical_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
transliterated_physical_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
is_daoboolean
Indica organização autônoma descentralizada.
compliance_screening_explanationstring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
business_industryarray [string]
Lista de códigos de atividade NAICS, como ["541511"].
publicly_traded_listingsarray [object]
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.Campos de cada item
market_identifier_codestring
Campo específico do recurso.
stock_numberstring
Campo específico do recurso.
tickerstring
Campo específico do recurso.
ownership_thresholdinteger
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
has_material_intermediary_ownershipboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
estimated_annual_revenue_usdstring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / KYC e termos
Obter link de KYC do cliente
A operação acessa somente recursos vinculados à sua organização.
GET/v1/customers/{customer}/kyc_link
Autenticação BearerEscopo kyc:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/kyc_link' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/kyc_link', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/kyc_link',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Parâmetros de consulta
Campo
Descrição
redirect_uristring
URL HTTPS cuja origem esteja autorizada.
endorsementstring
Habilitação para a qual deseja obter o link de verificação, como crypto_to_crypto. Consulte também endorsements[].requirements do customer.
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
application/json
{
"kyc_link": "URL_DE_VERIFICACAO_RETORNADA"
}
Erros e operação
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / KYC e termos
Obter link de aceite dos termos
A operação acessa somente recursos vinculados à sua organização.
GET/v1/customers/{customer}/tos_acceptance_link
Autenticação BearerEscopo kyc:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/tos_acceptance_link' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/tos_acceptance_link', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/tos_acceptance_link',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
application/json
{
"url": "URL_DE_ACEITE_RETORNADA"
}
Erros e operação
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / KYC e termos
Simular aprovação em sandbox
A operação acessa somente recursos vinculados à sua organização. Disponível exclusivamente em ambiente sandbox; produção responde 403 sandbox_only.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/simulate_kyc_approval',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Corpo da requisição
Envie um objeto vazio: {}.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
application/json
{
"status": "accepted"
}
Erros e operação
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
Exclusivo de sandbox. Produção retorna 403 sandbox_only.
REFERÊNCIA / Clientes
Cadastrar representante
A operação acessa somente recursos vinculados à sua organização. Salve o id retornado e associe-o ao registro correspondente no seu sistema. O recurso fica vinculado à organização autenticada, não exclusivamente à chave que o criou. Suporta evidências de identidade; limite de 24 MB de arquivos decodificados e 36 MiB de JSON. Campos verified_* são bloqueados. Guia: https://docs.everbridge.com.br/#kyc-direct.
POST/v1/customers/{customer}/associated_persons
Autenticação BearerEscopo customers:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/associated_persons',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"first_name\":\"Marina\",\"last_name\":\"Exemplo\",\"email\":\"marina@example.com\",\"has_control\":true,\"is_signer\":true,\"title\":\"Diretora\"}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
first_namestring
Primeiro nome.
middle_namestring
Nome intermediário.
last_namestring
Sobrenome.
transliterated_first_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
transliterated_middle_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
transliterated_last_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
emailstring
E-mail do titular.
phonestring
Telefone com código internacional.
residential_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
transliterated_residential_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
birth_datestring
Data de nascimento no formato YYYY-MM-DD.
nationalitystring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
nationalitiesarray [string]
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
place_of_birthobject
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.Campos do objeto
countrystring
Campo específico do recurso.
citystring
Campo específico do recurso.
has_ownershipboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
has_controlboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
is_signerboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
is_directorboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
titlestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
ownership_percentageinteger
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
relationship_established_atstring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
identifying_informationarray [object]
Identificação fiscal e documentos. image_front/image_back usam data URI Base64; até 15 MB por lado e 24 MB pelo par.Campos de cada item
Comprovantes adicionais. Informe purposes, file em data URI Base64 e description quando exigido. Até 24 MB por arquivo; finalidades aceitas dependem de individual/business.Campos de cada item
purposesarray [string]
Campo específico do recurso.
filestring
Campo específico do recurso.
descriptionstring
Campo específico do recurso.
Resposta
200 / 201 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Clientes
Listar representantes
A operação acessa somente recursos vinculados à sua organização. A coleção usa data.
GET/v1/customers/{customer}/associated_persons
Autenticação BearerEscopo customers:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/associated_persons?limit=20' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/associated_persons?limit=20', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/associated_persons?limit=20',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Clientes
Consultar representante
A operação acessa somente recursos vinculados à sua organização.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Clientes
Atualizar representante
A operação acessa somente recursos vinculados à sua organização. Suporta evidências de identidade; limite de 24 MB de arquivos decodificados e 36 MiB de JSON. Campos verified_* são bloqueados. Guia: https://docs.everbridge.com.br/#kyc-direct.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/associated_persons/recurso_EXEMPLO',
method='PUT',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"first_name\":\"Marina\",\"last_name\":\"Exemplo\",\"email\":\"marina@example.com\",\"has_control\":true,\"is_signer\":true,\"title\":\"Diretora\"}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
idstringObrigatório*
ID do recurso indicado no caminho.
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
first_namestring
Primeiro nome.
middle_namestring
Nome intermediário.
last_namestring
Sobrenome.
transliterated_first_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
transliterated_middle_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
transliterated_last_namestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
emailstring
E-mail do titular.
phonestring
Telefone com código internacional.
residential_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
transliterated_residential_addressobject
Endereço físico. País ISO de três letras; subdivision identifica estado ou região.Campos do objeto
street_line_1string
Campo específico do recurso.
street_line_2string
Campo específico do recurso.
citystring
Campo específico do recurso.
subdivisionstring
Campo específico do recurso.
postal_codestring
Campo específico do recurso.
countrystring
Campo específico do recurso.
birth_datestring
Data de nascimento no formato YYYY-MM-DD.
nationalitystring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
nationalitiesarray [string]
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
place_of_birthobject
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.Campos do objeto
countrystring
Campo específico do recurso.
citystring
Campo específico do recurso.
has_ownershipboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
has_controlboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
is_signerboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
is_directorboolean
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
titlestring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
ownership_percentageinteger
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
relationship_established_atstring
Informação de identificação. Requisitos variam conforme perfil e país; consulte o guia de KYC direto.
identifying_informationarray [object]
Identificação fiscal e documentos. image_front/image_back usam data URI Base64; até 15 MB por lado e 24 MB pelo par.Campos de cada item
Comprovantes adicionais. Informe purposes, file em data URI Base64 e description quando exigido. Até 24 MB por arquivo; finalidades aceitas dependem de individual/business.Campos de cada item
purposesarray [string]
Campo específico do recurso.
filestring
Campo específico do recurso.
descriptionstring
Campo específico do recurso.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Clientes
Excluir representante
A operação acessa somente recursos vinculados à sua organização. Suporta evidências de identidade; limite de 24 MB de arquivos decodificados e 36 MiB de JSON. Campos verified_* são bloqueados. Guia: https://docs.everbridge.com.br/#kyc-direct.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Carteiras
Criar carteira
A operação acessa somente recursos vinculados à sua organização. Salve o id retornado e associe-o ao registro correspondente no seu sistema. O recurso fica vinculado à organização autenticada, não exclusivamente à chave que o criou.
POST/v1/customers/{customer}/wallets
Autenticação BearerEscopo wallets:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/wallets',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"chain\":\"base\"}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
chainstringObrigatório*
Rede habilitada para a carteira ou endereço, por exemplo base ou solana.
Resposta
200 / 201 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Carteiras
Listar carteira
A operação acessa somente recursos vinculados à sua organização. A coleção usa data. Para continuar, use o id do último item como starting_after, com os mesmos filtros.
GET/v1/customers/{customer}/wallets
Autenticação BearerEscopo wallets:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/wallets?limit=20' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/wallets?limit=20', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/wallets?limit=20',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Parâmetros de consulta
Campo
Descrição
limitinteger
Tamanho da página, de 1 a 100. Informe explicitamente para controlar o lote.
starting_afterstring
ID do último item da página anterior.
ending_beforestring
ID anterior ao qual consultar a página.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Carteiras
Consultar carteira
A operação acessa somente recursos vinculados à sua organização.
GET/v1/customers/{customer}/wallets/{id}
Autenticação BearerEscopo wallets:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/wallets/wal_EXEMPLO' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/wallets/wal_EXEMPLO', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/wallets/wal_EXEMPLO',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
idstringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Contas externas e Pix
Criar conta externa
A operação acessa somente recursos vinculados à sua organização. Salve o id retornado e associe-o ao registro correspondente no seu sistema. O recurso fica vinculado à organização autenticada, não exclusivamente à chave que o criou.
POST/v1/customers/{customer}/external_accounts
Autenticação BearerEscopo accounts:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/external_accounts',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"currency\":\"brl\",\"account_type\":\"pix\",\"account_owner_name\":\"Marina Exemplo\",\"bank_name\":\"BANCO_DO_TITULAR\",\"pix_key\":{\"pix_key\":\"marina@example.com\",\"document_number\":\"CPF_OU_CNPJ\"}}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
currencystringObrigatório*
Moeda em minúsculas, por exemplo brl, usd ou usdc.
account_typestringObrigatório*
Estrutura bancária, como pix, us, iban ou clabe.
bank_namestring
Nome do banco.
account_owner_namestring
Nome do titular ou razão social.
account_owner_typestring
Tipo de titular.
individualbusiness
first_namestring
Primeiro nome.
last_namestring
Sobrenome.
business_namestring
Nome da empresa titular.
ibanobject
Conta IBAN.Campos do objeto
account_numberstring
IBAN completo.
countrystring
País ISO de três letras.
bicstring
BIC/SWIFT.
usobject
Estrutura específica da rota. Confirme os campos do corredor habilitado com a equipe Everbridge; não combine estruturas bancárias incompatíveis.
accountobject
Dados bancários de acordo com account_type.Campos do objeto
account_numberstring
Número da conta.
routing_numberstring
Código de roteamento.
checking_or_savingsstring
checking ou savings, quando aplicável.
sort_codestring
Sort code, quando aplicável.
clabeobject
Conta mexicana.Campos do objeto
account_numberstring
CLABE.
pixobject
Estrutura específica da rota. Confirme os campos do corredor habilitado com a equipe Everbridge; não combine estruturas bancárias incompatíveis.
pix_keyobject
Destino Pix por chave.Campos do objeto
pix_keystringObrigatório*
Chave Pix do titular.
document_numberstringObrigatório*
CPF/CNPJ do titular, apenas dígitos.
br_codeobject
Destino Pix por código copia e cola.Campos do objeto
br_codestringObrigatório*
Código Pix completo.
document_numberstringObrigatório*
CPF/CNPJ do titular, apenas dígitos.
swiftobject
Estrutura específica da rota. Confirme os campos do corredor habilitado com a equipe Everbridge; não combine estruturas bancárias incompatíveis.
sepaobject
Estrutura específica da rota. Confirme os campos do corredor habilitado com a equipe Everbridge; não combine estruturas bancárias incompatíveis.
achobject
Estrutura específica da rota. Confirme os campos do corredor habilitado com a equipe Everbridge; não combine estruturas bancárias incompatíveis.
wireobject
Estrutura específica da rota. Confirme os campos do corredor habilitado com a equipe Everbridge; não combine estruturas bancárias incompatíveis.
account_numberstring
Número bancário, quando exigido pela rota.
routing_numberstring
Código de roteamento, quando exigido pela rota.
account_owner_addressobject
Endereço do titular. Os campos exigidos dependem do país.Campos do objeto
street_line_1string
Logradouro e número.
street_line_2string
Complemento.
citystring
Cidade.
statestring
Estado ou região.
postal_codestring
Código postal.
countrystring
Código ISO de três letras, como BRA.
addressobject
Endereço do titular. Os campos exigidos dependem do país.Campos do objeto
street_line_1string
Logradouro e número.
street_line_2string
Complemento.
citystring
Cidade.
statestring
Estado ou região.
postal_codestring
Código postal.
countrystring
Código ISO de três letras, como BRA.
Resposta
200 / 201 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Contas externas e Pix
Listar conta externa
A operação acessa somente recursos vinculados à sua organização. A coleção usa data. Para continuar, use o id do último item como starting_after, com os mesmos filtros.
GET/v1/customers/{customer}/external_accounts
Autenticação BearerEscopo accounts:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/external_accounts?limit=20' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/external_accounts?limit=20', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/external_accounts?limit=20',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Parâmetros de consulta
Campo
Descrição
limitinteger
Tamanho da página, de 1 a 100. Informe explicitamente para controlar o lote.
starting_afterstring
ID do último item da página anterior.
ending_beforestring
ID anterior ao qual consultar a página.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Contas externas e Pix
Consultar conta externa
A operação acessa somente recursos vinculados à sua organização.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Contas virtuais
Criar conta virtual
A operação acessa somente recursos vinculados à sua organização. Salve o id retornado e associe-o ao registro correspondente no seu sistema. O recurso fica vinculado à organização autenticada, não exclusivamente à chave que o criou. Para BRL/Pix, source_deposit_instructions contém currency, br_code (copia e cola), account_holder_name e payment_rails. Gere a imagem QR a partir do br_code exato; não há imagem PNG/base64 garantida. A conta é reutilizável, sem expires_at documentado neste formato. Isso não garante disponibilidade permanente: consulte seu estado. Não há suporte a BR Code com valor fixo; não altere o código para inserir o valor da cobrança. A mesma chave pode criar contas para diferentes clientes da sua organização, conforme permissões e habilitações. O customer_id no caminho define o titular; source define a entrada e destination define o destino dos recursos. O Pix recebido é identificado pelas instruções da conta virtual utilizada, não pela chave de API. Não existe conta recebedora padrão por token. Guia: https://docs.everbridge.com.br/#organizations.
POST/v1/customers/{customer}/virtual_accounts
Autenticação BearerEscopo accounts:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/virtual_accounts',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"source\":{\"currency\":\"brl\"},\"destination\":{\"currency\":\"usdc\",\"payment_rail\":\"wallet\",\"wallet_id\":\"wal_EXEMPLO\"}}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
sourceobjectObrigatório*
Rota de pagamento. Informe os dados adequados à moeda e ao método habilitados.Campos do objeto
currencystring
Moeda em minúsculas, por exemplo brl, usd ou usdc.
payment_railstring
Método de pagamento, como pix, ach, wire, sepa, base, solana ou wallet. Disponibilidade depende da habilitação.
wallet_idstring
Identificador opaco. Preserve o valor retornado pela API.
external_account_idstring
Identificador opaco. Preserve o valor retornado pela API.
addressstring
Endereço on-chain. Use somente rede e ativo compatíveis.
from_addressstring
Endereço de origem, quando aplicável.
to_addressstring
Endereço de destino, quando aplicável.
return_addressstring
Endereço para devolução.
return_memostring
Memo de devolução.
blockchain_memostring
Memo ou tag exigido pela rede.
referencestring
Referência bancária.
imadstring
Identificador de rastreio de wire.
bank_beneficiary_namestring
Nome do beneficiário.
bank_beneficiary_addressstring
Endereço do beneficiário.
bank_routing_numberstring
Código de roteamento bancário.
bank_account_numberstring
Número da conta.
bank_namestring
Nome do banco.
bank_addressstring
Endereço do banco.
sender_namestring
Nome do remetente.
sender_addressstring
Endereço do remetente.
destinationobjectObrigatório*
Rota de pagamento. Informe os dados adequados à moeda e ao método habilitados.Campos do objeto
currencystring
Moeda em minúsculas, por exemplo brl, usd ou usdc.
payment_railstring
Método de pagamento, como pix, ach, wire, sepa, base, solana ou wallet. Disponibilidade depende da habilitação.
wallet_idstring
Identificador opaco. Preserve o valor retornado pela API.
external_account_idstring
Identificador opaco. Preserve o valor retornado pela API.
addressstring
Endereço on-chain. Use somente rede e ativo compatíveis.
from_addressstring
Endereço de origem, quando aplicável.
to_addressstring
Endereço de destino, quando aplicável.
return_addressstring
Endereço para devolução.
return_memostring
Memo de devolução.
blockchain_memostring
Memo ou tag exigido pela rede.
referencestring
Referência bancária.
imadstring
Identificador de rastreio de wire.
bank_beneficiary_namestring
Nome do beneficiário.
bank_beneficiary_addressstring
Endereço do beneficiário.
bank_routing_numberstring
Código de roteamento bancário.
bank_account_numberstring
Número da conta.
bank_namestring
Nome do banco.
bank_addressstring
Endereço do banco.
sender_namestring
Nome do remetente.
sender_addressstring
Endereço do remetente.
developer_fee_percentstring
Percentual de tarifa da integração, de 0 inclusive a 100 exclusive, sujeito à habilitação.
travel_rule_dataobject
Informações de origem e destino exigidas para compliance.Campos do objeto
originatorobject
Parte da operação. O conjunto exigido depende da rota e do tipo de carteira.Campos do objeto
wallet_typestring
Tipo de carteira, por exemplo self_custodied.
is_selfboolean
Indica se a parte é o próprio titular.
beneficiaryobject
Parte da operação. O conjunto exigido depende da rota e do tipo de carteira.Campos do objeto
wallet_typestring
Tipo de carteira, por exemplo self_custodied.
is_selfboolean
Indica se a parte é o próprio titular.
Resposta
200 / 201 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Contas virtuais
Listar conta virtual
A operação acessa somente recursos vinculados à sua organização. A coleção usa data. Para continuar, use o id do último item como starting_after, com os mesmos filtros. Para BRL/Pix, source_deposit_instructions contém currency, br_code (copia e cola), account_holder_name e payment_rails. Gere a imagem QR a partir do br_code exato; não há imagem PNG/base64 garantida. A conta é reutilizável, sem expires_at documentado neste formato. Isso não garante disponibilidade permanente: consulte seu estado. Não há suporte a BR Code com valor fixo; não altere o código para inserir o valor da cobrança.
GET/v1/customers/{customer}/virtual_accounts
Autenticação BearerEscopo accounts:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/virtual_accounts?limit=20' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/virtual_accounts?limit=20', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/virtual_accounts?limit=20',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Parâmetros de consulta
Campo
Descrição
limitinteger
Tamanho da página, de 1 a 100. Informe explicitamente para controlar o lote.
starting_afterstring
ID do último item da página anterior.
ending_beforestring
ID anterior ao qual consultar a página.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Contas virtuais
Consultar conta virtual
A operação acessa somente recursos vinculados à sua organização. Para BRL/Pix, source_deposit_instructions contém currency, br_code (copia e cola), account_holder_name e payment_rails. Gere a imagem QR a partir do br_code exato; não há imagem PNG/base64 garantida. A conta é reutilizável, sem expires_at documentado neste formato. Isso não garante disponibilidade permanente: consulte seu estado. Não há suporte a BR Code com valor fixo; não altere o código para inserir o valor da cobrança.
GET/v1/customers/{customer}/virtual_accounts/{id}
Autenticação BearerEscopo accounts:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/virtual_accounts/recurso_EXEMPLO' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/virtual_accounts/recurso_EXEMPLO', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/virtual_accounts/recurso_EXEMPLO',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
idstringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Liquidação
Criar endereço de liquidação
A operação acessa somente recursos vinculados à sua organização. Salve o id retornado e associe-o ao registro correspondente no seu sistema. O recurso fica vinculado à organização autenticada, não exclusivamente à chave que o criou.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/liquidation_addresses',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"chain\":\"base\",\"currency\":\"usdc\",\"external_account_id\":\"acc_EXEMPLO\",\"destination_payment_rail\":\"pix\",\"destination_currency\":\"brl\"}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
chainstringObrigatório*
Rede habilitada para a carteira ou endereço, por exemplo base ou solana.
currencystringObrigatório*
Moeda em minúsculas, por exemplo brl, usd ou usdc.
external_account_idstring
Identificador opaco. Preserve o valor retornado pela API.
destination_payment_railstring
Método de saída, por exemplo pix.
destination_currencystring
Moeda de saída, por exemplo brl.
destinationobject
Rota de pagamento. Informe os dados adequados à moeda e ao método habilitados.Campos do objeto
currencystring
Moeda em minúsculas, por exemplo brl, usd ou usdc.
payment_railstring
Método de pagamento, como pix, ach, wire, sepa, base, solana ou wallet. Disponibilidade depende da habilitação.
wallet_idstring
Identificador opaco. Preserve o valor retornado pela API.
external_account_idstring
Identificador opaco. Preserve o valor retornado pela API.
addressstring
Endereço on-chain. Use somente rede e ativo compatíveis.
from_addressstring
Endereço de origem, quando aplicável.
to_addressstring
Endereço de destino, quando aplicável.
return_addressstring
Endereço para devolução.
return_memostring
Memo de devolução.
blockchain_memostring
Memo ou tag exigido pela rede.
referencestring
Referência bancária.
imadstring
Identificador de rastreio de wire.
bank_beneficiary_namestring
Nome do beneficiário.
bank_beneficiary_addressstring
Endereço do beneficiário.
bank_routing_numberstring
Código de roteamento bancário.
bank_account_numberstring
Número da conta.
bank_namestring
Nome do banco.
bank_addressstring
Endereço do banco.
sender_namestring
Nome do remetente.
sender_addressstring
Endereço do remetente.
return_addressstring
Endereço de devolução.
return_memostring
Memo de devolução.
return_instructionsobject
Dados para devolução on-chain.Campos do objeto
addressstringObrigatório*
Endereço compatível com a rede.
blockchain_memostring
Memo ou tag, se aplicável.
travel_rule_dataobject
Informações de origem e destino exigidas para compliance.Campos do objeto
originatorobject
Parte da operação. O conjunto exigido depende da rota e do tipo de carteira.Campos do objeto
wallet_typestring
Tipo de carteira, por exemplo self_custodied.
is_selfboolean
Indica se a parte é o próprio titular.
beneficiaryobject
Parte da operação. O conjunto exigido depende da rota e do tipo de carteira.Campos do objeto
wallet_typestring
Tipo de carteira, por exemplo self_custodied.
is_selfboolean
Indica se a parte é o próprio titular.
custom_developer_fee_percentstring
Percentual personalizado para liquidação; menor que 100.
developer_fee_percentstring
Percentual de tarifa da integração, de 0 inclusive a 100 exclusive, sujeito à habilitação.
Resposta
200 / 201 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Liquidação
Listar endereço de liquidação
A operação acessa somente recursos vinculados à sua organização. A coleção usa data. Para continuar, use o id do último item como starting_after, com os mesmos filtros.
GET/v1/customers/{customer}/liquidation_addresses
Autenticação BearerEscopo accounts:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/liquidation_addresses?limit=20' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/liquidation_addresses?limit=20', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/liquidation_addresses?limit=20',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Parâmetros de consulta
Campo
Descrição
limitinteger
Tamanho da página, de 1 a 100. Informe explicitamente para controlar o lote.
starting_afterstring
ID do último item da página anterior.
ending_beforestring
ID anterior ao qual consultar a página.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Liquidação
Consultar endereço de liquidação
A operação acessa somente recursos vinculados à sua organização.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Carteiras
Consultar carteira por ID
A operação acessa somente recursos vinculados à sua organização.
GET/v1/wallets/{id}
Autenticação BearerEscopo wallets:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/wallets/wal_EXEMPLO' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/wallets/wal_EXEMPLO', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/wallets/wal_EXEMPLO',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Carteiras
Consultar histórico da wallet
Histórico de atividades da wallet da sua organização. Escopo wallets:read. Itens em data; id identifica a atividade e wallet_id a carteira recebedora. type=direct_deposit identifica entrada direta on-chain; deposit pode representar outra rota de entrada. source.from_address é a carteira remetente quando fornecida; destination.tx_hash é o hash quando disponível. Endereço de origem pode faltar e não garante identidade de pessoa. Deduplique por wallet_id + id e concilie com transferências/contas virtuais relacionadas para não creditar duas vezes. Paginação por starting_after ou ending_before usando o id de uma atividade previamente consultada desta mesma wallet. Guia: https://docs.everbridge.com.br/#webhooks.
GET/v1/wallets/{id}/history
Autenticação BearerEscopo wallets:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/wallets/wal_EXEMPLO/history' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/wallets/wal_EXEMPLO/history', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/wallets/wal_EXEMPLO/history',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Parâmetros de consulta
Campo
Descrição
limitinteger
Tamanho da página, de 1 a 100. Informe explicitamente para controlar o lote.
starting_afterstring
ID do último item da página anterior.
ending_beforestring
ID anterior ao qual consultar a página.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Carteiras
Consultar histórico da wallet
Histórico de atividades da wallet da sua organização. Escopo wallets:read. Itens em data; id identifica a atividade e wallet_id a carteira recebedora. type=direct_deposit identifica entrada direta on-chain; deposit pode representar outra rota de entrada. source.from_address é a carteira remetente quando fornecida; destination.tx_hash é o hash quando disponível. Endereço de origem pode faltar e não garante identidade de pessoa. Deduplique por wallet_id + id e concilie com transferências/contas virtuais relacionadas para não creditar duas vezes. Paginação por starting_after ou ending_before usando o id de uma atividade previamente consultada desta mesma wallet. Guia: https://docs.everbridge.com.br/#webhooks.
GET/v1/customers/{customer}/wallets/{id}/history
Autenticação BearerEscopo wallets:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/wallets/wal_EXEMPLO/history' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/wallets/wal_EXEMPLO/history', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/wallets/wal_EXEMPLO/history',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
idstringObrigatório*
ID do recurso indicado no caminho.
Parâmetros de consulta
Campo
Descrição
limitinteger
Tamanho da página, de 1 a 100. Informe explicitamente para controlar o lote.
starting_afterstring
ID do último item da página anterior.
ending_beforestring
ID anterior ao qual consultar a página.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Contas externas e Pix
Excluir conta externa
A operação acessa somente recursos vinculados à sua organização.
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/external_accounts/recurso_EXEMPLO', {
method: 'DELETE',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN,
'Idempotency-Key': 'pedido-2026-0001'
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/external_accounts/recurso_EXEMPLO',
method='DELETE',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001'
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
idstringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
application/json
{
"status": "deleted"
}
Erros e operação
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Contas virtuais
Atualizar conta virtual
A operação acessa somente recursos vinculados à sua organização. Para BRL/Pix, source_deposit_instructions contém currency, br_code (copia e cola), account_holder_name e payment_rails. Gere a imagem QR a partir do br_code exato; não há imagem PNG/base64 garantida. A conta é reutilizável, sem expires_at documentado neste formato. Isso não garante disponibilidade permanente: consulte seu estado. Não há suporte a BR Code com valor fixo; não altere o código para inserir o valor da cobrança.
PUT/v1/customers/{customer}/virtual_accounts/{id}
Autenticação BearerEscopo accounts:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/virtual_accounts/recurso_EXEMPLO',
method='PUT',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"destination\":{\"currency\":\"usdc\",\"payment_rail\":\"wallet\",\"wallet_id\":\"wal_EXEMPLO\"}}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
idstringObrigatório*
ID do recurso indicado no caminho.
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
destinationobject
Rota de pagamento. Informe os dados adequados à moeda e ao método habilitados.Campos do objeto
currencystring
Moeda em minúsculas, por exemplo brl, usd ou usdc.
payment_railstring
Método de pagamento, como pix, ach, wire, sepa, base, solana ou wallet. Disponibilidade depende da habilitação.
wallet_idstring
Identificador opaco. Preserve o valor retornado pela API.
external_account_idstring
Identificador opaco. Preserve o valor retornado pela API.
addressstring
Endereço on-chain. Use somente rede e ativo compatíveis.
from_addressstring
Endereço de origem, quando aplicável.
to_addressstring
Endereço de destino, quando aplicável.
return_addressstring
Endereço para devolução.
return_memostring
Memo de devolução.
blockchain_memostring
Memo ou tag exigido pela rede.
referencestring
Referência bancária.
imadstring
Identificador de rastreio de wire.
bank_beneficiary_namestring
Nome do beneficiário.
bank_beneficiary_addressstring
Endereço do beneficiário.
bank_routing_numberstring
Código de roteamento bancário.
bank_account_numberstring
Número da conta.
bank_namestring
Nome do banco.
bank_addressstring
Endereço do banco.
sender_namestring
Nome do remetente.
sender_addressstring
Endereço do remetente.
developer_fee_percentstring
Percentual de tarifa da integração, de 0 inclusive a 100 exclusive, sujeito à habilitação.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Contas virtuais
Desativar conta virtual
A operação acessa somente recursos vinculados à sua organização. Interrompe o uso da conta virtual conforme seu estado. Confirme o resultado consultando o recurso. Para BRL/Pix, source_deposit_instructions contém currency, br_code (copia e cola), account_holder_name e payment_rails. Gere a imagem QR a partir do br_code exato; não há imagem PNG/base64 garantida. A conta é reutilizável, sem expires_at documentado neste formato. Isso não garante disponibilidade permanente: consulte seu estado. Não há suporte a BR Code com valor fixo; não altere o código para inserir o valor da cobrança.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Contas virtuais
Reativar conta virtual
A operação acessa somente recursos vinculados à sua organização. Para BRL/Pix, source_deposit_instructions contém currency, br_code (copia e cola), account_holder_name e payment_rails. Gere a imagem QR a partir do br_code exato; não há imagem PNG/base64 garantida. A conta é reutilizável, sem expires_at documentado neste formato. Isso não garante disponibilidade permanente: consulte seu estado. Não há suporte a BR Code com valor fixo; não altere o código para inserir o valor da cobrança.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Contas virtuais
Consultar histórico da conta
A operação acessa somente recursos vinculados à sua organização. Tipos de atividade: funds_received: Entrada de recursos. payment_submitted: Envio ao destino iniciado. payment_processed: Entrega on-chain confirmada. in_review: Depósito em análise. refunded: Recursos devolvidos. funds_scheduled: Entrada programada, específica de ACH. account_update: Conta atualizada. activation: Conta ativada. deactivation: Conta desativada. reactivation: Conta reativada. microdeposit: Microdepósito de verificação, sem conversão. refund_in_flight: Devolução em andamento. refund: Devolução concluída. refund_failed: Falha na devolução. drain: Saída de recursos da conta. close: Conta encerrada. A atividade usa type; a transferência usa state. Agrupe etapas pelo deposit_id dentro da conta e organização. Compare a cobrança com o valor bruto de entrada amount e currency=brl no recebimento; não use o líquido após taxas nem o valor convertido. R$ 100 cobrados e R$ 90 recebidos significam pagamento parcial, com R$ 10 pendentes. A aplicação vincula depósitos às cobranças e trata vencimentos, excedentes e devoluções. Guia: https://docs.everbridge.com.br/#pix-reconciliation.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Liquidação
Consultar liquidações
A operação acessa somente recursos vinculados à sua organização.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Transferências
Criar transferência
A operação acessa somente recursos vinculados à sua organização. Salve o id retornado e associe-o ao registro correspondente no seu sistema. O recurso fica vinculado à organização autenticada, não exclusivamente à chave que o criou. Exige transferências habilitadas, limites na moeda de origem e habilitação do titular para a rota. Entre wallets cripto, solicite crypto_to_crypto no customer e confira sua aprovação em endorsements; veja https://docs.everbridge.com.br/#endorsements. source.wallet_id deve pertencer ao customer de on_behalf_of. destination.wallet_id pode pertencer a outro customer da mesma organização; wallets de outras organizações são recusadas. As demais referências continuam vinculadas ao titular da operação. A transferência permanece associada a on_behalf_of, sem alterar o titular das wallets. A resposta inicial não comprova liquidação. Guia: https://docs.everbridge.com.br/#transfers. Estados conhecidos de state: awaiting_funds: Aguardando recursos. in_review: Operação em análise. funds_received: Recursos recebidos; processamento pendente. payment_submitted: Pagamento enviado; confirmação pendente. payment_processed: Entrega ao destino concluída. undeliverable: Não foi possível entregar ao destino. returned: Pagamento retornou; devolução ao remetente em andamento. missing_return_policy: Falta configurar a política de devolução de cripto. refund_in_flight: Devolução em processamento. refunded: Recursos devolvidos. refund_failed: Falha na devolução; requer tratamento. canceled: Transferência cancelada. error: Processamento bloqueado por erro. funds_received não comprova entrega ao destino. Use o hash final de payment_processed. Trate estados desconhecidos como pendência de conciliação, nunca como sucesso. Guia: https://docs.everbridge.com.br/#transfers-states.
POST/v1/transfers
Autenticação BearerEscopo transfers:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/transfers',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"amount\":\"10.00\",\"on_behalf_of\":\"cus_EXEMPLO\",\"source\":{\"currency\":\"usdc\",\"payment_rail\":\"wallet\",\"wallet_id\":\"wal_EXEMPLO\"},\"destination\":{\"currency\":\"brl\",\"payment_rail\":\"pix\",\"external_account_id\":\"acc_EXEMPLO\"}}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
amountstringObrigatório*
Valor positivo na moeda source.currency. Envie string decimal com ponto; nunca número de ponto flutuante. A precisão aceita depende da rota; no saque USDC para BRL/Pix, use até duas casas decimais, como "2.01". A API não arredonda o valor automaticamente.
on_behalf_ofstringObrigatório*
Identificador opaco. Preserve o valor retornado pela API.
sourceobjectObrigatório*
Rota de pagamento. Informe os dados adequados à moeda e ao método habilitados.Campos do objeto
currencystring
Moeda em minúsculas, por exemplo brl, usd ou usdc.
payment_railstring
Método de pagamento, como pix, ach, wire, sepa, base, solana ou wallet. Disponibilidade depende da habilitação.
wallet_idstring
Identificador opaco. Preserve o valor retornado pela API.
external_account_idstring
Identificador opaco. Preserve o valor retornado pela API.
addressstring
Endereço on-chain. Use somente rede e ativo compatíveis.
from_addressstring
Endereço de origem, quando aplicável.
to_addressstring
Endereço de destino, quando aplicável.
return_addressstring
Endereço para devolução.
return_memostring
Memo de devolução.
blockchain_memostring
Memo ou tag exigido pela rede.
referencestring
Referência bancária.
imadstring
Identificador de rastreio de wire.
bank_beneficiary_namestring
Nome do beneficiário.
bank_beneficiary_addressstring
Endereço do beneficiário.
bank_routing_numberstring
Código de roteamento bancário.
bank_account_numberstring
Número da conta.
bank_namestring
Nome do banco.
bank_addressstring
Endereço do banco.
sender_namestring
Nome do remetente.
sender_addressstring
Endereço do remetente.
destinationobjectObrigatório*
Rota de pagamento. Informe os dados adequados à moeda e ao método habilitados.Campos do objeto
currencystring
Moeda em minúsculas, por exemplo brl, usd ou usdc.
payment_railstring
Método de pagamento, como pix, ach, wire, sepa, base, solana ou wallet. Disponibilidade depende da habilitação.
wallet_idstring
Identificador opaco. Preserve o valor retornado pela API.
external_account_idstring
Identificador opaco. Preserve o valor retornado pela API.
addressstring
Endereço on-chain. Use somente rede e ativo compatíveis.
from_addressstring
Endereço de origem, quando aplicável.
to_addressstring
Endereço de destino, quando aplicável.
return_addressstring
Endereço para devolução.
return_memostring
Memo de devolução.
blockchain_memostring
Memo ou tag exigido pela rede.
referencestring
Referência bancária.
imadstring
Identificador de rastreio de wire.
bank_beneficiary_namestring
Nome do beneficiário.
bank_beneficiary_addressstring
Endereço do beneficiário.
bank_routing_numberstring
Código de roteamento bancário.
bank_account_numberstring
Número da conta.
bank_namestring
Nome do banco.
bank_addressstring
Endereço do banco.
sender_namestring
Nome do remetente.
sender_addressstring
Endereço do remetente.
developer_feestring
Tarifa da integração na unidade monetária definida para a operação.
featuresobject
Opções de execução. Recursos dependem da política e da rota.Campos do objeto
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Transferências
Consultar transferência
A operação acessa somente recursos vinculados à sua organização. Estados conhecidos de state: awaiting_funds: Aguardando recursos. in_review: Operação em análise. funds_received: Recursos recebidos; processamento pendente. payment_submitted: Pagamento enviado; confirmação pendente. payment_processed: Entrega ao destino concluída. undeliverable: Não foi possível entregar ao destino. returned: Pagamento retornou; devolução ao remetente em andamento. missing_return_policy: Falta configurar a política de devolução de cripto. refund_in_flight: Devolução em processamento. refunded: Recursos devolvidos. refund_failed: Falha na devolução; requer tratamento. canceled: Transferência cancelada. error: Processamento bloqueado por erro. funds_received não comprova entrega ao destino. Use o hash final de payment_processed. Trate estados desconhecidos como pendência de conciliação, nunca como sucesso. Guia: https://docs.everbridge.com.br/#transfers-states.
GET/v1/transfers/{id}
Autenticação BearerEscopo transfers:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/transfers/tr_EXEMPLO' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/transfers/tr_EXEMPLO', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/transfers/tr_EXEMPLO',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Transferências
Solicitar cancelamento de transferência
A operação acessa somente recursos vinculados à sua organização. Cancelamento depende do estágio da transferência; uma operação já executada pode não ser cancelável.
DELETE/v1/transfers/{id}
Autenticação BearerEscopo transfers:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
const response = await fetch('https://api2.everbridge.com.br/v1/transfers/tr_EXEMPLO', {
method: 'DELETE',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN,
'Idempotency-Key': 'pedido-2026-0001'
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/transfers/tr_EXEMPLO',
method='DELETE',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001'
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
application/json
{
"status": "deleted"
}
Erros e operação
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Transferências
Listar transferência
A operação acessa somente recursos vinculados à sua organização. A coleção usa data. Para continuar, use o id do último item como starting_after, com os mesmos filtros. Estados conhecidos de state: awaiting_funds: Aguardando recursos. in_review: Operação em análise. funds_received: Recursos recebidos; processamento pendente. payment_submitted: Pagamento enviado; confirmação pendente. payment_processed: Entrega ao destino concluída. undeliverable: Não foi possível entregar ao destino. returned: Pagamento retornou; devolução ao remetente em andamento. missing_return_policy: Falta configurar a política de devolução de cripto. refund_in_flight: Devolução em processamento. refunded: Recursos devolvidos. refund_failed: Falha na devolução; requer tratamento. canceled: Transferência cancelada. error: Processamento bloqueado por erro. funds_received não comprova entrega ao destino. Use o hash final de payment_processed. Trate estados desconhecidos como pendência de conciliação, nunca como sucesso. Guia: https://docs.everbridge.com.br/#transfers-states.
GET/v1/customers/{customer}/transfers
Autenticação BearerEscopo transfers:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/transfers?limit=20' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/transfers?limit=20', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/customers/cus_EXEMPLO/transfers?limit=20',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
customerstringObrigatório*
ID do cliente vinculado à sua organização.
Parâmetros de consulta
Campo
Descrição
limitinteger
Tamanho da página, de 1 a 100. Informe explicitamente para controlar o lote.
starting_afterstring
ID do último item da página anterior.
ending_beforestring
ID anterior ao qual consultar a página.
template_idstring
ID de template do mesmo cliente.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Transferências
Listar templates estáticos
A operação acessa somente recursos vinculados à sua organização. A coleção usa data. Para continuar, use o id do último item como starting_after, com os mesmos filtros. Estados conhecidos de state: awaiting_funds: Aguardando recursos. in_review: Operação em análise. funds_received: Recursos recebidos; processamento pendente. payment_submitted: Pagamento enviado; confirmação pendente. payment_processed: Entrega ao destino concluída. undeliverable: Não foi possível entregar ao destino. returned: Pagamento retornou; devolução ao remetente em andamento. missing_return_policy: Falta configurar a política de devolução de cripto. refund_in_flight: Devolução em processamento. refunded: Recursos devolvidos. refund_failed: Falha na devolução; requer tratamento. canceled: Transferência cancelada. error: Processamento bloqueado por erro. funds_received não comprova entrega ao destino. Use o hash final de payment_processed. Trate estados desconhecidos como pendência de conciliação, nunca como sucesso. Guia: https://docs.everbridge.com.br/#transfers-states.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Compliance
Enviar dados de Travel Rule
A operação acessa somente recursos vinculados à sua organização. O id deve pertencer a transferência, conta virtual, endereço de liquidação ou atividade previamente identificada. Envie originator e/ou beneficiary conforme a exigência recebida.
POST/v1/travel_rule_data/{id}
Autenticação BearerEscopo compliance:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/travel_rule_data/recurso_EXEMPLO',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"originator\":{\"wallet_type\":\"self_custodied\",\"is_self\":true}}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
originatorobject
Parte da operação. O conjunto exigido depende da rota e do tipo de carteira.Campos do objeto
wallet_typestring
Tipo de carteira, por exemplo self_custodied.
is_selfboolean
Indica se a parte é o próprio titular.
beneficiaryobject
Parte da operação. O conjunto exigido depende da rota e do tipo de carteira.Campos do objeto
wallet_typestring
Tipo de carteira, por exemplo self_custodied.
is_selfboolean
Indica se a parte é o próprio titular.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
application/json
{
"status": "accepted"
}
Erros e operação
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Integração e eventos
Consultar credencial
Confirme a organização, os escopos, o ambiente e as políticas efetivas do token. Uma organização pode ter várias chaves e vários clientes finais. Chaves da mesma organização com os mesmos escopos acessam os mesmos recursos; uma nova chave não cria uma conta de depósito ou um extrato separado. Guia: https://docs.everbridge.com.br/#organizations.
GET/v1/me
Autenticação BearerEscopo Qualquer chave ativa
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/me' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/me', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/me',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Integração e eventos
Listar recursos vinculados
Inventário de IDs já vinculados à sua organização. Não substitui a consulta ao recurso para obter seu estado atual.
GET/v1/resources
Autenticação BearerEscopo Escopo de leitura do kind solicitado
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/resources?kind=customer' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/resources?kind=customer', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/resources?kind=customer',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de consulta
Campo
Descrição
kindstringObrigatório*
Tipo de recurso. O token precisa do escopo de leitura correspondente.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Integração e eventos
Consumir eventos
Feed autenticado com até 100 eventos por página. Persista eventos e cursor de forma transacional e deduplique por event.event_id. Nas atividades de conta virtual, os dados do depósito ficam em event.event_object. A atividade usa type; a transferência usa state. Agrupe etapas pelo deposit_id dentro da conta e organização. Compare a cobrança com o valor bruto de entrada amount e currency=brl no recebimento; não use o líquido após taxas nem o valor convertido. R$ 100 cobrados e R$ 90 recebidos significam pagamento parcial, com R$ 10 pendentes. A aplicação vincula depósitos às cobranças e trata vencimentos, excedentes e devoluções.
GET/v1/events
Autenticação BearerEscopo events:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/events?after=0' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/events?after=0', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/events?after=0',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de consulta
Campo
Descrição
afterinteger
next_cursor da página anterior. Comece em 0.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Integração e eventos
Consultar auditoria
Histórico das requisições da sua organização, com até 100 registros por página. Não é um extrato financeiro.
GET/v1/audit
Autenticação BearerEscopo audit:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/audit?after=0' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/audit?after=0', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/audit?after=0',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de consulta
Campo
Descrição
afterinteger
next_cursor da página anterior. Comece em 0.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Webhooks
Listar webhooks
Até cinco endpoints por organização. Os segredos não são retornados. Guia: https://docs.everbridge.com.br/#webhooks.
GET/v1/webhooks
Autenticação BearerEscopo webhooks:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/webhooks' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/webhooks', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/webhooks',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Webhooks
Cadastrar webhook
Receba novos eventos da organização. Padrão: virtual_account.activity, transfer e wallet.activity. URL pública HTTPS na porta 443, sem usuário, senha ou fragmento. Não há reenvio automático de eventos anteriores ao cadastro. Salve signing_secret: retornado somente nesta operação e em sua repetição com a mesma Idempotency-Key. Guia: https://docs.everbridge.com.br/#webhooks.
POST/v1/webhooks
Autenticação BearerEscopo webhooks:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/webhooks',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"url\":\"https://app.example.com/webhooks/everbridge\",\"event_categories\":[\"virtual_account.activity\",\"transfer\",\"wallet.activity\"]}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
urlstringObrigatório*
URL HTTPS do backend que recebe as notificações.
event_categoriesarray [string]
Categorias aceitas: virtual_account.activity, transfer, wallet.activity, customer e kyc_link. O padrão continua sendo as três categorias de pagamentos; selecione customer e kyc_link explicitamente. Endpoints existentes preservam sua seleção.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Webhooks
Consultar webhook
Consulta somente endpoints da organização autenticada. Guia: https://docs.everbridge.com.br/#webhooks.
GET/v1/webhooks/{id}
Autenticação BearerEscopo webhooks:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Webhooks
Atualizar assinatura do webhook
Envie active e/ou event_categories. active=false pausa os envios e preserva a fila. Novas categorias recebem somente eventos gravados depois de sua ativação, sem backfill. A lista enviada substitui a seleção atual; inclua as categorias que deseja manter. Entregas já enfileiradas continuam válidas. URL e segredo são preservados; para mudar URL crie outro endpoint. Guia: https://docs.everbridge.com.br/#webhooks.
PATCH/v1/webhooks/{id}
Autenticação BearerEscopo webhooks:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO',
method='PATCH',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"event_categories\":[\"virtual_account.activity\",\"transfer\",\"wallet.activity\",\"customer\",\"kyc_link\"]}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
activeboolean
Ativar ou pausar as entregas.
event_categoriesarray [string]
Categorias aceitas: virtual_account.activity, transfer, wallet.activity, customer e kyc_link. O padrão continua sendo as três categorias de pagamentos; selecione customer e kyc_link explicitamente. Endpoints existentes preservam sua seleção.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Webhooks
Excluir webhook
Cancela entregas pendentes deste endpoint. Requisições em voo podem terminar. Outros endpoints continuam ativos. Guia: https://docs.everbridge.com.br/#webhooks.
DELETE/v1/webhooks/{id}
Autenticação BearerEscopo webhooks:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
const response = await fetch('https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO', {
method: 'DELETE',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN,
'Idempotency-Key': 'pedido-2026-0001'
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO',
method='DELETE',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001'
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
application/json
{
"id": "we_EXEMPLO",
"deleted": true
}
Erros e operação
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Webhooks
Trocar segredo de assinatura
Gera signing_secret novo e incrementa secret_version. Novas tentativas usam o novo segredo; entregas em voo podem usar o anterior. Prepare o receptor para aceitar temporariamente as duas versões. Repetir a mesma Idempotency-Key retorna o resultado original, sem nova rotação. Guia: https://docs.everbridge.com.br/#webhooks.
POST/v1/webhooks/{id}/rotate-secret
Autenticação BearerEscopo webhooks:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Webhooks
Enviar teste de webhook
Enfileira um evento webhook.test com test=true e sem valor monetário. Disponível para endpoint e organização ativos. A resposta indica enfileiramento; confira o resultado nas entregas. Guia: https://docs.everbridge.com.br/#webhooks.
POST/v1/webhooks/{id}/test
Autenticação BearerEscopo webhooks:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Webhooks
Consultar entregas
Até 100 entregas, das mais recentes às mais antigas. Para continuar, envie next_cursor em before. Consulta não altera a fila. Estados: pending, delivering, retrying, delivered, failed e canceled. Guia: https://docs.everbridge.com.br/#webhooks.
GET/v1/webhooks/{id}/deliveries
Autenticação BearerEscopo webhooks:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO/deliveries' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO/deliveries', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO/deliveries',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Parâmetros de consulta
Campo
Descrição
beforeinteger
next_cursor da página anterior. Omitir para consultar as entregas mais recentes.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Webhooks
Detalhar entrega
Inclui o evento exato e as últimas 100 tentativas, da mais recente à mais antiga. Os corpos das respostas do endpoint não são armazenados. http_status nulo indica falha antes de obter uma resposta HTTP. Guia: https://docs.everbridge.com.br/#webhooks.
GET/v1/webhooks/{id}/deliveries/{delivery}
Autenticação BearerEscopo webhooks:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO/deliveries/wd_EXEMPLO' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO/deliveries/wd_EXEMPLO', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/webhooks/we_EXEMPLO/deliveries/wd_EXEMPLO',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
deliverystringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / Webhooks
Reenviar entrega com falha
Disponível apenas para status=failed e endpoint e organização ativos. Abre outro ciclo de até oito tentativas, preservando payload, event_id e ID da entrega. Uma nova Idempotency-Key representa um novo pedido de reenvio. Guia: https://docs.everbridge.com.br/#webhooks.
POST/v1/webhooks/{id}/deliveries/{delivery}/retry
Autenticação BearerEscopo webhooks:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / KYC na Everbridge
Criar cadastro na interface Everbridge
Cria uma sessão de pré-cadastro com acesso temporário de 24 horas. Para um novo usuário, ainda não cria um customer: customer_id é null até o titular aceitar os termos e concluir o envio. O identificador ks_ identifica a sessão; não é customer_id. Requer kyc:write, kyc:read, customers:write e customers:read. A URL é uma credencial restrita: envie somente ao titular. prefill reaproveita dados já coletados; não aceita arquivos ou aceite de termos. customer_id opcional continua um cadastro existente da organização e evita duplicidade. A chave da organização permanece no backend. O formulário não cria contas ou movimenta dinheiro.
POST/v1/kyc_sessions
Autenticação BearerEscopo kyc:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/kyc_sessions',
method='POST',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001',
'Content-Type': 'application/json'
},
data=json.dumps(json.loads("{\"type\":\"individual\",\"endorsements\":[\"crypto_to_crypto\"],\"prefill\":{\"first_name\":\"Marina\",\"last_name\":\"Exemplo\",\"email\":\"marina@example.com\",\"client_reference_id\":\"usuario-123\"}}")).encode()
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Corpo da requisição
JSON. Campos não listados no primeiro nível são rejeitados. Campos marcados são os requisitos básicos deste formato; país, perfil e rota podem exigir dados adicionais.
Campo / tipo
Descrição
endorsementsarray [string]
Habilitações adicionais, como crypto_to_crypto para transferências cripto entre wallets ou sepa. Pix é incluído no envio; aguarde a aprovação em endorsements do customer. Guia: https://docs.everbridge.com.br/#endorsements.
typestringObrigatório*
Campo específico do recurso.
individualbusiness
customer_idstring
ID existente pertencente à organização; omita para um novo cadastro.
prefillobject
Dados do perfil individual/business, sem arquivos. Não envie type, endorsements ou signed_agreement_id dentro de prefill.
redirect_uristring
URL HTTPS de retorno, com origem autorizada na política da organização.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / KYC na Everbridge
Consultar cadastro da interface Everbridge
Consulta vínculo, validade e situação do cadastro. Não retorna a URL secreta nem imagens de documentos. Se houver customer_id, também exige customers:read. Consulte customer.status e as habilitações para decidir quando liberar os serviços.
GET/v1/kyc_sessions/{id}
Autenticação BearerEscopo kyc:read
Requisição
Execute no seu backend. Exemplos usam dados fictícios.
curl --request GET 'https://api2.everbridge.com.br/v1/kyc_sessions/recurso_EXEMPLO' \
--header "Authorization: Bearer $EVERBRIDGE_TOKEN"
const response = await fetch('https://api2.everbridge.com.br/v1/kyc_sessions/recurso_EXEMPLO', {
method: 'GET',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/kyc_sessions/recurso_EXEMPLO',
method='GET',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN']
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.
REFERÊNCIA / KYC na Everbridge
Revogar link de cadastro
Revoga o acesso a este formulário. O cadastro já enviado permanece existente. Requisições em andamento podem concluir; a revogação impede novas requisições. Para retomar, crie outra sessão com o mesmo customer_id.
DELETE/v1/kyc_sessions/{id}
Autenticação BearerEscopo kyc:write
Requisição
Execute no seu backend. Exemplos usam dados fictícios; substitua a chave de idempotência por uma chave única para esta intenção.
const response = await fetch('https://api2.everbridge.com.br/v1/kyc_sessions/recurso_EXEMPLO', {
method: 'DELETE',
headers: {
Authorization: 'Bearer ' + process.env.EVERBRIDGE_TOKEN,
'Idempotency-Key': 'pedido-2026-0001'
}
});
const data = await response.json();
if (!response.ok) throw new Error(data.error?.code);
console.log(data);
import os, json
from urllib.request import Request, urlopen
from urllib.error import HTTPError
request = Request(
'https://api2.everbridge.com.br/v1/kyc_sessions/recurso_EXEMPLO',
method='DELETE',
headers={
'Authorization': 'Bearer ' + os.environ['EVERBRIDGE_TOKEN'],
'Idempotency-Key': 'pedido-2026-0001'
}
)
try:
with urlopen(request, timeout=30) as response:
print(json.load(response))
except HTTPError as error:
print(error.code, error.read().decode())
Parâmetros de caminho
Campo
Descrição
idstringObrigatório*
ID do recurso indicado no caminho.
Resposta
200 Exemplo parcial e ilustrativo. Campos, estados e instruções retornados variam por recurso e rota; use os valores reais da resposta.
application/json
{
"id": "ks_EXEMPLO",
"revoked": true
}
Erros e operação
401 indica problema de credencial; 403, permissão ou política; 404, recurso inacessível. Escritas exigem Idempotency-Key e podem retornar 409 em caso de conflito. Consulte todos os erros e retentativas seguras.