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.
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. Os IDs devem pertencer ao mesmo titular quando usados juntos.
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 chave Everbridge por integração, com acesso controlado por 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.
Emissão, rotação e revogação
Solicite sua chave à equipe Everbridge, informando integração, operações necessárias e validade desejada. Emissão e revogação são administrativas. Para rotacionar: receba uma chave nova, atualize o segredo do backend, valide /v1/me e solicite revogação da anterior. 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.
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.
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.
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. Reservas são conservadoras: resultados incertos ou rejeitados podem manter a reserva até 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.
Aprovação e habilitações
Acompanhe status, pendências e endorsements. Habilite operações somente quando titular e rota estiverem liberados. Análise, pendência ou rejeição devem suspender provisionamentos dependentes; ausência de estado não equivale a aprovação.
Retomada e clientes existentes
Os endpoints /kyc_link e /tos_acceptance_link do cliente retomam verificação e aceite. IDs anteriores à integração precisam de vínculo administrativo; 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.
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. Recursos referenciados precisam pertencer à organização e ao titular de on_behalf_of.
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.
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
As notificações de infraestrutura são recebidas e validadas centralmente pela Everbridge. Nesta versão, seu backend consome GET /v1/events; não há cadastro de webhook de saída para URLs dos clientes.
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
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.
Tentativas limitadas com mesma chave; reconciliar resultados incertos.
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.1.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. Envie ao titular os links retornados de verificação e aceite. A criação do link não significa aprovação.
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. A aprovação é independente da criação do cadastro.
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.
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
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. Cadastro direto: o tipo é obrigatório; os demais documentos e campos exigidos variam conforme pessoa, país e habilitação. Para coletar os requisitos de forma guiada, use links de KYC.
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.
full_namestring
Nome completo da pessoa ou razão social.
emailstring
E-mail do titular.
phonestring
Telefone com código internacional.
birth_datestring
Data de nascimento no formato YYYY-MM-DD.
residential_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.
registered_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.
physical_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.
mailing_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.
identifying_informationarray [object]
Documentos do titular. Tipo, país emissor e evidências dependem do cadastro.Campos de cada item
typestring
Tipo do documento.
issuing_countrystring
País emissor ISO de três letras.
numberstring
Número do documento.
source_of_fundsstring
Origem dos recursos conforme a classificação aprovada para o cadastro.
employment_statusstring
Situação profissional.
most_recent_occupationstring
Ocupação mais recente.
expected_monthly_payments_usdstring
Volume mensal esperado em USD, conforme o perfil de cadastro.
account_purposestring
Finalidade da conta.
account_purpose_otherstring
Descrição quando a finalidade exigir complemento.
signed_agreement_idstring
Identificador de aceite válido dos termos. Não fabrique este valor.
endorsementsarray [string]
Habilitações solicitadas. A aprovação é independente da criação do cadastro.
business_legal_namestring
Razão social.
business_typestring
Tipo jurídico.
business_industrystring
Setor de atividade.
business_descriptionstring
Descrição das atividades.
business_websitestring
Site da empresa.
business_identifying_informationarray [object]
Documentos de registro da empresa.Campos de cada item
associated_personsarray [object]
Sócios, beneficiários finais e representantes; requisitos dependem da empresa.Campos de cada item
first_namestring
Primeiro nome.
last_namestring
Sobrenome.
emailstring
E-mail.
business_trading_namestring
Nome fantasia.
is_daoboolean
Indica organização autônoma descentralizada.
is_high_riskboolean
Declaração de atividade de risco elevado.
source_of_funds_descriptionstring
Descrição da origem dos recursos.
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
Consultar cliente
A operação acessa somente recursos vinculados à sua organização.
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.
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("{\"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())
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.
full_namestring
Nome completo da pessoa ou razão social.
emailstring
E-mail do titular.
phonestring
Telefone com código internacional.
birth_datestring
Data de nascimento no formato YYYY-MM-DD.
residential_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.
registered_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.
physical_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.
mailing_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.
identifying_informationarray [object]
Documentos do titular. Tipo, país emissor e evidências dependem do cadastro.Campos de cada item
typestring
Tipo do documento.
issuing_countrystring
País emissor ISO de três letras.
numberstring
Número do documento.
source_of_fundsstring
Origem dos recursos conforme a classificação aprovada para o cadastro.
employment_statusstring
Situação profissional.
most_recent_occupationstring
Ocupação mais recente.
expected_monthly_payments_usdstring
Volume mensal esperado em USD, conforme o perfil de cadastro.
account_purposestring
Finalidade da conta.
account_purpose_otherstring
Descrição quando a finalidade exigir complemento.
endorsementsarray [string]
Habilitações solicitadas. A aprovação é independente da criação do cadastro.
business_legal_namestring
Razão social.
business_typestring
Tipo jurídico.
business_industrystring
Setor de atividade.
business_descriptionstring
Descrição das atividades.
business_websitestring
Site da empresa.
business_identifying_informationarray [object]
Documentos de registro da empresa.Campos de cada item
associated_personsarray [object]
Sócios, beneficiários finais e representantes; requisitos dependem da empresa.Campos de cada item
first_namestring
Primeiro nome.
last_namestring
Sobrenome.
emailstring
E-mail.
business_trading_namestring
Nome fantasia.
is_daoboolean
Indica organização autônoma descentralizada.
is_high_riskboolean
Declaração de atividade de risco elevado.
source_of_funds_descriptionstring
Descrição da origem dos recursos.
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
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 a consultar.
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
{
"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 / 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.
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.
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.
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.
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.
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.
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 / 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.
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.
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.
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.
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. Exige transferências habilitadas, limites na moeda de origem e habilitação do titular para a rota. A resposta inicial não comprova liquidação.
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.
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.
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.
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.
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.
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_id.
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.