> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-api/core-api/transaction-details/background-check/kyb/register-data.md). # Register data ## Basic Data (PJ1) Information contained in the company's CNPJ Card with the IRS. **Section:** `pjData` **Required parameter:** `cnpj` **Optional parameter:** `qsa` {% hint style="info" %} The `qsa` parameter is necessary for the `qsa_consistent` rule but is not required for the other rules. {% endhint %} {% tabs %} {% tab title="Schema" %} | Atributo | Tipo | Descrição | | ---------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------- | | statusCode | String | Query status ([details](/caf-api/core-api/transaction-details/background-check/data-structure.md#status-code)) | | 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 | | {% endtab %} | | | {% tab title="Example" %} ```json { "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", "companyEmail": "company@mail.com", "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 } ] } } ``` {% endtab %} {% tab title="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](https://docs.caf.io/api/core-api/available-resources/transaction) 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. | | {% endtab %} | | | {% endtabs %} | | ## Basic Public Data (PJ2) Detailed information about the CNPJ (Corporate Taxpayer ID) consulted from the public data of the Federal Revenue Service. **Section:** `pjPublicData` **Required parameter:** `cnpj` **Optional parameter:** `qsa` {% hint style="info" %} The `qsa` parameter is necessary for the `qsa_consistent` rule but is not required for the other rules. {% endhint %} {% tabs %} {% tab title="Schema" %} | Atributo | Tipo | Descrição | | ---------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------- | | statusCode | String | Query status ([details](/caf-api/core-api/transaction-details/background-check/data-structure.md#status-code)) | | 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 | | {% endtab %} | | | {% tab title="Example" %} ```json { "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", "companyEmail": "company@mail.com", "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 } ] } } ``` {% endtab %} {% tab title="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](https://docs.caf.io/api/core-api/available-resources/transaction) 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. | | {% endtab %} | | | {% endtabs %} | | ## 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` {% tabs %} {% tab title="Schema" %} | Attribute | Type | Description | | ----------------- | ------- | -------------------------------------------------------------------------------------------------------------- | | statusCode | String | Query status ([details](/caf-api/core-api/transaction-details/background-check/data-structure.md#status-code)) | | 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) | | {% endtab %} | | | {% tab title="Example" %} ```json { "statusCode": "X0", "data": { "officialName": "OFFICIAL NAME", "cnpj": "XXXXX000XXXX", "taxRegime": "TAX REGIME", "simples": true } } ``` {% endtab %} {% endtabs %} ## 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` {% tabs %} {% tab title="Schema" %} | Attribute | Type | Description | | ------------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------- | | statusCode | String | Query status ([details](/caf-api/core-api/transaction-details/background-check/data-structure.md#status-code)) | | 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 | | {% endtab %} | | | {% tab title="Example" %} ```json { "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" } } ] } } ``` {% endtab %} {% tab title="Validations Rules" %} | Rule | Description | | ------------------------- | ------------------------------------------------------------------- | | has\_no\_sintegra\_record | The rule will be invalid if the CNPJ is not registered in Sintegra. | | {% endtab %} | | | {% endtabs %} | | --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.caf.io/caf-api/core-api/transaction-details/background-check/kyb/register-data.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.