Consulta CPF
Informações e detalhes para consulta do documento brasileiro CPF
Este serviço é destinado para consultar dados de uma pessoa física brasileira a partir do seu documento CPF.
Há possibilidade de dados desatualizados ou até mesmo a inexistência, mas ainda assim a chance de contato direto (CCD) do documento pesquisado é de aproximadamente 90%
Requisição
GET https://api-v3.smsfire.com.br/bigdata/cpf/:input
Rate Limiter: Este serviço possui um limite global de 30 requisições por minuto a partir do mesmo IP.
Parâmetros de requisição
input*
string
Documento CPF a ser pesquisado
12365478909
Exemplos de requisição
var axios = require("axios").default;
const input = "12365478909";
var options = {
method: 'GET',
url: `https://api-v3.smsfire.com.br/bigdata/cpf/${input}`,
headers: {Username: 'seu_usuario', Api_Token: 'seu_token'}
};
axios.request(options).then(function (response) {
console.log(response.data);
}).catch(function (error) {
console.error(error);
});<?php
$endpoint = "https://api-v3.smsfire.com.br/bigdata/cpf/";
$endpoint .= "12365478909";
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => $endpoint,
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Api_Token: seu_token",
"Username: seu_usuario",
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
Somente consultas com dados disponíveis serão tarifadas.
Response
O conjunto de dados retornados será em formato JSON com detalhes da pesquisa ou possível falha da requisição
Esse código de erro será lançado quando a consulta não possuir dados disponíveis em nossas bases de dados.
Erros poderão ser facilmente filtrados a partir dos códigos HTTP retornados e adicionalmente detalhes do erro serão incluídos no JSON que seguirá o seguinte formato:
Requisições que tenham o retorno de algum código HTTP deste nível é devido a falhas internas da API ou servidor.
Neste tipo de situação, entre em contato com a equipe de suporte
id
string Padrão UUID
Identificador único da pesquisa
ip
string
Ip de onde se originou o request a API
doc
string
Documento a pessoa pesquisada
fullname
string
Nome completo
birthday
string AAAA-MM-DD
Data de nascimento
mother
string
Nome completo da mãe
father
string | null
Nome completo do pai
dead
boolean
Confirmação de óbito
income
string
Renda presumida
occupation
string
Profissão presumida
pep
boolean
Pessoa exposta politicamente
maritalStatus
number
Estado cívil
emails
string[]
Relação de e-mails
phones
array
Matriz com relação de telefones
phones[].prefix
string
Código DDI do telefone
phones[].area
string
Código de área
phones[].phone
string
Número de telefone em formato local
phones[].national
string
Número de telefone em formato nacional
phones[].international
string
Número de telefone em formato internacional
addresses
array
Matriz com relação de endereços
addresses[].street
string
Nome da rua
addresses[].number
string | null
Número do endereço
addresses[].complement
string | null
Complemento do endereço
addresses[].neighborhood
string | null
Bairro
addresses[].city
string
Cidade
addresses[].state
string
Estado
addresses[].country
string
País
addresses[].zipcode
string
Código postal (CEP)
addresses[].updated_at
string | Date
Data da última atualização do item
business
array
Matriz com relação de participação societária
business[].doc
string
Cnpj da empresa
business[].name
string
Razão social da empresa
docStatus
Situação cadastral do CPF.
0
Regular
2
Suspenso
3
Falecido
4
Pendente
5
Cancelado
gender
Gênero de nascença da pessoa
1
Masculino
2
Feminino
score
Pontuação de crédito presumido da pessoa
0
Péssimo
1
Ruim
2
Normal
3
Bom
4
Excelente
Atualizado