Outros e utilitários

Consulta de Contas Existentes

Verifica se o CNPJ possui contas vinculadas na base de dados interna da instituição.

Quando usar

Descrição

O serviço de Consulta de Contas Existentes verifica se a pessoa consultada já possui contas vinculadas

na base de dados interna da instituição, retornando todas as contas encontradas com seus dados cadastrais.

Requisição

Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.

POST /api/v1/{tenant}/empresas/consulta-de-contas-existentes

CampoObrigatórioDescrição
document sim CNPJ da empresa, com ou sem máscara.
{
  "document": "00.000.000/0000-00"
}

Campos de retorno

Campos dentro de data. [] indica lista.

CampoTipo
accounts[].account texto
accounts[].agency texto
accounts[].type_current_account texto
accounts[].status_account texto
accounts[].start_date_account data
accounts[].end_date_account texto
accounts[].account_update data
accounts[].registration número
accounts[].account_analyst texto
account_representatives[].representative_person_id texto
account_representatives[].name texto
account_representatives[].document texto
account_representatives[].status texto
account_representatives[].risk_category_current_description texto
account_representatives[].risk_category_current_color texto
account_representatives[].representative_type texto
account_representatives[].representative_agency número
account_representatives[].situation_representative texto
account_representatives[].percentual_representation texto

Exemplo de resposta

Estrutura real da resposta, com valores fictícios.

{
  "execution_id": "00000000-0000-0000-0000-000000000000",
  "status": "success",
  "message": "Consulta realizada com sucesso",
  "query_name": "Consulta de Contas Existentes",
  "query_slug": "consulta-de-contas-existentes",
  "data": {
    "accounts": [
      {
        "account": "texto",
        "agency": "texto",
        "type_current_account": "texto",
        "status_account": "texto",
        "start_date_account": "2026-01-01",
        "end_date_account": null,
        "account_update": "2026-01-01",
        "registration": 0,
        "account_analyst": "texto"
      }
    ],
    "account_representatives": [
      {
        "representative_person_id": "texto",
        "name": "texto",
        "document": "texto",
        "status": "texto",
        "risk_category_current_description": "texto",
        "risk_category_current_color": "texto",
        "representative_type": "texto",
        "representative_agency": 0,
        "situation_representative": "texto",
        "percentual_representation": "texto"
      }
    ]
  },
  "consulted_at": "2026-01-01T12:00:00Z"
}

Cobrança e respostas

  • O valor é cobrado por consulta bem-sucedida.
  • 200 — consulta processada (veja status no corpo da resposta)
  • 401 — token ausente, inválido, inativo ou expirado
  • 403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
  • 422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
  • 429 — limite de requisições por minuto da chave excedido
  • 504 — tempo máximo de execução do serviço excedido