Register data

Basic Data (PJ1)

Information contained in the company's CNPJ Card with the IRS.

Section: pjData

Required parameter: cnpj

Optional parameter: qsa

The qsa parameter is necessary for the qsa_consistent rule but is not required for the other rules.

Schema

Atributo	Tipo	Descrição
statusCode	String	Query status (details)
data	Object	Return data
data.registrationNumber	String	Record number
data.openingDate	String	Opening date
data.officialName	String	Official name
data.fantasyName	String	Trading name
data.companySize	String	Company size
data.mainActivity	String	Main business activity
data.secondaryActivities	Array	List of secondary activities
data.secondaryActivities[x].code	String	Activity code
data.secondaryActivities[x].description	String	Activity description
data.legalNature	String	Nature
data.isMei	Boolean	Indicative if the CNPJ is MEI
data.address	Object	Address
data.address.street	String	Street
data.address.number	String	Number
data.address.complement	String	Complement
data.address.zipCode	String	ZIP CODE
data.address.neighborhood	String	Neighborhood
data.address.city	String	City
data.address.state	String	State
data.companyEmail	String	E-mail
data.phoneNumber	String	Telephone
data.jointStock	String	Capital stock
data.status	String	Company Activity Status
data.statusOrigin	String	Origin of Company Activity Inquiry
data.statusDate	Date	Date of company activity inquiry
data.QSA	Array	List of partners
data.QSA[x].name	String	Name
data.QSA[x].cpf	String	cpf
data.QSA[x].function	String	Activity/function
data.QSA[x].functionCode	String	Activity/function code
data.QSA[x].isLegalRepresentative	Boolean	Legal representative indication
data.QSA[x].personType	String	Type of person in the company
data.QSA[x].cnpj	String	CNPJ of the company

Example

{
  "statusCode": "01",
  "data": {
    "message": "Message",
    "registrationNumber": "XXXXX6450XXXXX",
    "fantasyName": "TRADING NAME",
    "status": "ATIVA",
    "statusDate": "2000-00-00T00:00:00.000Z",
    "openingDate": "00/00/2000",
    "mainActivity": "XXX00XX - Main Activity",
    "mainActivityCode": "XXX00XX",
    "mainActivityDescription": "Main Activity Description",
    "secondaryActivities": [
      {
        "code": "XX015XX",
        "description": "Secondary Activities Description"
      }
    ],
    "address": {
      "state": "UF",
      "city": "CITY",
      "zipCode": "XXX00XXX",
      "street": "STREET",
      "neighborhood": "NEIGHBORHOOD",
      "number": "X7X",
      "complement": "COMPLEMENT"
    },
    "phoneNumber": "00(0X) XXX00XXX",
    "jointStock": "R$ 0X.X00,00",
    "officialName": "OFFICIAL NAME",
    "legalNature": "X00X - Legal Nature",
    "legalNatureCode": "X00X",
    "legalNatureDescription": "Legal Nature",
    "isMei": true,
    "companySize": "COMPANY SIZE",
    "qsa": [
      {
        "name": "JOHN DOE",
        "cpf": "**000000**",
        "function": "Function",
        "functionCode": "X0",
        "isLegalRepresentative": true
      }
    ]
  }
}

Validations Rules

Rule	Description
authentic_cnpj_number	Check that the CNPJ number is authentic.
active_cnpj_number	Check that the CNPJ is active with the Receita Federal.
is_not_me_company	Checks that the size of the company is not ME according to the Receita Federal.
qsa_pj_data_not_empty	Check the corporate structure published by Receita Federal.
is_company_lifetime_greater_than_six_months	The rule will be invalid if the company's lifespan is less than 6 months.
has_at_least_one_cnae	The rule will be invalid if the company does not have any corresponding CNAEs as defined in the extra rule settings.
minimum_company_lifetime	Checks that the company's lifespan is longer than the minimum required.
has_at_least_one_legal_nature	The rule will be invalid if the company does not have a corresponding Legal Nature as defined in the extra rule settings.
qsa_consistent	The rule will be invalid if the QSA information provided in attributes differs from the QSA information provided in the Federal Revenue Service consultation. To use this rule, the Create Transaction API attributes must include the field: "qsa": [ {"name": "first partner", "cpf": "00000000000"}, {"name": "second partner", "cpf": "11111111111"} ]
qsa_with_company_partner	Check if the company has a Legal Person in its corporate structure.

Simples Nacional Data (PJ40)

Query whether the company is included in Simples. Important: Company data is updated monthly, but the update process is gradual and may take a few days to complete. This means that the data will not be updated all at once, but rather gradually throughout the month.

Section: pjSimples

Required parameter: cnpj

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
data	Object	Return data
data.officialName	String	Official name
data.cnpj	String	CNPJ of the company
data.taxRegime	String	Company's tax regime
data.simples	Boolean	Belongs to the simple (true/false)

Example

{
  "statusCode": "X0",
  "data": {
    "officialName": "OFFICIAL NAME",
    "cnpj": "XXXXX000XXXX",
    "taxRegime": "TAX REGIME",
    "simples": true
  }
}

Sintegra Data (PJ61)

Consults information about a legal entity in the Centralized Taxpayer Register by CNPJ and UF, returning all the state inscriptions found.

Section: pjSintegraData

Required parameters: cnpj, uf

Schema

Attribute	Type	Description
statusCode	String	Query status (details)
data	Object	Return data
data.message	String	Description with query status
data.cnpj	String	CNPJ of the company
data.uf	String	State of the company
data.officialName	String	Official name
data.fantasyName	String	Trading name
data.stateRegistrationList	Array	List of State Registrations by CNPJ
data.stateRegistrationList[x].cnpjStatus	String	CNPJ status
data.stateRegistrationList[x].stateRegistration	String	State Registration (IE)
data.stateRegistrationList[x].stateRegistrationStatus	String	State Registration status
data.stateRegistrationList[x].stateRegistrationStatusDate	String	Status date in UF
data.stateRegistrationList[x].stateRegistrationType	String	Type of State Registration
data.stateRegistrationList[x].stateRegistrationConsignee	String	IE information as a Receiver
data.stateRegistrationList[x].initialDateActivity	String	Date of the beginning of activity
data.stateRegistrationList[x].finalDateActivity	String	Activity end date
data.stateRegistrationList[x].taxRegime	String	Tax system
data.stateRegistrationList[x].companySize	String	Company Size
data.stateRegistrationList[x].mainActivityCnae	String	Main CNAE
data.stateRegistrationList[x].historic	Array	History
data.stateRegistrationList[x].historic[x].nsuNumber	String	Unique Sequential Number (NSU) Movto.
data.stateRegistrationList[x].historic[x].uf	String	UF
data.stateRegistrationList[x].historic[x].cnpj	String	CNPJ of the company
data.stateRegistrationList[x].historic[x].cnpjStatus	String	CNPJ Situation
data.stateRegistrationList[x].historic[x].stateRegistration	String	State Registration (IE)
data.stateRegistrationList[x].historic[x].stateRegistrationStatus	String	State Registration status
data.stateRegistrationList[x].historic[x].taxRegime	String	Tax Regime
data.stateRegistrationList[x].historic[x].situationDate	String	Situation date
data.stateRegistrationList[x].historic[x].updateDate	String	Date of update
data.stateRegistrationList[x].historic[x].reason	String	Reason for update
data.stateRegistrationList[x].address	Object	Address
data.stateRegistrationList[x].address.street	String	Street
data.stateRegistrationList[x].address.number	String	Number
data.stateRegistrationList[x].address.complement	String	Complemento
data.stateRegistrationList[x].address.neighborhood	String	Neighborhood
data.stateRegistrationList[x].address.city	String	City
data.stateRegistrationList[x].address.state	String	State
data.stateRegistrationList[x].address.zipCode	String	ZIP CODE

Example

{
  "statusCode": "X0",
  "data": {
    "message": "Message",
    "cnpj": "XXXXX00000XXXXX",
    "uf": "UF",
    "officialName": "OFFICIAL NAME",
    "fantasyName": "TRADING NAME",
    "stateRegistrationList": [
      {
        "cnpjStatus": "",
        "stateRegistration": "",
        "stateRegistrationStatus": "",
        "stateRegistrationStatusDate": "",
        "stateRegistrationType": "",
        "stateRegistrationConsignee": "",
        "initialDateActivity": "",
        "finalDateActivity": "",
        "taxRegime": "",
        "companySize": "",
        "mainActivityCnae": "",
        "historic": [
          {
            "nsuNumber": "00XX00",
            "uf": "UF",
            "cnpj": "XXXXX00000XXXX",
            "cnpjStatus": "",
            "stateRegistration": "",
            "stateRegistrationStatus": "",
            "taxRegime": "",
            "situationDate": "",
            "updateDate": "2000-00-00T00:00:00.000Z",
            "reason": ""
          }
        ],
        "address": {
          "street": "STREET",
          "number": "0X",
          "complement": "COMPLEMENT",
          "neighborhood": "NEIGHBORHOOD",
          "city": "CITY",
          "state": "UF",
          "zipCode": "000XX-X00"
        }
      }
    ]
  }
}

Validations Rules

Rule	Description
has_no_sintegra_record	The rule will be invalid if the CNPJ is not registered in Sintegra.