Registrar dados
Consulta na Receita Federal
Retorna se o CPF consultado está regular, irregular, falecido e outras informações da Receita Federal.
Seção: cpf
Parâmetros obrigatórios: cpf, data de nascimento
cpf
Objeto
Objeto com detalhes da consulta de CPF
cpf.statusCode
String
Código de status
cpf.name
String
Nome da pessoa na Receita Federal
cpf.socialName
String
Nome social da pessoa
cpf.birthDate
String
Data de nascimento na Receita Federal
cpf.registrationStatusCode
String
Código da situação cadastral
cpf.registrationStatusMessage
String
Mensagem da situação cadastral
cpf.issueDate
String
Data de emissão do documento na Receita Federal
cpf.deathYear
String
Ano de óbito (se existir)
cpf.deathMessage
String
Mensagem de óbito
{
"cpf": {
"statusCode": "00",
"registrationStatusCode": "00",
"registrationStatusMessage": "REGULAR",
"name": "JOHN DOE",
"socialName": "JANE DOE",
"birthDate": "08/05/1987",
"issueDate": "14/02/2012",
"deathYear": "",
"deathMessage": ""
}
}consulta_cpf
Verifica se foi possível consultar o CPF na Receita Federal.
codigo_erro_cpf
Verifica se o CPF está em situação regular.
cpf_igual_nome
Verifica se o nome encontrado na execução (parâmetro/OCR) é o mesmo da base oficial.
cpf_nao_esta_falecido
A regra será inválida se o CPF consultado estiver em situação de óbito de acordo com os Dados Básicos PF ou a Receita Federal (pfBasicData, cpf e pfData).
maior_de_21
Verifica se o titular do CPF tem mais de 21 anos.
maior_de_18
Verifica se o titular do CPF tem mais de 18 anos.
mais_de_16
Verifica se o titular do CPF tem mais de 16 anos.
mais_de_14
Verifica se o titular do CPF tem mais de 14 anos.
similaridade_primeiro_e_ultimo_nome
Verifica a semelhança entre a união do primeiro e do último nome enviados nos parâmetros comparada à união do primeiro nome e de cada sobrenome na origem.
Consulta na Receita Federal - NOVO (PF2)
Consulta o serviço da Receita Federal brasileira ou fontes privadas (conforme disponibilidade) e retorna se o CPF consultado está em situação regular, irregular ou de óbito. A diferença em relação à origem "cpf" é que ela pode ser consultada sem o parâmetro "birthdate" e regras individuais podem ser aplicadas para os status da Receita Federal: regular, suspenso, nulo, cancelado, óbito e pendente de regularização.
Seção: pfData
Parâmetro obrigatório: cpf
dados
Objeto
Dados retornados
data.name
String
Nome
data.socialName
String
Nome social
data.birthDate
String
Data de nascimento
data.taxIdStatus
String
Status do CPF em relação à Receita Federal
nao_existe_no_banco_de_dados_da_receita_federal
A regra será inválida se o CPF não for encontrado na base de dados da Receita Federal.
nao_esta_vivo
A regra será inválida se o CPF consultado estiver em situação de óbito de acordo com os Dados Básicos PF ou a Receita Federal (pfBasicData e pfData).
nao_esta_pendente_de_regularizacao
A regra será inválida se o CPF consultado estiver com status pendente de regularização na Receita Federal.
nao_esta_cancelado
A regra será inválida se o CPF consultado estiver com cadastro cancelado na Receita Federal.
nao_esta_suspenso
A regra será inválida se o CPF consultado estiver com cadastro suspenso na Receita Federal.
nao_e_nulo
A regra será inválida se o CPF consultado estiver com cadastro nulo na Receita Federal.
maior_de_18
Verifica se o titular do CPF tem mais de 18 anos.
mais_de_16
Verifica se o titular do CPF tem mais de 16 anos.
mais_de_14
Verifica se o titular do CPF tem mais de 14 anos.
consulta_cpf
Verifica se foi possível consultar o CPF na Receita Federal.
codigo_erro_cpf
Verifica se o CPF está em situação regular.
cpf_igual_nome
Verifica se o nome encontrado na execução (parâmetro/OCR) é o mesmo da base oficial.
cpf_nao_esta_falecido
A regra será inválida se o CPF consultado estiver em situação de óbito de acordo com os Dados Básicos PF ou a Receita Federal (pfBasicData, cpf e pfData).
e_cpf_regular
A regra será inválida se o CPF estiver com cadastro irregular na Receita Federal.
intervalos_de_idade_invalidos
Verifica se o titular do CPF está dentro da faixa etária configurada.
Dados básicos (PF1.1)
Coleta informações básicas de um CPF.
Seção: pfBasicData
Parâmetro obrigatório: cpf
dados
Objeto
Dados retornados
data.name
String
Nome
data.socialName
String
Nome social
data.gender
String
Gênero
data.birthDate
String
Data de nascimento
data.birthCountry
String
País de nascimento
data.motherName
String
Nome da mãe
data.fatherName
String
Nome do pai
data.taxIdNumber
String
Número do CPF
data.taxIdCountry
String
País do documento
data.alternativeIdNumbers
Objeto
Números de documentos alternativos
data.alternativeIdNumbers.SocialSecurityNumber
String
Número de Seguro Social
data.taxIdStatus
String
Status do CPF em relação à Receita Federal
data.taxIdOrigin
String
Origem do CPF
data.hasObitIndication
Booleano
Indica se houve óbito dessa pessoa
data.obitIndicationOrigin
String
A origem da informação de óbito
data.obitIndicationYear
String
Ano da indicação de óbito
data.taxIdStatusDate
String
Data da consulta de status
data.creationDate
String
Data de criação
data.lastUpdateDate
String
Última atualização
data.message
String
Descrição do status da consulta
maior_de_21
Verifica se o titular do CPF tem mais de 21 anos.
maior_de_18
Verifica se o titular do CPF tem mais de 18 anos.
mais_de_16
Verifica se o titular do CPF tem mais de 16 anos.
mais_de_14
Verifica se o titular do CPF tem mais de 14 anos.
mais_de_14
Verifica se o titular do CPF tem mais de 14 anos.
cpf_nulo
Verifica se a fonte de dados básicos está retornando valores.
intervalos_de_idade_invalidos
Verifica se o titular do CPF está dentro da faixa etária configurada.
Consulta na Receita Federal - NOVO (PF1.2)
Coleta informações básicas de um CPF.
Seção: pfCpfData
Parâmetros obrigatórios: cpf, data de nascimento
O birthDate parâmetro aceita os formatos DD/MM/AAAA ou AAAA-MM-DD.
dados
Objeto
Dados retornados
data.name
String
Nome
data.socialName
String
Nome social
data.birthDate
String
Data de nascimento
data.issueDate
String
Data de emissão do CPF na Receita Federal (DD/MM/AAAA)
data.taxIdStatus
String
Status do CPF em relação à Receita Federal
data.taxIdNumber
String
Número de identificação do CPF
fonte_big_data_menor_de_idade
Verifica se a fonte retornou que o titular tem menos de 18 anos.
cpf_igual_nome
Verifica se o nome encontrado durante a execução (parâmetro/OCR) corresponde à base oficial.
nao_esta_vivo
Verifica se o CPF pertence a um titular falecido.
nao_esta_pendente_de_regularizacao
Verifica se o CPF possui status pendente de regularização.
nao_esta_cancelado
Verifica se o CPF consta como cancelado na Receita Federal.
nao_esta_suspenso
Verifica se o CPF consta como suspenso na Receita Federal.
nao_e_nulo
Verifica se o CPF consta como nulo na Receita Federal.
consulta_cpf
Verifica se foi possível fazer a consulta na Receita Federal ou não.
E-mails (PF11)
Retorna uma lista dos e-mails da pessoa.
Seção: pfEmails
Parâmetro obrigatório: cpf
dados
Objeto
Dados retornados
items
Array
Dados de e-mails
items[x].email
String
Endereço de e-mail
items[x].type
String
Tipo de e-mail
items[x].firstPassageDate
String
Data da primeira passagem
items[x].lastPassageDate
String
Data da última passagem
Endereços (PF12)
Retorna uma lista com os endereços da pessoa.
Seção: pfAddresses
Parâmetro obrigatório: cpf
mensagem
String
Descrição do status da consulta
dados
Array
Dados retornados
data[x].typology
String
Tipo de logradouro
data[x].title
String
Título/definição
data[x].addressMain
String
Nome
data[x].number
String
Número
data[x].complement
String
Complemento
data[x].neighborhood
String
Bairro
data[x].zipCode
String
CEP
data[x].city
String
Cidade
data[x].state
String
Estado
data[x].country
String
País
data[x].type
String
Lista de endereços
data[x].complementType
String
Tipo de endereço calculado a partir do complemento do endereço
data[x].householdCode
String
Código do domicílio do endereço
data[x].buildingCode
String
Código do edifício do endereço
data[x].householdTotalPassages
Número
Número de vezes que esse código de domicílio foi visto para esta entidade
data[x].householdBadPassages
Número
Número de vezes que esse código de domicílio foi visto para esta entidade em situação suspeita
data[x].householdCrawlingPassages
Número
Quantidade de passagens do domicílio com a entidade que tem uma captura como origem
data[x].householdValidationPassages
Número
Quantidade de passagens do domicílio com a entidade que tem uma captura como origem
data[x].householdQueryPassages
Número
Quantidade de passagens do domicílio com a entidade que tem uma consulta como origem
data[x].householdMonthAveragePassages
Número
Média mensal de vezes que o domicílio foi visto com a entidade
data[x].buildingTotalPassages
Número
Número de entidades distintas associadas a esse domicílio
data[x].buildingTotalPassages
Número
Número de vezes que esse código de edifício foi visualizado para esta entidade
data[x].buildingBadPassages
Número
Número de vezes que esse código de edifício foi visto para esta entidade em situação suspeita
data[x].buildingCrawlingPassages
Número
Quantidade de passagens do edifício com a entidade que tem uma captura como origem
data[x].buildingValidationPassages
Número
Quantidade de passagens do edifício com a entidade que tem uma validação como origem
data[x].buildingQueryPassages
Número
Quantidade de passagens do edifício com a entidade que tem uma consulta como origem
data[x].buildingMonthAveragePassages
Número
Média mensal de vezes que o edifício foi visto com a entidade
data[x].buildingNumberOfHouseholds
Número
Número de domicílios diferentes associados a esse edifício
data[x].last3MonthsPassages
Número
Número de passagens da entidade nos últimos 3 meses
data[x].last6MonthsPassages
Número
Número de passagens da entidade nos últimos 6 meses
data[x].last12MonthsPassages
Número
Número de passagens da entidade nos últimos 12 meses
data[x].last18MonthsPassages
Número
Número de passagens da entidade nos últimos 18 meses
data[x].priority
Número
Indica a prioridade do endereço
data[x].isMain
Booleano
Indica se o endereço é o principal
data[x].isRecent
Booleano
Indica se este endereço é recente
data[x].isActive
Booleano
Indica se esse endereço está ativo
data[x].isRatified
Booleano
Indica se o endereço foi ratificado com a base de referência dos Correios (DNE ou similar)
data[x].firstPassageDate
String
Data da primeira passagem desse domicílio com essa entidade
data[x].lastPassageDate
String
Data da última passagem desse domicílio com essa entidade
data[x].creationDate
String
Data do primeiro registro relacionado
data[x].lastUpdateDate
String
Último endereço atualizado
data[x].hasOptIn
Booleano
Indica se houve aceitação de pedidos nesse endereço
data[x].ibgeCode
String
Código do município
data[x].latitude
Número
Latitude
data[x].longitude
Número
Longitude
Números de telefone (PF13)
Retorna uma lista dos números de telefone da pessoa.
Seção: pfPhones
Parâmetro obrigatório: cpf
dados
Objeto
Dados retornados
items
Array
Dados de telefones
items[x].number
String
Número de telefone
items[x].areaCode
String
Código de área (DDD do estado)
items[x].countryCode
String
Código do país
items[x].type
String
Categoria do número
items[x].lastPassageDate
String
Data do último uso
items[x].portabilityHistory
Array
Histórico de portabilidade
items[x].hasOptIn
Booleano
Aceita ligações de marketing
ANTT
Consulte o site da ANTT para identificar se a transportadora está habilitada para executar atividades.
Seção: antt
Parâmetro obrigatório: cpf, placa
Formatos da placa: AAA9999 ou AAA9A999
dados
Objeto
Dados retornados
data.hasRegister
Booleano
Status informando se contém um registro
data.transporter
String
Transportadora
data.rntrc
String
Número do RNTRC
data.rntrcSituation
String
Status
data.memberSince
String
Data do primeiro relacionamento
data.expirationDate
String
Data de expiração
data.city
String
Cidade
data.message
String
Mensagem presente no registro
nao_tem_participante_antt
A regra será inválida se o veículo consultado e a pessoa/empresa não estiverem autorizados a realizar atividades.
Dados de site (PF32)
Retorna informações sobre os sites e domínios associados ao CPF consultado, seja por registro de domínio ou por informações contidas no próprio conteúdo do site.
Seção: pfDomains
Parâmetro obrigatório: cpf
dados
Array
Dados retornados
data[x].hostName
String
Nome do host
data[x].domainName
String
Nome do domínio
data[x].domainClass
String
Classificação do site
data[x].registrationStatus
String
Status do registro
data[x].registrationDate
String
Data de criação do site
data[x].expirationDate
String
Data de expiração do site
Endereços - NOVO (PF77)
Retorna uma lista de endereços.
Seção: pfAddressesAlt
Parâmetro obrigatório: cpf
dados
Objeto
Dados retornados
data.message
String
Descrição do status da consulta
data.addresses
Array
A lista de endereços ordenada em ordem decrescente de acordo com o nível de confiabilidade
data.addresses[x].street
String
Logradouro
data.addresses[x].number
String
Número do endereço
data.addresses[x].complement
String
Complemento do endereço
data.addresses[x].neighborhood
String
Bairro do endereço
data.addresses[x].zipCode
String
CEP
data.addresses[x].city
String
Cidade
data.addresses[x].state
String
Estado
data.addresses[x].country
String
País
data.addresses[x].completeAddress
String
Endereço completo
Números de telefone - NOVO (PF14)
Retorna uma lista dos números de telefone da pessoa.
*Este recurso não valida menores de idade
Seção: pfPhonesAlt
Parâmetro obrigatório: cpf
mensagem
String
Descrição do status da consulta
dados
Objeto
Dados retornados
data.phones
Array
Dados de telefones
data.phones[x].number
String
Número de telefone
data.phones[x].areaCode
String
Código de área (DDD do estado)
Detalhes do CEP - NOVO (PF15)
Retorna informações detalhadas relacionadas a um CEP, incluindo nome da rua, bairro, cidade, estado e outros dados relevantes.
Seção: zipCodeDetails
Parâmetro obrigatório: cep
dados
Objeto
Dados retornados
data.message
String
Descrição do status da consulta
data.district
String
Bairro
data.street
String
Nome da rua
data.city
String
Cidade
data.cityCodeIbge
String
Código IBGE da cidade
data.ufName
String
Nome do estado
data.uf
String
Sigla do estado
data.ufCodeIbge
String
Código IBGE do estado
Verificação de CURP (PF18)
Coleta informações básicas sobre uma CURP (Clave Única de Registro de Población) no México.
Seção: mxCurpCheck
Parâmetro obrigatório: curp
dados
Objeto
Dados retornados
data.name
String
Nome
data.gender
String
Gênero
data.age
Número
Idade
data.birthDate
String
Data de nascimento
data.birthCountry
String
País de nascimento
data.motherName
String
Nome da mãe
data.fatherName
String
Nome do pai
data.taxIdNumber
String
Número da CURP
data.taxIdStatus
String
Status da CURP em relação à Receita Federal
data.taxIdCountry
String
País do documento
data.taxIdOrigin
String
Origem da CURP
data.taxIdStatusDate
String
Data da consulta de status
data.alternativeIdNumbers
Objeto
Números de documentos alternativos
data.alternativeIdNumbers.socialSecurityNumber
String
Número de Seguro Social
data.hasObitIndication
Booleano
Indica se houve óbito dessa pessoa
data.obitIndicationYear
String
Ano da indicação de óbito
data.creationDate
String
Data de criação
data.lastUpdateDate
String
Última atualização
data.message
String
Descrição do status da consulta
Link de cadastro - NOVO (PF91)
Retorna os dados enviados pelo usuário. Nenhum parâmetro é necessário.
Seção: registryLinkSource
Parâmetro opcional: personId, CPF, CNPJ, RG, CNH, name, birthDate, email, phoneNumber, userIp, documentCountry
data.message
String
Descrição do status da consulta
dados
Objeto
Dados retornados
data.documentId
String
Identificador do documento principal
data.documentType
String
Tipo do documento principal (por exemplo, PERSONID, CPF, CNPJ, RG, CNH)
data.name
String
Nome
data.birthDate
String
Data de nascimento
data.email
String
Endereço de e-mail
data.phoneNumber
String
Número de telefone
data.userIp
String
Endereço IP do usuário
data.documentCountry
String
País do documento
data.additionalDocuments
Array
Lista de documentos adicionais
data.additionalDocuments[x].documentId
String
Identificador do documento
data.additionalDocuments[x].documentType
String
Tipo do documento (por exemplo, CPF, CNPJ, RG, CNH)
Atualizado

