📘 Glossário

Conceitos gerais

Espaço de trabalho: o espaço da sua empresa na Datanomik. Usuários, links, chaves de API e configurações pertencem a um espaço de trabalho.

Vista do espaço de trabalho: um subconjunto de um espaço de trabalho (por exemplo, algumas empresas ou contas). Usuários e chaves de API podem ser limitados a uma vista.

Chaves de API: as credenciais da sua integração, compostas por um secretId e um secretPassword. Você as cria no dashboard, e toda requisição à API deve incluí-las (veja Autenticação).

Instituição: um banco, instituição de pagamento ou corretora a que a Datanomik pode se conectar. Cada instituição tem um código (por exemplo BRADESCO ou SANTANDER; obtenha a lista completa com GET /v1/institutions), um país, um tipo (BANK, PI, BROKER…) e um status (ONLINE, UNSTABLE, OFFLINE). Veja Cobertura de instituições.

Origem da conexão: a forma como a Datanomik acessa uma instituição: Open Finance Brasil (consentimento dado pelo titular da conta na instituição), a API da instituição (por exemplo, com um certificado ou credenciais de cliente emitidas pelo banco) ou o seu internet banking.

Link: a conexão entre a Datanomik e um acesso a uma instituição, criada a partir de um conjunto de credenciais (por exemplo, o usuário e a senha do internet banking de uma empresa, ou um consentimento de Open Finance). Tudo o que a Datanomik coleta (contas, saldos, transações…) está vinculado a um link.

Sincronização (sync): cada vez que a Datanomik se conecta à instituição para atualizar as informações de um link. Os links são sincronizados automaticamente de acordo com os agendamentos configurados para o seu espaço de trabalho, e você também pode solicitar uma atualização sob demanda com POST /v1/links/{id}.

Chamada à API: cada requisição que você faz à API Datanomik. As chamadas à API leem as informações que a Datanomik já coletou; elas não se conectam à instituição (exceto a atualização sob demanda).

Status do link

Recursos

Contas: as contas de um link na instituição (corrente, poupança, investimento etc.), com número, agência, moeda e tipo.

Saldos: os saldos de cada conta: saldo atual, disponível e bloqueado, limite de cheque especial e saldo de aplicação automática, quando a instituição os fornece. /v1/balances/history retorna o saldo de cada dia.

Transações: as movimentações de cada conta. Cada uma tem data, valor, moeda, descrição, remetente e beneficiário (quando disponíveis) e uma categoria.

Categorias: a classificação das transações em entradas (INFLOW) e saídas (OUTFLOW). A Datanomik categoriza as transações automaticamente usando as regras do seu espaço de trabalho.

Titulares (empresas): os titulares das contas (empresa ou pessoa, com seu CNPJ ou CPF).

Grupos de empresas: os agrupamentos de titulares que pertencem à mesma empresa ou ao mesmo grupo econômico.

Usuários: as pessoas com acesso à conta na instituição (por exemplo, os operadores do internet banking de uma empresa).

Assets: as informações consolidadas de um link em uma única chamada: o link, seus titulares e seus usuários.

Investimentos: as posições de investimento de cada conta (fundos, renda fixa etc.), com seu histórico e suas movimentações (aplicações e resgates).

Pagamentos, PIX e boletos: os pagamentos feitos a partir das contas, as transferências PIX e os boletos da conta.

Comprovantes: a prova de um pagamento, transferência PIX ou movimentação de investimento. Os comprovantes são coletados apenas para os links e as instituições em que esse recurso está habilitado para o seu espaço de trabalho; depois de coletados, você pode baixá-los em PDF.

Convenções de dados

• URL base: https://api.datanomik.com. Todos os endpoints começam com /v1.
• Os campos JSON das respostas usam snake_case (por exemplo current_balance). Campos sem valor são omitidos.
• Os parâmetros de query usam camelCase (por exemplo dateFrom, linkId).
• Datas: os campos date usam o formato YYYY-MM-DD; os timestamps usam ISO 8601 em UTC (por exemplo 2026-10-23T13:00:00Z).
• Os valores são números decimais na moeda da conta (não em centavos). Nas transações, um valor negativo é uma saída e um valor positivo é uma entrada.
• As moedas usam códigos ISO 4217 (BRL, USD, UYU…) e os países usam códigos ISO 3166 alfa-2 (BR, UY…).
• Paginação: os endpoints de listagem recebem page (começando em 0) e size (padrão 50, máximo 500). Veja Paginação.

Campos de data comuns

Métodos HTTP e respostas

Erros

Os erros retornam o status HTTP correspondente e um corpo como este:

{
  "code": 600,
  "type": "LINK_NOT_FOUND",
  "message": "Link resource not found.",
  "trace_id": "0af7651916cd43dd8448eb211c80319c"
}

• code e type identificam o erro; use-os na lógica da sua integração.
• message é uma descrição legível.
• trace_id identifica a requisição. Inclua-o ao entrar em contato com o suporte.
• details lista os campos inválidos, apenas em erros de validação.