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

Attribute	Type	Description
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

Attribute

Type

Description

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

{
  "cpf": {
    "statusCode": "00",
    "registrationStatusCode": "00",
    "registrationStatusMessage": "REGULAR",
    "name": "JOHN DOE",
    "birthDate": "08/05/1987",
    "issueDate": "14/02/2012",
    "deathYear": "",
    "deathMessage": ""
  }
}

Rule	Description
cpf_query	Check if it was possible to consult the CPF at the Receita Federal.
cpf_error_code	Checks that the CPF is in order.
cpf_equal_name	Checks that the name found in the run (parameter/OCR) is the same as the official database.
cpf_has_not_dead	The rule will be invalid if the consulted CPF is in a deceased status according to the Basic PF Data or Receita Federal (pfBasicData, cpf, and pfData).
over_21	Checks if the CPF holder is over 21 years old.
over_18	Checks if the CPF holder is over 18 years old.
over_16	Checks if the CPF holder is over 16 years old.
over_14	Checks if the CPF holder is over 14 years old.
first_and_last_name_similarity	Checks the similarity between the union of the first and last name sent in the parameters compared to the union of the first name and each surname in the source.

Rule

Description

cpf_query

Check if it was possible to consult the CPF at the Receita Federal.

cpf_error_code

Checks that the CPF is in order.

cpf_equal_name

Checks that the name found in the run (parameter/OCR) is the same as the official database.

cpf_has_not_dead

The rule will be invalid if the consulted CPF is in a deceased status according to the Basic PF Data or Receita Federal (pfBasicData, cpf, and pfData).

over_21

Checks if the CPF holder is over 21 years old.

over_18

Checks if the CPF holder is over 18 years old.

over_16

Checks if the CPF holder is over 16 years old.

over_14

Checks if the CPF holder is over 14 years old.

first_and_last_name_similarity

Checks the similarity between the union of the first and last name sent in the parameters compared to the union of the first name and each surname in the source.

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

Attribute	Type	Description
statusCode	String	Query status (details)
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

Attribute

Type

Description

statusCode

String

Query status (details)

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

{
  "statusCode": "01",
  "data": {
    "name": "JOHN DOE",
    "taxIdStatus": "REGULAR",
    "birthDate": "08/05/1999"
  }
}

Rule	Description
does_not_exist_on_receita_federal_database	The rule will be invalid if the CPF is not found in the Receita Federal database.
is_not_alive	The rule will be invalid if the consulted CPF is in a deceased status according to the Basic PF Data or Receita Federal (pfBasicData and pfData).
is_not_pendant_of_regularization	The rule will be invalid if the consulted CPF has pending regularization status in the Receita Federal.
is_not_cancelled	The rule will be invalid if the consulted CPF has canceled registration in the Receita Federal.
is_not_suspended	The rule will be invalid if the consulted CPF has suspended registration status in the Receita Federal.
is_not_null	The rule will be invalid if the consulted CPF has null registration status in the Receita Federal.
over_18	Checks if the CPF holder is over 18 years old.
over_16	Checks if the CPF holder is over 16 years old.
over_14	Checks if the CPF holder is over 14 years old.
cpf_query	Check if it was possible to consult the CPF at the Receita Federal.
cpf_error_code	Checks that the CPF is in order.
cpf_equal_name	Checks that the name found in the run (parameter/OCR) is the same as the official database.
cpf_has_not_dead	The rule will be invalid if the consulted CPF is in a deceased status according to the Basic PF Data or Receita Federal (pfBasicData, cpf, and pfData).
is_cpf_regular	The rule will be invalid if the CPF has irregular registration in the Receita Federal.
invalid_range_ages	Checks that the CPF holder is within the configured age range.

Rule

Description

does_not_exist_on_receita_federal_database

The rule will be invalid if the CPF is not found in the Receita Federal database.

is_not_alive

The rule will be invalid if the consulted CPF is in a deceased status according to the Basic PF Data or Receita Federal (pfBasicData and pfData).

is_not_pendant_of_regularization

The rule will be invalid if the consulted CPF has pending regularization status in the Receita Federal.

is_not_cancelled

The rule will be invalid if the consulted CPF has canceled registration in the Receita Federal.

is_not_suspended

The rule will be invalid if the consulted CPF has suspended registration status in the Receita Federal.

is_not_null

The rule will be invalid if the consulted CPF has null registration status in the Receita Federal.

over_18

Checks if the CPF holder is over 18 years old.

over_16

Checks if the CPF holder is over 16 years old.

over_14

Checks if the CPF holder is over 14 years old.

cpf_query

Check if it was possible to consult the CPF at the Receita Federal.

cpf_error_code

Checks that the CPF is in order.

cpf_equal_name

Checks that the name found in the run (parameter/OCR) is the same as the official database.

cpf_has_not_dead

The rule will be invalid if the consulted CPF is in a deceased status according to the Basic PF Data or Receita Federal (pfBasicData, cpf, and pfData).

is_cpf_regular

The rule will be invalid if the CPF has irregular registration in the Receita Federal.

invalid_range_ages

Checks that the CPF holder is within the configured age range.

Basic Data (PF1.1)

Gathers basic information about a CPF.

Section: pfBasicData

Required parameter: cpf

Attribute	Type	Description
statusCode	String	Query status (details)
data	Object	Return data
data.name	String	Name
data.gender	String	Genre
data.birthDate	String	Date 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	Indication of death
data.obitIndicationOrigin	String	Indication of death
data.obitIndicationYear	String	Year of death indication
data.taxIdStatusDate	String	Status Query Date
data.creationDate	String	Creation date
data.lastUpdateDate	String	Last updated

Attribute

Type

Description

statusCode

String

Query status (details)

data

Object

Return data

data.name

String

Name

data.gender

String

Genre

data.birthDate

String

Date 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

Indication of death

data.obitIndicationOrigin

String

Indication of death

data.obitIndicationYear

String

Year of death indication

data.taxIdStatusDate

String

Status Query Date

data.creationDate

String

Creation date

data.lastUpdateDate

String

Last updated

{
  "statusCode": "01",
  "data": {
    "taxIdNumber": "03852939097",
    "taxIdCountry": "BRAZIL",
    "name": "JOHN DOE",
    "gender": "M",
    "birthDate": "1999-05-08T00:00:00Z",
    "birthCountry": "BRASILEIRA",
    "motherName": "MARIA DOE",
    "fatherName": "",
    "taxIdStatus": "REGULAR",
    "hasObitIndication": false,
    "obitIndicationOrigin": "",
    "obitIndicationYear": ""
  }
}

Rule	Description
over_21	Checks if the CPF holder is over 21 years old.
over_18	Checks if the CPF holder is over 18 years old.
over_16	Checks if the CPF holder is over 16 years old.
over_14	Checks if the CPF holder is over 14 years old.
over_14	Checks if the CPF holder is over 14 years old.
cpf_null	Checks that the basic data source is returning values.
invalid_range_ages	Checks that the CPF holder is within the configured age range.

Rule

Description

over_21

Checks if the CPF holder is over 21 years old.

over_18

Checks if the CPF holder is over 18 years old.

over_16

Checks if the CPF holder is over 16 years old.

over_14

Checks if the CPF holder is over 14 years old.

over_14

Checks if the CPF holder is over 14 years old.

cpf_null

Checks that the basic data source is returning values.

invalid_range_ages

Checks that the CPF holder is within the configured age range.

Emails (PF11)

Returns a list of the person's e-mails.

Section: pfEmails

Required parameter: cpf

Attribute	Type	Description
statusCode	String	Query status (details)
data	Array	Return data
data[x].email	String	Email address
data[x].type	String	Email Type
data[x].firstPassageDate	String	Date of first passage
data[x].lastPassageDate	String	Date of last passage

Attribute

Type

Description

statusCode

String

Query status (details)

data

Array

Return data

data[x].email

String

Email address

data[x].type

String

Email Type

data[x].firstPassageDate

String

Date of first passage

data[x].lastPassageDate

String

Date of last passage

{
  "statusCode": "01",
  "data": {
    "items": [
      {
        "email": "[email protected]",
        "type": "personal",
        "firstPassageDate": "2018-04-22T06:06:56.957Z",
        "lastPassageDate": "2020-08-04T09:17:15.041Z"
      }
    ]
  }
}

Addresses (PF12)

Retorna uma lista com os endereços da pessoa.

Section: pfAddresses

Required parameter: cpf

Attribute	Type	Description
statusCode	String	Query status (details)
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	Number	Household code of address
data[x].buildingCode	Number	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	Accepts orders and advertisements
data[x].ibgeCode	String	IBGE Code
data[x].latitude	Number	Latitude
data[x].longitude	Number	Longitude

Attribute

Type

Description

statusCode

String

Query status (details)

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

Number

Household code of address

data[x].buildingCode

Number

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

Accepts orders and advertisements

data[x].ibgeCode

String

IBGE Code

data[x].latitude

Number

Latitude

data[x].longitude

Number

Longitude

{
  "statusCode": "01",
  "data": {
    "items": [
      {
        "typology": "RUA",
        "title": "",
        "addressMain": "XXXXXX XXXXXXX",
        "number": "17",
        "complement": "",
        "neighborhood": "CENTRO",
        "zipCode": "XXXXXXXX",
        "city": "XXXXXXXXXXX",
        "state": "XX",
        "country": "Brazil",
        "type": "WORK",
        "complementType": "",
        "householdCode": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "buildingCode": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
        "householdTotalPassages": 1,
        "householdBadPassages": "",
        "householdCrawlingPassages": 1,
        "householdValidationPassages": "",
        "householdQueryPassages": -1,
        "householdMonthAveragePassages": "",
        "householdNumberOfEntities": "",
        "buildingTotalPassages": 1,
        "buildingBadPassages": "",
        "buildingCrawlingPassages": 1,
        "buildingValidationPassages": "",
        "buildingQueryPassages": -1,
        "buildingMonthAveragePassages": "",
        "buildingNumberOfHouseholds": -1,
        "last3MonthsPassages": -1,
        "last6MonthsPassages": -1,
        "last12MonthsPassages": -1,
        "last18MonthsPassages": -1,
        "priority": 1,
        "isMain": true,
        "isRecent": false,
        "isActive": true,
        "isRatified": false,
        "firstPassageDate": "2016-02-01T00:00:00Z",
        "lastPassageDate": "2016-02-01T00:00:00Z",
        "creationDate": "2016-02-01T00:00:00Z",
        "lastUpdateDate": "2016-02-01T00:00:00Z",
        "hasOptIn": false,
        "ibgeCode": "XXXXXX",
        "latitude": -00.00,
        "longitude": -00.00
      }
    ]
  }
}

Phone numbers (PF13)

Returns a list of the person's phone numbers.

Section: pfPhones

Required parameter: cpf

Attribute	Type	Description
statusCode	String	Query status (details)
data	Array	Return data
data[x].number	String	Phone Number
data[x].areaCode	String	Area code
data[x].countryCode	String	Country Code
data[x].type	String	Number category
data[x].lastPassageDate	String	Date of last use
data[x].portabilityHistory	Array	Porting History
data[x].hasOptIn	Boolean	Accepts marketing calls

Attribute

Type

Description

statusCode

String

Query status (details)

data

Array

Return data

data[x].number

String

Phone Number

data[x].areaCode

String

Area code

data[x].countryCode

String

Country Code

data[x].type

String

Number category

data[x].lastPassageDate

String

Date of last use

data[x].portabilityHistory

Array

Porting History

data[x].hasOptIn

Boolean

Accepts marketing calls

{
  "statusCode": "01",
  "data": [
    {
      "number": "",
      "areaCode": "",
      "countryCode": "",
      "type": "",
      "lastPassageDate": "",
      "portabilityHistory": [
        {
          "hasOptIn": false
        }
      ]
    }
  ]
}

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

Attribute	Type	Description
statusCode	String	Query status (details)
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

Attribute

Type

Description

statusCode

String

Query status (details)

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

{
  "statusCode": "01",
  "data": {
    "message": "Não foram encontrados transportadores para o filtro informado."
  }
}

Rule	Description
has_no_participant_antt	The rule will be invalid if the consulted vehicle and person/company are not authorized to perform activities.

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

Attribute	Type	Description
statusCode	String	Query status (details)
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

Attribute

Type

Description

statusCode

String

Query status (details)

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

{
  "statusCode": "01",
  "data": [
    {
      "hostName": "",
      "domainName": "",
      "domainClass": "",
      "registrationStatus": "",
      "registrationDate": "",
      "expirationDate": ""
    }
  ]
}

Last updated 29 days ago