A Ágil Consulta é um Distribuidor autorizado da Serasa Experian no Brasil. Nosso objetivo é oferecer informações de crédito e cadastrais atualizadas, de maneira rápida e com toda a segurança, para você e a sua empresa. Nossos dados colaboram para a realização de uma venda segura e assertiva, uma vez que minimizam o risco de inadimplência. Também auxiliam na tomada de decisão no consentimento de créditos para pessoas físicas e jurídicas, na busca de clientes por perfil financeiro e até na escolha de fornecedores e funcionários. Seja nosso cliente e receba todas as vantagens do maior banco de dados financeiros, com agilidade, seriedade e muito respeito ao seu negócio.

O acesso a API será realizado a partir do domínio https://api.agilconsulta.com.br sendo possível consultar seus métodos de entrada e retorno conforme o aplicativo Swagger (“https://api.agilconsulta.com.br/swagger”).

3.1 Parâmetros de Entrada

A API possui dois métodos de consulta conforme a necessidade do usuário, CPF ou CNPJ.
Para Pessoa Física selecionar o método CPF. Caso Pessoa Jurídica utilizar o método CNPJ.
Além disso foi disponibilizado uma variável na qual pode-se selecionar se a requisição será no {ambiente} de Homologação ou Produção.
Observação: Por default o método de Produção vem desativado. Favor solicitar a Agil Consulta a liberação do módulo.
Apenas consultas de cpf/cnpf fictícios são disponibilizados no ambiente de Homologação.

Abaixo segue exemplos de requisição:
Homologação + Pessoa Física https://api.agilconsulta.com.br/api/homologacao/infomais/cpf/{cpf} {cpf} : cpf a ser pesquisado
Produção + Pessoa Física https://api.agilconsulta.com.br/api/producao/infomais/cpf/{cpf} {cpf} : cpf a ser pesquisado
Homologação + Pessoa Jurídica https://api.agilconsulta.com.br/api/homologacao/infomais/cnpj/{cnpj} {cnpj} : cnpj a ser pesquisado
Produção + Pessoa Jurídica https://api.agilconsulta.com.br/api/producao/infomais/cnpj/{cnpj} {cnpj} : cnpj a ser pesquisado

3.2 Autenticação

Para acesso a respectiva API será necessário que o cliente tenha recebido em seu e-mail seu usuário e senha desta API.
Todas as requisições à API devem ser autenticadas através do método Basic Authentication.
Para isso, deve-se incluir um header AUTHORIZATION com o valor : em base64.
Exemplo:
• Usuário: cliente • Senha: senha-cliente • Base64:
Dados para acesso Homologação:
Usuário: teste
Senha: 12345

3.3 Corpo da Requisição (Body)

Será necessário o usuário informar os parâmetros de retorno que o usuário deseja receber na resposta. Para isso será necessário inserir as informações no body da requisição no formato .JSON.
3.3.1 Pessoa Física
{
"nome": true,
"endereco": true
}
3.3.2 Pessoa Jurídica
{
"cnpj": true,
"razaoSocial": true,
"nomeFantasia": true,
"capitalSocial": true,
"dataAbertura": true,
"dataAberturaSpecified": true,
"naturezaJuridica": true,
"cnae": true,
"situacaoCadastral": true,
"porte": true,
"quadroSocial": true,
"representanteLegal": true,
"sintegra": true,
"faturamento": true,
"funcionarios": true,
"indicadorOperacionalidade": true,
"ccf": true,
"codIbge": true,
"simplesNacional": true

}
3.4 Formato de Resposta
Formato de resposta no formato JSON conforme o tipo de requisição solicitada. Exemplo retorno PJ:
{
"cnpj": "98337751000100",
"razaoSocial": "FANKHAUSER S/A",
"nomeFantasia": null,
"capitalSocial": null,
"dataAbertura": "1966-08-16T00:00:00-03:00",
"dataAberturaSpecified": true,
"naturezaJuridica": {
"codigo": 2054,
"descricao": "Sociedade Anônima Fechada "
},
"cnae": [
{
"codigo": "2833000",
"descricao": "Fabricação de máquinas e equipamentos para a agricultura e pecuária, peças e acessórios, exceto para irrigação" },
{
"codigo": "3321000",
"descricao": "Instalação de máquinas e equipamentos industriais" },
{
"codigo": "2832100",
"descricao": "Fabricação de equipamentos para irrigação agrícola, peças e acessórios" }
],
"situacaoCadastral": {
"codigoSituacao": 1,
"codigoSituacaoSpecified": true,
"situacao": "ATIVA",
"dataSituacao": "2005-11-03T00:00:00-02:00",
"situacaoEspecial": null,
"dataEspecial": "0001-01-01T00:00:00",
"motivo": null,
"dataConsulta": "2017-10-23T00:00:00-02:00",
"fontePesquisada": "HISTORICO"
},
"porte": "MÉDIA",
"quadroSocial": null,
"representanteLegal": null,
"sintegra": null,
"faturamento": null,
"funcionarios": null,
"indicadorOperacionalidade": null,
"ccf": null,
"codIbge": null,
"simplesNacional": null,
"triagemDeRisco": null,
"matrizFilial": null,
"latitude": null,
"longitude": null,
"listaSuframa": null,
"mosaic": null,
"email": null,
"emailValidado": null,
"maquinaCartao": null,
"possuiNfc": null,
"possuiCashback": null,
"possuiMaquinaPosto": null,
"ultimaOperacao": null,
"canalVendas": null,
"horarioAtendimento": null,
"id": null,
"enderecos": [
{
"logradouro": {
"completo": null,
"tipo": "",
"titulo": "",
"nome": "AV MAUA",
"numero": "2092",
"complemento": "CASA",
"cepNota": 10
},
"bairro": "CENTRO",
"cidade": "TUPARENDI",
"uf": "RS",
"cep": "98940000",
"idFinalidade": 0,
"idFinalidadeSpecified": false
},
{
"logradouro": {
"completo": null,
"tipo": "AV",
"titulo": null,
"nome": "MAUA",
"numero": "1092",
"complemento": "CX POSTAL 12",
"cepNota": 9
},
"bairro": "CENTRO",
"cidade": "TUPARENDI",
"uf": "RS",
"cep": "98940000",
"idFinalidade": 0,
"idFinalidadeSpecified": false
},
{
"logradouro": {
"completo": null,
"tipo": "AV",
"titulo": null,
"nome": "MAUA",
"numero": "543",
"complemento": null,
"cepNota": 9
},
"bairro": "CENTRO",
"cidade": "TUPARENDI",
"uf": "RS",
"cep": "98940000",
"idFinalidade": 0,
"idFinalidadeSpecified": false
},
{
"logradouro": {
"completo": null,
"tipo": "ROD",
"titulo": null,
"nome": "BR 277",
"numero": "277",
"complemento": "277 KM 577",
"cepNota": 10
}, "bairro": "STA FELICIDADE",
"cidade": "CASCAVEL",
"uf": "PR",
"cep": "85803490",
"idFinalidade": 0,
"idFinalidadeSpecified": false
},
{
"logradouro": {
"completo": null,
"tipo": "ROD",
"titulo": null,
"nome": "BR 277",
"numero": "277",
"complemento": "KM 577",
"cepNota": 10
},
"bairro": "CASCAVEL VELHO",
"cidade": "CASCAVEL",
"uf": "PR",
"cep": "85818560",
"idFinalidade": 0,
"idFinalidadeSpecified": false
}
],
"telefones": [
{
"ddd": "55",
"numero": "35430000",
"tipo": null,
"finalidade": 0,
"finalidadeSpecified": false
},
{
"ddd": "55",
"numero": "35430048",
"tipo": null,
"finalidade": 0,
"finalidadeSpecified": false
},
{
"ddd": "55",
"numero": "35431034",
"tipo": null,
"finalidade": 0,
"finalidadeSpecified": false
},
{
"ddd": "55",
"numero": "35431048",
"tipo": null,
"finalidade": 0,
"finalidadeSpecified": false
},
{
"ddd": "55",
"numero": "35431108",
"tipo": null,
"finalidade": 0,
"finalidadeSpecified": false
}
]
}
Exemplo de Retorno PF:
{
"cpf": "66788862834",
"nome": "ABE KRYSS",
"dataNascimento": "0001-01-01T00:00:00",
"dataNascimentoSpecified": false,
"idade": 0,
"idadeSpecified": false,
"signo": null,
"sexo": null,
"nomeMae": null,
"finalidadeNomeMae": 0,
"finalidadeNomeMaeSpecified": false,
"situacaoCadastral": null,
"renda": null,
"triagemRisco": null,
"atividadeConsumo": null,
"sociosEmpresa": null,
"profissao": null,
"estadoCivil": null,
"escolaridade": null,
"bolsaFamilia": false,
"bolsaFamiliaSpecified": false,
"mosaic": null,
"mosaicGrupo": null,
"mosaicDescricao": null,
"classeSocial": null,
"afinidadeCartaoCredito": false,
"afinidadeCartaoCreditoSpecified": false,
"afinidadeCreditoPessoal": false,
"afinidadeCreditoPessoalSpecified":
false,
"afinidadeArtigosLuxo": false,
"afinidadeArtigosLuxoSpecified": false,
"afinidadePacotesTurismo": false,
"afinidadePacotesTurismoSpecified":
false,
"afinidadeCelularPosPago": false,
"afinidadeCelularPosPagoSpecified":
false,
"afinidadeImobiliario": false,
"afinidadeImobiliarioSpecified": false,
"afinidadeTvAssinatura": false,
"afinidadeTvAssinaturaSpecified": false,
"afinidadeBandaLarga": false,
"afinidadeBandaLargaSpecified": false,
"afinidadeEcommerce": false,
"afinidadeEcommerceSpecified": false,
"afinidadeClientePremium": false,
"afinidadeClientePremiumSpecified":
false,
"afinidadeSmartphone": false,
"afinidadeSmartphoneSpecified": false,
"ccf": null,
"codIbge": null,
"facesClasseMedia": null,
"latitude": null,
"longitude": null,
"nis": null,
"rg": null,
"servidorPublicoFederal": false,
"servidorPublicoFederalSpecified": false,
"houseHoldID": null,
"houseHoldRenda": null,
"houseHoldQtdPessoa": null,
"representanteLegal": null,
"inibir": 0,
"inibirSpecified": true,
"mensagem": null,
"flagObito": false,
"flagObitoSpecified": false,
"pep": null,
"obito": null,
"pepRelacionado": null,
"email": null,
"emailValidado": null,
"poderAquisitivo": null,
"houseHoldFlagIdade": null,
"mapaDeParentes": null,
"menorDeIdade": false,
"menorDeIdadeSpecified": false,
"id": null,
"enderecos": [
{
"logradouro": {
"completo": null,
"tipo": "R",
"titulo": null,
"nome": "DAVID PIMENTEL",
"numero": "1145",
"complemento": null,
"cepNota": 10
},
"bairro": "FAZ MORUMBI",
"cidade": "SAO PAULO",
"uf": "SP",
"cep": "05657010",
"idFinalidade": 0,
"idFinalidadeSpecified": true
},
{
"logradouro": {
"completo": null,
"tipo": "R",
"titulo": null,
"nome": "JOSEF KRYSS",
"numero": "179",
"complemento": null,
"cepNota": 10
},
"bairro": "PRQ INDUST TOMAS EDSON",
"cidade": "SAO PAULO",
"uf": "SP",
"cep": "01140050",
"idFinalidade": 0,
"idFinalidadeSpecified": true
},
{
"logradouro": {
"completo": null,
"tipo": "R",
"titulo": null,
"nome": "MARGOT",
"numero": "12",
"complemento": null,
"cepNota": 9
},
"bairro": "PR JUQUEI",
"cidade": "MARESIAS",
"uf": "SP",
"cep": "11620000",
"idFinalidade": 0,
"idFinalidadeSpecified": true
},
{
"logradouro": {
"completo": null,
"tipo": "R",
"titulo": null,
"nome": "14",
"numero": "114",
"complemento": "LT",
"cepNota": 9
},
"bairro": "VL INGLESA",
"cidade": "CAMPOS DO JORDAO",
"uf": "SP",
"cep": "12460000",
"idFinalidade": 0,
"idFinalidadeSpecified": true
}
],
"telefones": null
} 3.5 Erros Exceções
Abaixo segue possíveis erros que a API poderá apresentar.
Seu retorno é através de uma mensagem no formato JSON.
Erro Ação
"Cabeçalho de autenticação não encontrado" Inserir o cabeçalho na respectiva requisição. Favor verificar as instruções citadas neste documento.
“Houve um erro ao realizar a consulta. Erro:” Erro ao realizar a requisição. Verificar a mensagem de erro e informar a Agil Consulta com a informação apresentada.
"Usuário não localizado" Login informado na requisição não é válido.
"Senha incorreta" Senha informada na requisição não é válida.
"Produto inativo para este login" Produto INFOMAIS não habilitado para este login. Solicitar a Agil Consulta a ativação.
"URL Informada inválida!" Endereço da requisição informada é inválido. Favor verificar neste documento o padrão de requisição.
"Cliente não liberado para consultas em produção" Módulo de produção não habilitado ao respectivo cliente. Solicitar a Agil Consulta o desbloqueio do módulo.
“Houve um erro ao realizar a consulta. Erro: 101 - Parâmetro cpf/cnpj é inválido.” Erro apresentado no ambiente de testes. CPF informado é inválido para a requisição.
“Produto não liberado para o respectivo cliente” Produto INFOMAIS não habilitado para este login. Solicitar a Agil Consulta a ativação.
“Data de vencimento expirada. Favor solicitar a liberação junto a Agil Consulta.” Data de vencimento contratual expirada. Solicitar a Agil Consulta a prorrogação de prazo.
“Limite de consultas dia excedido. Favor solicitar a liberação junto a Agil Consulta.” Total de consultas dia excedido. Favor solicitar o aumento de consultas dia caso necessário.
“Limite de consultas mês excedido. Favor solicitar a liberação junto a Agil Consulta.” Total de consultas mês excedido. Favor solicitar o aumento de consultas mês caso necessário.

加载API Playground