Register data
Consultation at Receita Federal
Returns if the consulted CPF is Regular, Irregular, Death and other information from the Receita Federal.
Section: cpf
Required parameters: cpf, birthDate
cpf
Object
Object with CPF query details
cpf.statusCode
String
Status Code
cpf.name
String
Name of the person at the IRS
cpf.birthDate
String
Date of birth at the Federal Inland Revenue
cpf.registrationStatusCode
String
Cadastral situation code
cpf.registrationStatusMessage
String
Message Cadastral situation
cpf.issueDate
String
Date of issuance of the document at the Federal Inland Revenue Service
cpf.deathYear
String
Death year (if existent)
cpf.deathMessage
String
Message of death
Consultation at Receita Federal - NEW (PF2)
Query the Brazilian Receita Federal Service or private sources (according to availability), and return whether the consulted CPF is in regular, irregular, or deceased status. Its difference from the "cpf" source is that it can be queried without the "birthdate" parameter, and individual rules can be applied for the Receita Federal status: regular, suspended, null, canceled, deceased, and pending regularization.
Section: pfData
Required parameter: cpf
statusCode
String
data
Object
Return data
data.name
String
Name
data.birthDate
String
Date of birth
data.taxIdStatus
String
CPF status in relation to the Internal Revenue Service
Basic Data (PF1.1)
Gathers basic information about a CPF.
Section: pfBasicData
Required parameter: cpf
statusCode
String
data
Object
Return data
data.name
String
Name
data.gender
String
Genre
data.birthDate
String
Date of birth
data.birthCountry
String
Country of birth
data.motherName
String
Mother's name
data.fatherName
String
Father's name
data.taxIdNumber
String
CPF number
data.taxIdCountry
String
Document country
data.alternativeIdNumbers
Object
Alternative document numbers
data.alternativeIdNumbers.SocialSecurityNumber
String
Social Security Number
data.taxIdStatus
String
CPF status in relation to the Internal Revenue Service
data.taxIdOrigin
String
Origin of the CPF
data.hasObitIndication
Boolean
Indicate if there was a death for that person
data.obitIndicationOrigin
String
The source of the death information
data.obitIndicationYear
String
Year of death indication
data.taxIdStatusDate
String
Status Query Date
data.creationDate
String
Creation date
data.lastUpdateDate
String
Last updated
data.message
String
Description of the query status
Consultation at Receita Federal - NEW (PF1.2)
Gathers basic information about a CPF.
Section: pfCpfData
Required parameter: cpf
statusCode
String
data
Object
Return data
data.name
String
Name
data.birthDate
String
Date of birth
data.taxIdStatus
String
CPF status in relation to the Internal Revenue Service
data.taxIdNumber
String
CPF Id number
Emails (PF11)
Returns a list of the person's e-mails.
Section: pfEmails
Required parameter: cpf
statusCode
String
data
Object
Return data
items
Array
Emails data
items[x].email
String
Email address
items[x].type
String
Email Type
items[x].firstPassageDate
String
Date of first passage
items[x].lastPassageDate
String
Date of last passage
Addresses (PF12)
Retorna uma lista com os endereços da pessoa.
Section: pfAddresses
Required parameter: cpf
statusCode
String
message
String
Description of the query status
data
Array
Return data
data[x].typology
String
Street Type
data[x].title
String
Title/Definition
data[x].addressMain
String
Name
data[x].number
String
Number
data[x].complement
String
Supplement
data[x].neighborhood
String
Neighborhood
data[x].zipCode
String
ZIP CODE
data[x].city
String
City
data[x].state
String
State
data[x].country
String
Country
data[x].type
String
Address List
data[x].complementType
String
Address type calculated from the address complement
data[x].householdCode
String
Household code of address
data[x].buildingCode
String
Address building code
data[x].householdTotalPassages
Number
Number of times this household code has been seen for this entity
data[x].householdBadPassages
Number
Number of times this household code has been seen for this entity in a suspicious situation
data[x].householdCrawlingPassages
Number
Quantidade de passagens do household com a entidade que tem como origem uma captura
data[x].householdValidationPassages
Number
Quantity of household passages with the entity that has a capture as origin
data[x].householdQueryPassages
Number
Quantity of household's tickets with the entity that originates a query
data[x].householdMonthAveragePassages
Number
Average number of times the household was seen with the entity per month
data[x].householdNumberOfEntities
Number
Number of distinct entities associated with this household
data[x].buildingTotalPassages
Number
Number of times this building code has been viewed for this entity
data[x].buildingBadPassages
Number
Number of times this building code has been seen for this entity in a suspicious situation
data[x].buildingCrawlingPassages
Number
Quantity of building passes with the entity that has a capture as origin
data[x].buildingValidationPassages
Number
Quantity of building passes with the entity that has a validation as origin
data[x].buildingQueryPassages
Number
Quantity of building passes with the entity that originates a query
data[x].buildingMonthAveragePassages
Number
Average number of times the building was seen with the entity per month
data[x].buildingNumberOfHouseholds
Number
Number of different households associated with this building
data[x].last3MonthsPassages
Number
Number of entity passages in the last 3 months
data[x].last6MonthsPassages
Number
Number of entity passages in the last 6 months
data[x].last12MonthsPassages
Number
Number of entity passages in the last 12 months
data[x].last18MonthsPassages
Number
Number of entity passages in the last 18 months
data[x].priority
Number
Indicates the priority of the address
data[x].isMain
Boolean
Indicates whether the address is the primary address
data[x].isRecent
Boolean
Indicates whether this address is recent
data[x].isActive
Boolean
Indica se esse endereço está ativo
data[x].isRatified
Boolean
Indicates whether the address has been ratified with the post office's reference base (DNE or similar)
data[x].firstPassageDate
String
Date of the first passage of this household with this entity
data[x].lastPassageDate
String
Date of the last passage of this household with this entity
data[x].creationDate
String
Date of first related record
data[x].lastUpdateDate
String
Last updated address
data[x].hasOptIn
Boolean
Indicates if there has been acceptance of orders at that address
data[x].ibgeCode
String
Municipality code
data[x].latitude
Number
Latitude
data[x].longitude
Number
Longitude
Phone numbers (PF13)
Returns a list of the person's phone numbers.
Section: pfPhones
Required parameter: cpf
statusCode
String
data
Object
Return data
items
Array
Phones data
items[x].number
String
Phone Number
items[x].areaCode
String
Area code (DDD of the state)
items[x].countryCode
String
Country Code
items[x].type
String
Number's category
items[x].lastPassageDate
String
Date of last use
items[x].portabilityHistory
Array
Porting History
items[x].hasOptIn
Boolean
Accepts marketing calls
ANTT
Consult the ANTT website to identify if the carrier is qualified to perform activities.
Section: antt
Required parameter: cpf, plate
Plate formats: AAA9999 or AAA9A999
statusCode
String
data
Object
Return data
data.hasRegister
Boolean
Status informing whether it contains a record
data.transporter
String
Carrier
data.rntrc
String
RNTRC Number
data.rntrcSituation
String
Status
data.memberSince
String
Date of first relationship
data.expirationDate
String
Expiration Date
data.city
String
City
data.message
String
Message present at registration
Site Data (PF32)
Returns information about the sites and domains that are associated with the queried CPF, either through domain registration or through information contained within the site content itself.
Section: pfDomains
Required parameter: cpf
statusCode
String
data
Array
Return data
data[x].hostName
String
Host Name
data[x].domainName
String
Domain name
data[x].domainClass
String
Site Classification
data[x].registrationStatus
String
Registration Status
data[x].registrationDate
String
Site creation date
data[x].expirationDate
String
Site Expiration Date
Addresses - NEW (PF77)
Returns an addresses list.
Section: pfAddressesAlt
Required parameter: cpf
statusCode
String
data
Object
Return data
data.message
String
Description of the query status
data.addresses
Array
The addresses list sorted in descending order according to the level of reliability
data.addresses[x].street
String
Street address
data.addresses[x].number
String
Address number
data.addresses[x].complement
String
Address complement
data.addresses[x].neighborhood
String
Address neighborhood
data.addresses[x].zipCode
String
Zip code
data.addresses[x].city
String
City
data.addresses[x].state
String
State
data.addresses[x].country
String
Country
data.addresses[x].completeAddress
String
Complete address
Phone numbers - NEW (PF14)
Returns a list of the person's phone numbers.
Section: pfPhonesAlt
Required parameter: cpf
statusCode
String
message
String
Description of the query status
data
Object
Return data
data.phones
Array
Phones data
data.phones[x].number
String
Phone Number
data.phones[x].areaCode
String
Area code (DDD of the state)
Zip code details - NEW (PF15)
Returns detailed information related to a ZIP code, including street name, district, city, state, and other relevant data.
Section: zipCodeDetails
Required parameter: cep
statusCode
String
data
Object
Return data
data.message
String
Description of the query status
data.district
String
District
data.street
String
Street name
data.city
String
City
data.cityCodeIbge
String
City IBGE code
data.ufName
String
State name
data.uf
String
State abbreviation
data.ufCodeIbge
String
State IBGE code
Last updated