> 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/caf-api-pt-br/core-api/transaction-details/background-check/kyb/register-data.md). # Registrar dados ## Dados Básicos (PJ1) Informações contidas no Cartão CNPJ da empresa junto à Receita Federal. **Seção:** `pjData` **Parâmetro obrigatório:** `cnpj` **Parâmetro opcional:** `qsa` {% hint style="info" %} O `qsa` parâmetro é necessário para a `qsa_consistent` regra, mas não é obrigatório para as outras regras. {% endhint %} {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.registrationNumber | String | Número de registro | | data.openingDate | String | Data de abertura | | data.officialName | String | Nome oficial | | data.fantasyName | String | Nome fantasia | | data.companySize | String | Porte da empresa | | data.mainActivity | String | Atividade principal da empresa | | data.secondaryActivities | Array | Lista de atividades secundárias | | data.secondaryActivities\[x].code | String | Código da atividade | | data.secondaryActivities\[x].description | String | Descrição da atividade | | data.legalNature | String | Natureza | | data.isMei | Boolean | Indica se o CNPJ é MEI | | data.address | Objeto | Endereço | | data.address.street | String | Rua | | data.address.number | String | Number | | data.address.complement | String | Complemento | | data.address.zipCode | String | CEP | | data.address.neighborhood | String | Bairro | | data.address.city | String | Cidade | | data.address.state | String | Estado | | data.companyEmail | String | E-mail | | data.phoneNumber | String | Telefone | | data.jointStock | String | Capital social | | data.status | String | Status da atividade da empresa | | data.statusOrigin | String | Origem da consulta de atividade da empresa | | data.statusDate | Date | Data da consulta da atividade da empresa | | data.QSA | Array | Lista de sócios | | data.QSA\[x].name | String | Nome | | data.QSA\[x].cpf | String | cpf | | data.QSA\[x].function | String | Atividade/função | | data.QSA\[x].functionCode | String | Código da atividade/função | | data.QSA\[x].isLegalRepresentative | Boolean | Indicação de representante legal | | data.QSA\[x].personType | String | Tipo de pessoa na empresa | | data.QSA\[x].cnpj | String | CNPJ da empresa | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "Mensagem", "registrationNumber": "XXXXX6450XXXXX", "fantasyName": "NOME FANTASIA", "status": "ATIVA", "statusDate": "2000-00-00T00:00:00.000Z", "openingDate": "00/00/2000", "mainActivity": "XXX00XX - Atividade principal", "mainActivityCode": "XXX00XX", "mainActivityDescription": "Descrição da atividade principal", "secondaryActivities": [ { "code": "XX015XX", "description": "Descrição das atividades secundárias" } ], "address": { "state": "UF", "city": "CIDADE", "zipCode": "XXX00XXX", "street": "RUA", "neighborhood": "BAIRRO", "number": "X7X", "complement": "COMPLEMENTO" }, "phoneNumber": "00(0X) XXX00XXX", "companyEmail": "company@mail.com", "jointStock": "R$ 0X.X00,00", "officialName": "NOME OFICIAL", "legalNature": "X00X - Natureza jurídica", "legalNatureCode": "X00X", "legalNatureDescription": "Natureza jurídica", "isMei": true, "companySize": "PORTE DA EMPRESA", "qsa": [ { "name": "JOHN DOE", "cpf": "**000000**", "function": "Função", "functionCode": "X0", "isLegalRepresentative": true } ] } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | authentic\_cnpj\_number | Verifica se o número do CNPJ é autêntico. | | active\_cnpj\_number | Verifica se o CNPJ está ativo na Receita Federal. | | is\_not\_me\_company | Verifica se o porte da empresa não é ME, de acordo com a Receita Federal. | | qsa\_pj\_data\_not\_empty | Verifica a estrutura societária divulgada pela Receita Federal. | | is\_company\_lifetime\_greater\_than\_six\_months | A regra será inválida se o tempo de existência da empresa for inferior a 6 meses. | | has\_at\_least\_one\_cnae | A regra será inválida se a empresa não tiver nenhum CNAE correspondente, conforme definido nas configurações extras da regra. | | minimum\_company\_lifetime | Verifica se o tempo de existência da empresa é maior que o mínimo exigido. | | has\_at\_least\_one\_legal\_nature | A regra será inválida se a empresa não tiver uma Natureza Jurídica correspondente, conforme definido nas configurações extras da regra. | | qsa\_consistent | A regra será inválida se as informações de QSA fornecidas nos atributos diferirem das informações de QSA fornecidas na consulta à Receita Federal. Para usar esta regra, a [API de Criação de Transação](https://docs.caf.io/api/core-api/available-resources/transaction) os atributos devem incluir o campo: `"qsa": [ {"name": "primeiro sócio", "cpf": "00000000000"}, {"name": "segundo sócio", "cpf": "11111111111"} ]` | | qsa\_with\_company\_partner | Verifica se a empresa possui uma pessoa jurídica em sua estrutura societária. | | {% endtab %} | | | {% endtabs %} | | ## Dados Públicos Básicos (PJ2) Informações detalhadas sobre o CNPJ (Cadastro Nacional da Pessoa Jurídica) consultadas nos dados públicos da Receita Federal. **Seção:** `pjPublicData` **Parâmetro obrigatório:** `cnpj` **Parâmetro opcional:** `qsa` {% hint style="info" %} O `qsa` parâmetro é necessário para a `qsa_consistent` regra, mas não é obrigatório para as outras regras. {% endhint %} {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.registrationNumber | String | Número de registro | | data.openingDate | String | Data de abertura | | data.officialName | String | Nome oficial | | data.fantasyName | String | Nome fantasia | | data.companySize | String | Porte da empresa | | data.mainActivity | String | Atividade principal da empresa | | data.secondaryActivities | Array | Lista de atividades secundárias | | data.secondaryActivities\[x].code | String | Código da atividade | | data.secondaryActivities\[x].description | String | Descrição da atividade | | data.legalNature | String | Natureza | | data.isMei | Boolean | Indica se o CNPJ é MEI | | data.address | Objeto | Endereço | | data.address.street | String | Rua | | data.address.number | String | Number | | data.address.complement | String | Complemento | | data.address.zipCode | String | CEP | | data.address.neighborhood | String | Bairro | | data.address.city | String | Cidade | | data.address.state | String | Estado | | data.companyEmail | String | E-mail | | data.phoneNumber | String | Telefone | | data.jointStock | String | Capital social | | data.status | String | Status da atividade da empresa | | data.statusOrigin | String | Origem da consulta de atividade da empresa | | data.statusDate | Date | Data da consulta da atividade da empresa | | data.QSA | Array | Lista de sócios | | data.QSA\[x].name | String | Nome | | data.QSA\[x].cpf | String | cpf | | data.QSA\[x].function | String | Atividade/função | | data.QSA\[x].functionCode | String | Código da atividade/função | | data.QSA\[x].isLegalRepresentative | Boolean | Indicação de representante legal | | data.QSA\[x].personType | String | Tipo de pessoa na empresa | | data.QSA\[x].cnpj | String | CNPJ da empresa | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "01", "data": { "message": "Mensagem", "registrationNumber": "XXXXX6450XXXXX", "fantasyName": "NOME FANTASIA", "status": "ATIVA", "statusDate": "2000-00-00T00:00:00.000Z", "openingDate": "00/00/2000", "mainActivity": "XXX00XX - Atividade principal", "mainActivityCode": "XXX00XX", "mainActivityDescription": "Descrição da atividade principal", "secondaryActivities": [ { "code": "XX015XX", "description": "Descrição das atividades secundárias" } ], "address": { "state": "UF", "city": "CIDADE", "zipCode": "XXX00XXX", "street": "RUA", "neighborhood": "BAIRRO", "number": "X7X", "complement": "COMPLEMENTO" }, "phoneNumber": "00(0X) XXX00XXX", "companyEmail": "company@mail.com", "jointStock": "R$ 0X.X00,00", "officialName": "NOME OFICIAL", "legalNature": "X00X - Natureza jurídica", "legalNatureCode": "X00X", "legalNatureDescription": "Natureza jurídica", "isMei": true, "companySize": "PORTE DA EMPRESA", "qsa": [ { "name": "JOHN DOE", "cpf": "**000000**", "function": "Função", "functionCode": "X0", "isLegalRepresentative": true } ] } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | authentic\_cnpj\_number | Verifica se o número do CNPJ é autêntico. | | active\_cnpj\_number | Verifica se o CNPJ está ativo na Receita Federal. | | is\_not\_me\_company | Verifica se o porte da empresa não é ME, de acordo com a Receita Federal. | | qsa\_pj\_data\_not\_empty | Verifica a estrutura societária divulgada pela Receita Federal. | | is\_company\_lifetime\_greater\_than\_six\_months | A regra será inválida se o tempo de existência da empresa for inferior a 6 meses. | | has\_at\_least\_one\_cnae | A regra será inválida se a empresa não tiver nenhum CNAE correspondente, conforme definido nas configurações extras da regra. | | minimum\_company\_lifetime | Verifica se o tempo de existência da empresa é maior que o mínimo exigido. | | has\_at\_least\_one\_legal\_nature | A regra será inválida se a empresa não tiver uma Natureza Jurídica correspondente, conforme definido nas configurações extras da regra. | | qsa\_consistent | A regra será inválida se as informações de QSA fornecidas nos atributos diferirem das informações de QSA fornecidas na consulta à Receita Federal. Para usar esta regra, a [API de Criação de Transação](https://docs.caf.io/api/core-api/available-resources/transaction) os atributos devem incluir o campo: `"qsa": [ {"name": "primeiro sócio", "cpf": "00000000000"}, {"name": "segundo sócio", "cpf": "11111111111"} ]` | | qsa\_with\_company\_partner | Verifica se a empresa possui uma pessoa jurídica em sua estrutura societária. | | {% endtab %} | | | {% endtabs %} | | ## Dados do Simples Nacional (PJ40) Consulta se a empresa está enquadrada no Simples.\ **Importante:** Os dados da empresa são atualizados mensalmente, mas o processo de atualização é gradual e pode levar alguns dias para ser concluído. Isso significa que os dados não serão atualizados de uma só vez, mas sim gradualmente ao longo do mês. **Seção:** `pjSimples` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ----------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.officialName | String | Nome oficial | | data.cnpj | String | CNPJ da empresa | | data.taxRegime | String | Regime tributário da empresa | | data.simples | Boolean | Pertence ao Simples (true/false) | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "X0", "data": { "officialName": "NOME OFICIAL", "cnpj": "XXXXX000XXXX", "taxRegime": "REGIME TRIBUTÁRIO", "simples": true } } ``` {% endtab %} {% endtabs %} ## Dados do Sintegra (PJ61) Consulta informações sobre uma pessoa jurídica no Cadastro Centralizado de Contribuintes por CNPJ e UF, retornando todas as inscrições estaduais encontradas. **Seção:** `pjSintegraData` **Parâmetros obrigatórios:** `cnpj, uf` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ------------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | código de status | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/core-api/transaction-details/background-check/data-structure.md#status-code)) | | dados | Objeto | Dados de retorno | | data.message | String | Descrição do status da consulta | | data.cnpj | String | CNPJ da empresa | | data.uf | String | Estado da empresa | | data.officialName | String | Nome oficial | | data.fantasyName | String | Nome fantasia | | data.stateRegistrationList | Array | Lista de inscrições estaduais por CNPJ | | data.stateRegistrationList\[x].cnpjStatus | String | Status do CNPJ | | data.stateRegistrationList\[x].stateRegistration | String | Inscrição Estadual (IE) | | data.stateRegistrationList\[x].stateRegistrationStatus | String | Status da Inscrição Estadual | | data.stateRegistrationList\[x].stateRegistrationStatusDate | String | Data do status na UF | | data.stateRegistrationList\[x].stateRegistrationType | String | Tipo de Inscrição Estadual | | data.stateRegistrationList\[x].stateRegistrationConsignee | String | Informações da IE como destinatário | | data.stateRegistrationList\[x].initialDateActivity | String | Data de início da atividade | | data.stateRegistrationList\[x].finalDateActivity | String | Data de encerramento da atividade | | data.stateRegistrationList\[x].taxRegime | String | Regime tributário | | data.stateRegistrationList\[x].companySize | String | Porte da empresa | | data.stateRegistrationList\[x].mainActivityCnae | String | CNAE principal | | data.stateRegistrationList\[x].historic | Array | Histórico | | data.stateRegistrationList\[x].historic\[x].nsuNumber | String | Número Sequencial Único (NSU) Movto. | | data.stateRegistrationList\[x].historic\[x].uf | String | UF | | data.stateRegistrationList\[x].historic\[x].cnpj | String | CNPJ da empresa | | data.stateRegistrationList\[x].historic\[x].cnpjStatus | String | Situação do CNPJ | | data.stateRegistrationList\[x].historic\[x].stateRegistration | String | Inscrição Estadual (IE) | | data.stateRegistrationList\[x].historic\[x].stateRegistrationStatus | String | Status da Inscrição Estadual | | data.stateRegistrationList\[x].historic\[x].taxRegime | String | Regime tributário | | data.stateRegistrationList\[x].historic\[x].situationDate | String | Data da situação | | data.stateRegistrationList\[x].historic\[x].updateDate | String | Data da atualização | | data.stateRegistrationList\[x].historic\[x].reason | String | Motivo da atualização | | data.stateRegistrationList\[x].address | Objeto | Endereço | | data.stateRegistrationList\[x].address.street | String | Rua | | data.stateRegistrationList\[x].address.number | String | Number | | data.stateRegistrationList\[x].address.complement | String | Complemento | | data.stateRegistrationList\[x].address.neighborhood | String | Bairro | | data.stateRegistrationList\[x].address.city | String | Cidade | | data.stateRegistrationList\[x].address.state | String | Estado | | data.stateRegistrationList\[x].address.zipCode | String | CEP | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "X0", "data": { "message": "Mensagem", "cnpj": "XXXXX00000XXXXX", "uf": "UF", "officialName": "NOME OFICIAL", "fantasyName": "NOME FANTASIA", "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": "RUA", "number": "0X", "complement": "COMPLEMENTO", "neighborhood": "BAIRRO", "city": "CIDADE", "state": "UF", "zipCode": "000XX-X00" } } ] } } ``` {% endtab %} {% tab title="Regras de validação" %} | Regra | Descrição | | ------------------------- | ------------------------------------------------------------------- | | has\_no\_sintegra\_record | A regra será inválida se o CNPJ não estiver cadastrado no 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/caf-api-pt-br/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.