Dados cadastrais

Dados Cadastrais

O serviço de Dados Cadastrais retorna informações essenciais sobre a empresa consultada, incluindo dados básicos, e-mails, endereços e telefones.

Quando usar

Descrição

O serviço de Dados Cadastrais fornece diversas informações sobre a empresa consultada, frequentemente usadas em processos de cadastro em diferentes plataformas e serviços.

Além dos dados básicos, como nome e status de atividade, são fornecidos dados adicionais, incluindo e-mails, endereços e telefones.

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/dados-cadastrais

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
BasicData.TaxIdNumber texto
BasicData.OfficialName texto
BasicData.TradeName texto
BasicData.FoundedDate data
BasicData.IsHeadquarter booleano
BasicData.TaxIdStatus texto
BasicData.TaxIdStatusDate data
BasicData.Activities[].IsMain booleano
BasicData.Activities[].Code texto
BasicData.Activities[].Activity texto
BasicData.LegalNature.Code texto
BasicData.LegalNature.Activity texto
BasicData.AdditionalOutputData.Capital texto
BasicData.AdditionalOutputData.CapitalRS texto
Emails.Primary.EmailAddress texto
Emails.Primary.Domain texto
Emails.Primary.UserName texto
Emails.Primary.Type texto
Emails.Primary.LastUpdateDate data
Addresses.Primary.Typology texto
Addresses.Primary.Title texto
Addresses.Primary.AddressMain texto
Addresses.Primary.Number texto
Addresses.Primary.Complement texto
Addresses.Primary.Neighborhood texto
Addresses.Primary.ZipCode texto
Addresses.Primary.City texto
Addresses.Primary.State texto
Addresses.Primary.Country texto
Addresses.Primary.Type texto
Addresses.Primary.ComplementType texto
Addresses.Primary.LastUpdateDate data
Addresses.Secondary.Typology texto
Addresses.Secondary.Title texto
Addresses.Secondary.AddressMain texto
Addresses.Secondary.Number texto
Addresses.Secondary.Complement texto
Addresses.Secondary.Neighborhood texto
Addresses.Secondary.ZipCode texto
Addresses.Secondary.City texto
Addresses.Secondary.State texto
Addresses.Secondary.Country texto
Addresses.Secondary.Type texto
Addresses.Secondary.ComplementType texto
Addresses.Secondary.LastUpdateDate data
Phones.Primary.Number texto
Phones.Primary.AreaCode texto
Phones.Primary.CountryCode texto
Phones.Primary.Complement texto
Phones.Primary.Type texto
Phones.Primary.PhoneNumberOfEntities número
Phones.Primary.LastUpdateDate data
Phones.Secondary.Number texto
Phones.Secondary.AreaCode texto
Phones.Secondary.CountryCode texto
Phones.Secondary.Complement texto
Phones.Secondary.Type texto
Phones.Secondary.PhoneNumberOfEntities número
Phones.Secondary.LastUpdateDate data

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": "Dados Cadastrais",
  "query_slug": "dados-cadastrais",
  "data": {
    "BasicData": {
      "TaxIdNumber": "texto",
      "OfficialName": "texto",
      "TradeName": "texto",
      "FoundedDate": "2026-01-01",
      "IsHeadquarter": false,
      "TaxIdStatus": "texto",
      "TaxIdStatusDate": "2026-01-01",
      "Activities": [
        {
          "IsMain": false,
          "Code": "texto",
          "Activity": "texto"
        }
      ],
      "LegalNature": {
        "Code": "texto",
        "Activity": "texto"
      },
      "AdditionalOutputData": {
        "Capital": "texto",
        "CapitalRS": "texto"
      }
    },
    "Emails": {
      "Primary": {
        "EmailAddress": "texto",
        "Domain": "texto",
        "UserName": "texto",
        "Type": "texto",
        "LastUpdateDate": "2026-01-01"
      }
    },
    "Addresses": {
      "Primary": {
        "Typology": "texto",
        "Title": "texto",
        "AddressMain": "texto",
        "Number": "texto",
        "Complement": "texto",
        "Neighborhood": "texto",
        "ZipCode": "texto",
        "City": "texto",
        "State": "texto",
        "Country": "texto",
        "Type": "texto",
        "ComplementType": "texto",
        "LastUpdateDate": "2026-01-01"
      },
      "Secondary": {
        "Typology": "texto",
        "Title": "texto",
        "AddressMain": "texto",
        "Number": "texto",
        "Complement": "texto",
        "Neighborhood": "texto",
        "ZipCode": "texto",
        "City": "texto",
        "State": "texto",
        "Country": "texto",
        "Type": "texto",
        "ComplementType": "texto",
        "LastUpdateDate": "2026-01-01"
      }
    },
    "Phones": {
      "Primary": {
        "Number": "texto",
        "AreaCode": "texto",
        "CountryCode": "texto",
        "Complement": "texto",
        "Type": "texto",
        "PhoneNumberOfEntities": 0,
        "LastUpdateDate": "2026-01-01"
      },
      "Secondary": {
        "Number": "texto",
        "AreaCode": "texto",
        "CountryCode": "texto",
        "Complement": "texto",
        "Type": "texto",
        "PhoneNumberOfEntities": 0,
        "LastUpdateDate": "2026-01-01"
      }
    }
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "0.240"
}

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