Atlas Consultas API TEMP

Documentação técnica da API de consultas da Atlas Consultas. Versão provisória de homologação — endpoints, parâmetros e estruturas de resposta podem sofrer alterações antes da versão final.

API Provisória: versão 2026-beta-temp. Não utilize em produção sem validação prévia com o time Atlas.
Documentação disponível em docs-temp.atlasid.com.br — acesso restrito a parceiros e desenvolvedores autorizados.

Autenticação

Todas as requisições devem incluir os seguintes headers. Sem credenciais válidas, o servidor retorna 401 Unauthorized.

HeaderValorDescrição
Content-Type application/json Define o formato de envio/recebimento.
X-SERIAL-HASH Basic [TOKEN_BASE64] Credenciais codificadas. Fornecidas pela Atlas Consultas.
Nunca compartilhe seu token em ambientes públicos, repositórios ou logs.

URL Base

AmbienteURL BaseStatus
Produção https://temp.atlasid.com.br ● ATIVO
Todos os endpoints usam HTTPS. Certificados auto-assinados podem exigir a flag -k no cURL durante testes locais.

Regras de Formatação

Siga estas diretrizes para evitar erros de validação (422) ou falhas de processamento (502).

TipoRegraExemplo correto
CPFExatamente 11 dígitos, sem pontuação00000000000
CNPJExatamente 14 dígitos, sem pontuação00000000000000
PLACAPadrão antigo (ABC1234) ou Mercosul (ABC1D23)ABC1D23
CHASSIExatamente 17 caracteres alfanuméricos9C2ND1910TR000000
CEPSomente números ou com hífen01310200

A URL não deve conter espaços em branco nos valores dos parâmetros. Use + ou %20 para separar palavras em campos como logradouro e cidade.

Endpoints

GET /consultar Realiza uma consulta por produto

Ponto de entrada principal. O parâmetro tipo_produto determina qual base será consultada. Veja a seção de cada produto para os parâmetros específicos.

Parâmetros comuns (Query String)

ParâmetroTipoDescrição
tipo_produtostring Obrigatório Produto a ser consultado. Ver lista completa na seção Produtos.
tipo_parametrostring Obrigatório Tipo do identificador. Valores válidos variam por produto.
CPFCNPJPLACACHASSIENDERECO
parametrostring Obrigatório* Valor do identificador. Não obrigatório quando tipo_parametro=ENDERECO (use campos de endereço).
GET /recuperar Recupera resultado por hash

Recupera resultado de consulta já realizada via hash retornado pelo /consultar. Evita reprocessamento e é mais rápido.

ParâmetroTipoDescrição
hashstring Obrigatório Hash alfanumérico retornado no campo hash da consulta original.
cURL
curl -X GET "https://temp.atlasid.com.br/recuperar?hash={hash_da_consulta}" \
  -H "Content-Type: application/json" \
  -H "X-SERIAL-HASH: Basic {seu_token}"

Veicular

Placa Chassi
base_estadual — Veículos: Base Estadual Placa / Chassi

Dados completos do veículo nas bases estaduais e federal: restrições, débitos (IPVA, multas, licenciamento), histórico de documentação, dados do proprietário e muito mais.

ParâmetroTipoDescrição
tipo_produtostringObrigatórioFixo: base_estadual
tipo_parametrostringObrigatório
PLACACHASSI
parametrostringObrigatórioPlaca (padrão antigo ou Mercosul) ou Chassi (17 caracteres).
cURL
curl -X GET "https://temp.atlasid.com.br/consultar?tipo_produto=base_estadual&tipo_parametro=PLACA&parametro=ABC1D23" \
  -H "Content-Type: application/json" \
  -H "X-SERIAL-HASH: Basic {seu_token}"

Campos da resposta (sucesso)

retorno_consulta.dados_veiculo.placaPlaca do veículo
dados_veiculo.chassiNúmero do chassi
dados_veiculo.renavamRENAVAM
dados_veiculo.marca_modeloMarca e modelo
dados_veiculo.ano_fabricacao / ano_modeloAno de fabricação e modelo
dados_veiculo.situacao_veiculoEx: CIRCULACAO, BAIXADO
dados_veiculo.cor / combustivel / tipo_veiculoCaracterísticas do veículo
dados_proprietario.nome_proprietarioNome do proprietário
dados_proprietario.documento_proprietarioCPF/CNPJ do proprietário
restricoes.restricao_financeiraEx: ALIENACAO FIDUCIARIA, NADA CONSTA
restricoes.restricao_judicialRestrição judicial
restricoes.restricao_furto_rouboRestrição de furto/roubo
resumo_debitos.ipva.existe_debitoEXISTE DEBITO DE IPVA / NAO EXISTE…
resumo_debitos.multas.existe_debitoStatus de multas
historico_documentacao.comunicacao_vendaStatus de comunicação de venda

Exemplo de retorno

JSON
{
  "status": "sucesso",
  "cache": true,
  "hash": "dc37d5545099cd7a5b7470d96c141811",
  "produto": "base_estadual",
  "resultado": {
    "identificacao_api": { "cliente": "NOME DO CLIENTE" },
    "informacoes_gerais": { "documento": "ABC1D23", "tipo": "PLACA", "status_consulta": "sucesso" },
    "retorno_consulta": {
      "dados_veiculo": {
        "placa": "ABC1D23",
        "chassi": "9C2ND1910TR000000",
        "renavam": "00000000000",
        "municipio": "CIDADE-UF",
        "uf": "UF",
        "situacao_veiculo": "CIRCULACAO",
        "marca_modelo": "HONDA/XR300L TORNADO",
        "ano_fabricacao": "2026",
        "ano_modelo": "2026",
        "cor": "VERMELHA",
        "combustivel": "ALCOOL/GASOLINA",
        "tipo_veiculo": "MOTOCICLETA",
        "categoria": "PARTICULAR",
        "procedencia": "NACIONAL"
      },
      "dados_proprietario": {
        "nome_proprietario": "00000000000 NOME COMPLETO DO PROPRIETARIO",
        "documento_proprietario": "00000000000",
        "tipo_proprietario": "FISICA"
      },
      "restricoes": {
        "restricao_financeira": "ALIENACAO FIDUCIARIA",
        "restricao_administrativa": "NADA CONSTA",
        "restricao_judicial": "NADA CONSTA",
        "restricao_furto_roubo": "NADA CONSTA"
      },
      "resumo_debitos": {
        "ipva": { "existe_debito": "EXISTE DEBITO DE IPVA", "valor_debito": "0,00" },
        "multas": { "existe_debito": "NAO EXISTE DEBITO DE MULTA", "valor_debito": "0,00" },
        "licenciamento": { "existe_debito": "EXISTE DEBITO", "valor_debito": "0,00" },
        "dpvat": { "existe_debito": "NAO EXISTE DEBITO DE DPVAT", "valor_debito": "0,00" }
      },
      "historico_documentacao": {
        "comunicacao_venda": "NAO CONSTA COMUNICACAO DE VENDAS"
      }
    },
    "status_code": 200
  }
}
JSON
{
  "status": "false",
  "cache": false,
  "hash": null,
  "produto": "base_estadual",
  "resultado": {
    "informacoes_gerais": { "documento": "ABC1D23", "tipo": "PLACA", "status_consulta": "falha" },
    "retorno_consulta": [],
    "status_code": 502,
    "erro": { "mensagem_erro": "Erro HTTP: 502 - Resposta: error code: 502" }
  }
}
proprietario_atual — Proprietário Atual do Veículo Placa / Chassi

Retorno simplificado focado no proprietário atual do veículo. Resposta mais leve que a base estadual.

ParâmetroTipoDescrição
tipo_produtostringObrigatórioFixo: proprietario_atual
tipo_parametrostringObrigatório
PLACACHASSI
parametrostringObrigatórioPlaca ou Chassi do veículo.
cURL
curl -X GET "https://temp.atlasid.com.br/consultar?tipo_produto=proprietario_atual&tipo_parametro=PLACA&parametro=ABC1D23" \
  -H "Content-Type: application/json" \
  -H "X-SERIAL-HASH: Basic {seu_token}"

Campos da resposta (sucesso)

retorno_consulta.dados_veiculo.placaPlaca do veículo
dados_veiculo.chassi / renavamChassi e RENAVAM
dados_veiculo.marca_modeloMarca e modelo
dados_veiculo.ano_fabricacao / ano_modeloAnos do veículo
dados_veiculo.cor / combustivel / tipo_veiculoCaracterísticas básicas
dados_proprietario.nome_proprietarioNome completo do proprietário atual
dados_proprietario.documento_proprietarioCPF/CNPJ do proprietário

Exemplo de retorno

JSON
{
  "status": "sucesso",
  "cache": false,
  "hash": "5f123c1d6fe6af1f1b34ca655b800a12",
  "produto": "proprietario_atual",
  "resultado": {
    "identificacao_api": { "cliente": "NOME DO CLIENTE" },
    "informacoes_gerais": { "documento": "ABC1D23", "tipo": "PLACA", "status_consulta": "sucesso" },
    "retorno_consulta": {
      "dados_veiculo": {
        "placa": "ABC1D23",
        "renavam": "00000000000",
        "chassi": "93HRV000000000000",
        "ano_fabricacao": "2021",
        "ano_modelo": "2021",
        "combustivel": "ALCO/GASOL",
        "cor": "BRANCA",
        "especie": "PASSAGEIRO",
        "marca_modelo": "HONDA HRV LX CVT",
        "municipio": "CIDADE-UF",
        "uf": "UF",
        "tipo_veiculo": "AUTOMOVEL",
        "procedencia": "NACIONAL"
      },
      "dados_proprietario": {
        "nome_proprietario": "NOME COMPLETO DO PROPRIETARIO",
        "documento_proprietario": "00000000000"
      }
    },
    "status_code": 200
  }
}
JSON
{
  "status": "false",
  "cache": false,
  "hash": null,
  "produto": "proprietario_atual",
  "resultado": {
    "informacoes_gerais": { "documento": "ABC1D23", "tipo": "PLACA", "status_consulta": "falha" },
    "retorno_consulta": [],
    "status_code": 502,
    "erro": { "mensagem_erro": "Erro HTTP: 502 - Resposta: error code: 502" }
  }
}

Crédito

CPF CNPJ
negativacoes_pf_boavista — Boa Vista / EQUIFAX PF CPF

Negativações e restrições financeiras de pessoa física na base Boa Vista (EQUIFAX). Retorna cadastro, resumo de dívidas e detalhamento de cada débito.

ParâmetroTipoDescrição
tipo_produtostringObrigatórioFixo: negativacoes_pf_boavista
tipo_parametrostringObrigatório
CPF
parametrostringObrigatórioCPF sem pontuação (11 dígitos).
cURL
curl -X GET "https://temp.atlasid.com.br/consultar?tipo_produto=negativacoes_pf_boavista&tipo_parametro=CPF&parametro=00000000000" \
  -H "Content-Type: application/json" \
  -H "X-SERIAL-HASH: Basic {seu_token}"

Campos da resposta (sucesso)

retorno_consulta.cadastro.nomeNome do titular
cadastro.data_nascimentoData de nascimento
resumo_restricoes.tem_dividatrue / false
resumo_restricoes.mensagem_dividaCONSTA DIVIDA… / NADA CONSTA…
resumo_restricoes.total_debitosNúmero de débitos
resumo_restricoes.valor_total_debitosValor total em R$
detalhes_debitos[].tipoTipo do débito (RG, OJ…)
detalhes_debitos[].informanteCredor
detalhes_debitos[].valorValor do débito
detalhes_debitos[].dataData de inclusão
detalhes_debitos[].contratoNúmero do contrato

Exemplo de retorno

JSON
{
  "status": "sucesso",
  "cache": false,
  "hash": "7b59e3a1f8c2d4e6b0a1c3d5e7f9a2b4",
  "produto": "negativacoes_pf_boavista",
  "resultado": {
    "identificacao_api": { "cliente": "NOME DO CLIENTE" },
    "informacoes_gerais": { "documento": "45612378900", "tipo": "DOCUMENTO", "status_consulta": "sucesso" },
    "retorno_consulta": {
      "cadastro": {
        "nome": "CARLOS EDUARDO DOS SANTOS",
        "documento": "45612378900",
        "data_nascimento": "12/08/1982",
        "nome_mae": "MARIA APARECIDA DOS SANTOS"
      },
      "resumo_restricoes": {
        "tem_divida": true,
        "mensagem_divida": "CONSTA DIVIDA PARA O DOCUMENTO INFORMADO",
        "total_debitos": 5,
        "valor_total_debitos": "23567,37"
      },
      "detalhes_debitos": [
        {
          "tipo": "RG",
          "descricao": "RG-REGISTRADO",
          "contrato": "27700056562ARF823786",
          "data": "01/04/2026",
          "valor": "426,04",
          "informante": "BANCO BRADESCO S/A",
          "cidade": "SCPC SAO PAULO",
          "uf": "SP"
        }
        // ... demais débitos
      ]
    }
  }
}
JSON
{
  "status": "sucesso",
  "cache": false,
  "hash": "8f91a6b204e5d7f01a2b3c4d05e6f7a8",
  "produto": "negativacoes_pf_boavista",
  "resultado": {
    "identificacao_api": { "cliente": "NOME DO CLIENTE" },
    "informacoes_gerais": { "documento": "10987654321", "tipo": "DOCUMENTO", "status_consulta": "sucesso" },
    "retorno_consulta": {
      "cadastro": {
        "nome": "MARIA EDUARDA DA SILVA",
        "documento": "10987654321",
        "data_nascimento": "15/05/1993",
        "nome_mae": "TEREZA CRISTINA DA SILVA"
      },
      "resumo_restricoes": {
        "tem_divida": false,
        "mensagem_divida": "NADA CONSTA PARA O DOCUMENTO INFORMADO",
        "total_debitos": 0,
        "valor_total_debitos": "0,00"
      },
      "detalhes_debitos": []
    }
  }
}
JSON
{
  "status": "false",
  "cache": false,
  "hash": null,
  "produto": "negativacoes_pf_boavista",
  "resultado": {
    "informacoes_gerais": { "documento": "00000000000", "tipo": "DOCUMENTO", "status_consulta": "falha" },
    "retorno_consulta": [],
    "status_code": 502,
    "erro": { "mensagem_erro": "Erro HTTP: 502 - Resposta: error code: 502" }
  }
}
cadin — CADIN (Créditos não Quitados do Setor Público) CPF CNPJ

Consulta de Dívida Ativa consolidada, reunindo débitos de três fontes: Geral, FGTS e Previdenciário. Retorna o total de débitos, o valor somado e o detalhamento de cada inscrição.

ParâmetroTipoDescrição
tipo_produtostringObrigatórioFixo: cadin
tipo_parametrostringObrigatório
CPFCNPJ
parametrostringObrigatórioCPF (11 dígitos) ou CNPJ (14 dígitos) sem pontuação.

Exemplo — CPF

cURL
curl -X GET "https://temp.atlasid.com.br/consultar?tipo_produto=cadin&tipo_parametro=CPF&parametro=00000000000" \
  -H "Content-Type: application/json" \
  -H "X-SERIAL-HASH: Basic {seu_token}"

Exemplo — CNPJ

cURL
curl -X GET "https://temp.atlasid.com.br/consultar?tipo_produto=cadin&tipo_parametro=CNPJ&parametro=00000000000000" \
  -H "Content-Type: application/json" \
  -H "X-SERIAL-HASH: Basic {seu_token}"

Exemplo de retorno

Estrutura de resposta do CADIN a confirmar — aguardando o JSON real para documentar os campos. O envelope abaixo segue o padrão dos demais produtos.
JSON
{
  "status": "sucesso",
  "cache": false,
  "hash": "{hash}",
  "produto": "cadin",
  "resultado": {
    "informacoes_gerais": {
      "documento": "{documento}",
      "tipo": "DOCUMENTO",
      "status_consulta": "sucesso"
    }
    // ... campos do CADIN a confirmar
  }
}
JSON
{
  "status": "false",
  "cache": false,
  "hash": null,
  "produto": "cadin",
  "resultado": {
    "informacoes_gerais": {
      "documento": "00000000000191",
      "tipo": "CNPJ",
      "status_consulta": "falha"
    },
    "retorno_consulta": [],
    "status_code": 502,
    "erro": { "mensagem_erro": "Erro HTTP: 502 - Resposta: error code: 502" }
  }
}
faturamento_presumido_pj — Faturamento Presumido PJ CNPJ

Estimativa de faturamento mensal e anual de pessoa jurídica.

ParâmetroTipoDescrição
tipo_produtostringObrigatórioFixo: faturamento_presumido_pj
tipo_parametrostringObrigatório
CNPJCPF
parametrostringObrigatórioCNPJ ou CPF sem pontuação.
cURL
curl -X GET "https://temp.atlasid.com.br/consultar?tipo_produto=faturamento_presumido_pj&tipo_parametro=CNPJ&parametro=00000000000000" \
  -H "Content-Type: application/json" \
  -H "X-SERIAL-HASH: Basic {seu_token}"

Campos da resposta

resultado.razao_socialRazão social
resultado.faturamento_mensalFaturamento mensal (número)
resultado.faturamento_anualFaturamento anual (número)
resultado.faturamento_mensal_formatadoEx: "1.734.715,00"
resultado.faturamento_anual_formatadoEx: "36.816.591,00"

Exemplo de retorno

JSON
{
  "status": "sucesso",
  "cache": false,
  "hash": "62f7f5501527b27269a9889fa1ef054e",
  "produto": "faturamento_presumido_pj",
  "resultado": {
    "informacoes_gerais": {
      "documento": "02136367310198",
      "tipo": "DOCUMENTO",
      "status_consulta": "sucesso"
    },
    "razao_social": "XPTA Quimica Do Brasil Ltda.",
    "faturamento_mensal": 1734715,
    "faturamento_anual": 36816591,
    "faturamento_mensal_formatado": "1.734.715,00",
    "faturamento_anual_formatado": "36.816.591,00"
  }
}
JSON
{
  "status": "false",
  "cache": false,
  "hash": null,
  "produto": "faturamento_presumido_pj",
  "resultado": {
    "informacoes_gerais": {
      "documento": "00000000000191",
      "tipo": "CNPJ",
      "status_consulta": "falha"
    },
    "retorno_consulta": [],
    "status_code": 502,
    "erro": { "mensagem_erro": "Erro HTTP: 502 - Resposta: error code: 502" }
  }
}
limite_credito_pj — Limite de Crédito PJ CNPJ

Limite de crédito sugerido para pessoa jurídica.

ParâmetroTipoDescrição
tipo_produtostringObrigatórioFixo: limite_credito_pj
tipo_parametrostringObrigatório
CNPJCPF
parametrostringObrigatórioCNPJ ou CPF sem pontuação.
cURL
curl -X GET "https://temp.atlasid.com.br/consultar?tipo_produto=limite_credito_pj&tipo_parametro=CNPJ&parametro=00000000000000" \
  -H "Content-Type: application/json" \
  -H "X-SERIAL-HASH: Basic {seu_token}"

Campos da resposta

resultado.razao_socialRazão social
resultado.limite_creditoLimite sugerido (número)
resultado.limite_credito_formatadoEx: "3.272.664,00"

Exemplo de retorno

JSON
{
  "status": "sucesso",
  "cache": false,
  "hash": "b30f13c1f1409d0fab007f0c0c1fd493",
  "produto": "limite_credito_pj",
  "resultado": {
    "informacoes_gerais": {
      "documento": "04131367000298",
      "tipo": "DOCUMENTO",
      "status_consulta": "sucesso"
    },
    "razao_social": "XPTO Quimica Do Brasil Ltda.",
    "limite_credito": 3272664,
    "limite_credito_formatado": "3.272.664,00"
  }
}
JSON
{
  "status": "false",
  "cache": false,
  "hash": null,
  "produto": "limite_credito_pj",
  "resultado": {
    "informacoes_gerais": {
      "documento": "00000000000191",
      "tipo": "CNPJ",
      "status_consulta": "falha"
    },
    "retorno_consulta": [],
    "status_code": 502,
    "erro": { "mensagem_erro": "Erro HTTP: 502 - Resposta: error code: 502" }
  }
}

Cadastral

CPF CNPJ Endereço
cadastral — Dados Cadastrais de Pessoa Física CPF

Dados cadastrais completos de pessoa física: contatos, endereços, vínculos, dados socioeconômicos e informações da Receita Federal.

ParâmetroTipoDescrição
tipo_produtostringObrigatórioFixo: cadastral
tipo_parametrostringObrigatório
CPF
parametrostringObrigatórioCPF sem pontuação (11 dígitos).
cURL
curl -X GET "https://temp.atlasid.com.br/consultar?tipo_produto=cadastral&tipo_parametro=CPF&parametro=00000000000" \
  -H "Content-Type: application/json" \
  -H "X-SERIAL-HASH: Basic {seu_token}"

Campos da resposta

nome_completoNome completo
data_nascimentoData de nascimento (AAAA-MM-DD)
sexoMasculino / Feminino
situacao_cadastralREGULAR, IRREGULAR, etc.
socioeconomico.renda_presumidaFaixa de renda presumida
socioeconomico.ocupacaoOcupação atual
contatos.telefones[]Telefones (tipo, ddd, numero, uf)
contatos.emails[]Lista de e-mails
contatos.enderecos[]Lista de endereços
vinculos.parentesco[]Vínculos familiares (nome, cpf, vinculo)
vinculos.socios[]Sociedades empresariais
dados_cadastrais.pepPessoa Politicamente Exposta (boolean)

Exemplo de retorno

JSON
{
  "status": "sucesso",
  "cache": false,
  "hash": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "produto": "cadastral",
  "resultado": {
    "informacoes_gerais": {
      "documento": "45281930277",
      "tipo": "DOCUMENTO",
      "status_consulta": "sucesso"
    },
    "nome_completo": "FABIO HENRIQUE MEDEIROS ALBUQUERQUE",
    "cpf": "45281930277",
    "data_nascimento": "1991-04-12",
    "sexo": "Masculino",
    "nome_mae": "TEREZA CRISTINA MEDEIROS ALBUQUERQUE",
    "situacao_cadastral": "REGULAR",
    "faixa_idade": "De 31 a 40",
    "obito": false,
    "dados_cadastrais": {
      "titulo_eleitoral": "481029381044",
      "data_inscricao": "2009-08-14",
      "atualizacao_rfb": "2026-01-10",
      "pep": false
    },
    "socioeconomico": {
      "renda_presumida": "De R$ 18.000,00 a R$ 22.500,00",
      "ocupacao": "Engenheiro"
    },
    "contatos": {
      "telefones": [
        { "tipo": "Móvel", "ddd": "21", "numero": "981224536", "uf": "RJ" }
      ],
      "emails": [{ "email": "fabio.albuquerque@engmail.com.br" }],
      "enderecos": [
        {
          "logradouro": "SAO CLEMENTE", "tipo": "RUA",
          "numero": "185", "complemento": "APTO 401",
          "bairro": "BOTAFOGO", "cidade": "RIO DE JANEIRO",
          "uf": "RJ", "cep": "22260001"
        }
      ]
    },
    "vinculos": {
      "parentesco": [
        { "nome": "TEREZA CRISTINA MEDEIROS ALBUQUERQUE", "cpf": "28193048255", "vinculo": "Mãe" }
      ]
    }
  }
}
JSON
{
  "status": "false",
  "cache": false,
  "hash": null,
  "produto": "cadastral",
  "resultado": {
    "informacoes_gerais": {
      "documento": "00000000000",
      "tipo": "DOCUMENTO",
      "status_consulta": "falha"
    },
    "retorno_consulta": [],
    "status_code": 502,
    "erro": { "mensagem_erro": "Erro HTTP: 502 - Resposta: error code: 502" }
  }
}
cadastral — Dados Cadastrais de Pessoa Jurídica CNPJ

Dados completos da empresa na Receita Federal: quadro societário, atividades econômicas (CNAE), regime tributário, contatos e firmográfico.

ParâmetroTipoDescrição
tipo_produtostringObrigatórioFixo: cadastral
tipo_parametrostringObrigatório
CNPJ
parametrostringObrigatórioCNPJ sem pontuação (14 dígitos).
cURL
curl -X GET "https://temp.atlasid.com.br/consultar?tipo_produto=cadastral&tipo_parametro=CNPJ&parametro=00000000000000" \
  -H "Content-Type: application/json" \
  -H "X-SERIAL-HASH: Basic {seu_token}"

Campos da resposta

razao_socialRazão social
nome_fantasiaNome fantasia
situacao_cadastralATIVA, BAIXADA, INAPTA, etc.
data_aberturaData de abertura (AAAA-MM-DD)
natureza_juridicaEx: Sociedade Empresária Limitada
atividades_economicas.principalCNAE principal (codigo + descricao)
atividades_economicas.secundarias[]CNAEs secundários
firmografico.portePorte (MEI, EPP, DEMAIS…)
firmografico.capital_socialCapital social
firmografico.faturamento_presumidoFaturamento presumido
firmografico.qtd_funcionariosQuantidade de funcionários
regime_tributario.simples_nacional.optanteboolean
regime_tributario.historico[]Histórico de forma de tributação por ano
quadro_societario[]Sócios e administradores (nome, cpf_cnpj, vinculo, data_entrada)
contatos.telefones[] / emails[] / enderecos[]Dados de contato e endereço

Exemplo de retorno

JSON
{
  "status": "sucesso",
  "cache": false,
  "hash": "b1c2d3e4f5a6b7c8d9e0f1a2b3c4d5e6",
  "produto": "cadastral",
  "resultado": {
    "informacoes_gerais": {
      "documento": "48293011000159",
      "tipo": "DOCUMENTO",
      "status_consulta": "sucesso"
    },
    "razao_social": "ALEXANDRE DE SOUZA OLIVEIRA TECNOLOGIA LTDA",
    "nome_fantasia": "NEXUS INOVACOES DIGITAIS",
    "cnpj": "48293011000159",
    "situacao_cadastral": "ATIVA",
    "data_abertura": "2021-05-14",
    "natureza_juridica": "Sociedade Empresária Limitada",
    "matriz_filial": "MATRIZ",
    "atividades_economicas": {
      "principal": {
        "codigo": "6201501",
        "descricao": "Desenvolvimento de programas de computador sob encomenda"
      },
      "secundarias": [
        { "codigo": "6202300", "descricao": "Desenvolvimento e licenciamento de programas customizáveis" }
      ]
    },
    "firmografico": {
      "porte": "EMPRESA DE PEQUENO PORTE",
      "capital_social": 120000,
      "faturamento_presumido": 450000.0,
      "faixa_faturamento": "De R$ 360.000,01 até R$ 4.800.000,00",
      "qtd_funcionarios": "8"
    },
    "regime_tributario": {
      "simples_nacional": { "optante": true, "data_opcao": "2021-05-14" },
      "mei": { "optante": false }
    },
    "quadro_societario": [
      {
        "nome": "ALEXANDRE DE SOUZA OLIVEIRA",
        "cpf_cnpj": "40219384055",
        "vinculo": "Sócio-Administrador",
        "data_entrada": "2021-05-14",
        "tipo_socio": "PESSOA FÍSICA"
      }
    ]
  }
}
JSON
{
  "status": "false",
  "cache": false,
  "hash": null,
  "produto": "cadastral",
  "resultado": {
    "informacoes_gerais": {
      "documento": "00000000000191",
      "tipo": "DOCUMENTO",
      "status_consulta": "falha"
    },
    "retorno_consulta": [],
    "status_code": 502,
    "erro": { "mensagem_erro": "Erro HTTP: 502 - Resposta: error code: 502" }
  }
}
cadastral — por Endereço Endereço

Busca cadastros (pessoas físicas e jurídicas) vinculados a um endereço. Retorna até 20 registros por pesquisa. Usa o mesmo tipo_produto=cadastral, mas com tipo_parametro=ENDERECO.

ParâmetroTipoDescrição
tipo_produtostringObrigatórioFixo: cadastral
tipo_parametrostringObrigatórioFixo: ENDERECO
tipo_logradourostringOpcionalEx: Rua, Avenida, Alameda, Travessa
logradourostringOpcionalNome da via
numerostringOpcionalNúmero do imóvel
complementostringOpcionalEx: Apto 10, Bloco B
bairrostringOpcionalNome do bairro
cidadestringOpcionalNome da cidade
ufstringOpcionalSigla do estado (SP, RJ…)
cepstringOpcionalCEP (apenas números ou com hífen)
nomestringOpcionalNome da pessoa para filtrar
nome_maestringOpcionalNome da mãe
data_nascimentostringOpcionalFormato: AAAA-MM-DD
rgstringOpcionalNúmero do RG
Ao menos um parâmetro de endereço deve ser informado para a consulta ser processada.

Exemplo

cURL
curl -X GET "https://temp.atlasid.com.br/consultar?tipo_produto=cadastral&tipo_parametro=ENDERECO&tipo_logradouro=Rua&logradouro=das+Acacias&numero=450&cidade=Sao+Paulo&uf=SP" \
  -H "Content-Type: application/json" \
  -H "X-SERIAL-HASH: Basic {seu_token}"

Campos da resposta (sucesso)

resultado.quantidade_encontradaNúmero de registros retornados (máx. 20)
resultado.resultados[]Array de pessoas encontradas no endereço (mesma estrutura do cadastral PF)

Exemplo de retorno

JSON
{
  "status": "sucesso",
  "cache": false,
  "hash": "a1b2c3d4e5f6a7b8c9d0e1f2a3b4c5d6",
  "produto": "cadastral",
  "resultado": {
    "informacoes_gerais": {
      "documento": "Busca por Endereço",
      "tipo": "ENDERECO",
      "status_consulta": "sucesso"
    },
    "resultados": [
      {
        "nome_completo": "MARIANA SOUZA OLIVEIRA SILVA",
        "cpf": "41829304812",
        "data_nascimento": "1987-10-08",
        "sexo": "Feminino",
        "nome_mae": "ALICE SOUZA OLIVEIRA",
        "situacao_cadastral": "REGULAR",
        "socioeconomico": { "renda_presumida": "De R$ 39.048,00 a R$ 42.302,00" },
        "contatos": {
          "telefones": [
            { "tipo": "Móvel", "ddd": "11", "numero": "999991111", "uf": "SP" }
          ],
          "enderecos": [
            {
              "logradouro": "DAS ACACIAS", "tipo": "RUA", "numero": "450",
              "complemento": null, "bairro": "JARDIM DAS FLORES",
              "cidade": "GUARAREMA", "uf": "SP", "cep": "08900999"
            },
            {
              "logradouro": "DEZENOVE DE NOVEMBRO", "tipo": "RUA", "numero": "120",
              "complemento": "BLOCO B", "bairro": "VILA FORMOSA",
              "cidade": "SAO PAULO", "uf": "SP", "cep": "03301000"
            }
          ]
        }
      },
      {
        "nome_completo": "BEATRIZ ALVES CORREIA MATOS",
        "cpf": "19283049182",
        "data_nascimento": "1975-03-06",
        "sexo": "Feminino",
        "nome_mae": "MARIA DOS SANTOS ALVES",
        "situacao_cadastral": "REGULAR",
        "socioeconomico": { "renda_presumida": "De R$ 2.847,25 a R$ 3.254,00", "ocupacao": "Recepcionista, em geral" },
        "contatos": {
          "telefones": [
            { "tipo": "Móvel", "ddd": "77", "numero": "988881111", "uf": "BA" }
          ],
          "enderecos": [
            {
              "logradouro": "SAO SALVADOR", "tipo": "AVENIDA", "numero": "1500",
              "complemento": null, "bairro": "NOVA ESPERANCA",
              "cidade": "IGAPORA", "uf": "BA", "cep": "46490888"
            },
            {
              "logradouro": "DAS ACACIAS", "tipo": "RUA", "numero": "450",
              "complemento": null, "bairro": "JARDIM DAS FLORES",
              "cidade": "GUARAREMA", "uf": "SP", "cep": "08900999"
            }
          ]
        }
      }
      // ... até 20 registros
    ]
  }
}
JSON
{
  "status": "sucesso",
  "cache": false,
  "hash": "3cd65cc9c334f93ea73909aa4d32b4f9",
  "produto": "cadastral",
  "resultado": {
    "informacoes_gerais": {
      "documento": "Busca por Endereço",
      "tipo": "ENDERECO",
      "status_consulta": "sucesso",
      "mensagem": "Não foram encontrados registros com as informações enviadas."
    },
    "quantidade_encontrada": 0,
    "resultados": []
  }
}
JSON
{
  "status": "false",
  "cache": false,
  "hash": null,
  "produto": "cadastral",
  "resultado": {
    "informacoes_gerais": { "tipo": "ENDERECO", "status_consulta": "falha" },
    "retorno_consulta": [],
    "status_code": 502,
    "erro": { "mensagem_erro": "Erro HTTP: 502 - Resposta: error code: 502" }
  }
}

Compatibilidade

Referência rápida de quais tipo_parametro são aceitos por cada produto.

tipo_produtoCPFCNPJPLACACHASSIENDERECO
protesto Em breve✓✓———
cadastral✓✓——✓*
base_estadual——✓✓—
proprietario_atual——✓✓—
negativacoes_pf_boavista✓————
cadin✓✓———
faturamento_presumido_pj✓✓———
limite_credito_pj✓✓———

✓* Cadastral com ENDERECO usa parâmetros de endereço no lugar de parametro. Consulte a seção Cadastral por Endereço.

Erros

A API retorna códigos HTTP padrão. Quando status_code for diferente de 200, considere erro e verifique o campo erro.mensagem_erro.

CódigoStatusCausa comum
200 OK Consulta realizada com sucesso.
401 Unauthorized Header X-SERIAL-HASH ausente ou inválido.
422 Unprocessable Entity Parâmetros inválidos, combinação incompatível de produto/parâmetro ou documento mal formatado.
502 Bad Gateway Falha na comunicação com a fonte de dados. Tente novamente ou use /recuperar com o hash anterior.
500 Internal Server Error Erro interno. Entre em contato com o suporte Atlas.

Estrutura do retorno de falha

JSON
{
  "status": "false",
  "cache": false,
  "hash": null,
  "produto": "{tipo_produto}",
  "resultado": {
    "informacoes_gerais": {
      "documento": "{parametro}",
      "tipo": "{tipo_parametro}",
      "status_consulta": "falha"
    },
    "retorno_consulta": [],
    "status_code": 502,
    "erro": {
      "mensagem_erro": "Erro HTTP: 502 - Resposta: error code: 502"
    }
  }
}