> 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/api-core/transaction-details/background-check/kyb/register-data.md). # Registrar dados ## Dados Básicos (PJ1) Informações contidas no Cartão CNPJ da empresa na 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 demais regras. {% endhint %} {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/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 | Booleano | Indicativo se o CNPJ é MEI | | data.address | Objeto | Endereço | | data.address.street | String | Rua | | data.address.number | String | Número | | 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 da atividade da empresa | | data.statusDate | Data | 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 | Booleano | 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 | Verifique se o número do CNPJ é autêntico. | | active\_cnpj\_number | Verifique 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 | Verifique a composição societária publicada 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 adicionais 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 adicionais da regra. | | qsa\_consistent | A regra será inválida se as informações do QSA fornecidas nos atributos diferirem das informações do 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 | Verifique se a empresa tem uma pessoa jurídica em sua composição 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 demais regras. {% endhint %} {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | ---------------------------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/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 | Booleano | Indicativo se o CNPJ é MEI | | data.address | Objeto | Endereço | | data.address.street | String | Rua | | data.address.number | String | Número | | 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 da atividade da empresa | | data.statusDate | Data | 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 | Booleano | 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 | Verifique se o número do CNPJ é autêntico. | | active\_cnpj\_number | Verifique 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 | Verifique a composição societária publicada 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 adicionais 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 adicionais da regra. | | qsa\_consistent | A regra será inválida se as informações do QSA fornecidas nos atributos diferirem das informações do 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 | Verifique se a empresa tem uma pessoa jurídica em sua composição societária. | | {% endtab %} | | | {% endtabs %} | | ## Dados do Simples Nacional (PJ40) Consulte se a empresa está incluída 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 de forma gradual ao longo do mês. **Seção:** `pjSimples` **Parâmetro obrigatório:** `cnpj` {% tabs %} {% tab title="Esquema" %} | Atributo | Tipo | Descrição | | --------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/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.regimeTributário | String | Regime tributário da empresa | | data.simples | Booleano | 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 de 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 | | --------------------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------- | | statusCode | String | Status da consulta ([detalhes](/caf-api/caf-api-pt-br/api-core/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.listaDeInscriçõesEstaduais | Array | Lista de Inscrições Estaduais por CNPJ | | data.listaDeInscriçõesEstaduais\[x].statusDoCNPJ | String | Situação do CNPJ | | data.listaDeInscriçõesEstaduais\[x].inscriçãoEstadual | String | Inscrição Estadual (IE) | | data.listaDeInscriçõesEstaduais\[x].statusDaInscriçãoEstadual | String | Status da Inscrição Estadual | | data.listaDeInscriçõesEstaduais\[x].dataDoStatusDaInscriçãoEstadual | String | Data do status na UF | | data.listaDeInscriçõesEstaduais\[x].tipoDaInscriçãoEstadual | String | Tipo de Inscrição Estadual | | data.listaDeInscriçõesEstaduais\[x].destinatárioDaIE | String | Informação da IE como destinatário | | data.listaDeInscriçõesEstaduais\[x].dataInicialDaAtividade | String | Data de início da atividade | | data.listaDeInscriçõesEstaduais\[x].dataFinalDaAtividade | String | Data de término da atividade | | data.listaDeInscriçõesEstaduais\[x].regimeTributário | String | Regime tributário | | data.listaDeInscriçõesEstaduais\[x].porteDaEmpresa | String | Porte da empresa | | data.listaDeInscriçõesEstaduais\[x].cnaePrincipal | String | CNAE principal | | data.listaDeInscriçõesEstaduais\[x].histórico | Array | Histórico | | data.listaDeInscriçõesEstaduais\[x].histórico\[x].nsuNumber | String | Número Sequencial Único (NSU) Movto. | | data.listaDeInscriçõesEstaduais\[x].histórico\[x].uf | String | UF | | data.listaDeInscriçõesEstaduais\[x].histórico\[x].cnpj | String | CNPJ da empresa | | data.listaDeInscriçõesEstaduais\[x].histórico\[x].statusDoCNPJ | String | Situação do CNPJ | | data.listaDeInscriçõesEstaduais\[x].histórico\[x].inscriçãoEstadual | String | Inscrição Estadual (IE) | | data.listaDeInscriçõesEstaduais\[x].histórico\[x].statusDaInscriçãoEstadual | String | Status da Inscrição Estadual | | data.listaDeInscriçõesEstaduais\[x].histórico\[x].regimeTributário | String | Regime Tributário | | data.listaDeInscriçõesEstaduais\[x].histórico\[x].dataDaSituação | String | Data da situação | | data.listaDeInscriçõesEstaduais\[x].histórico\[x].dataDaAtualização | String | Data da atualização | | data.listaDeInscriçõesEstaduais\[x].histórico\[x].motivo | String | Motivo da atualização | | data.listaDeInscriçõesEstaduais\[x].endereço | Objeto | Endereço | | data.listaDeInscriçõesEstaduais\[x].endereço.rua | String | Rua | | data.listaDeInscriçõesEstaduais\[x].endereço.número | String | Número | | data.listaDeInscriçõesEstaduais\[x].endereço.complemento | String | Complemento | | data.listaDeInscriçõesEstaduais\[x].endereço.bairro | String | Bairro | | data.listaDeInscriçõesEstaduais\[x].endereço.cidade | String | Cidade | | data.listaDeInscriçõesEstaduais\[x].endereço.estado | String | Estado | | data.listaDeInscriçõesEstaduais\[x].endereço.cep | String | CEP | | {% endtab %} | | | {% tab title="Exemplo" %} ```json { "statusCode": "X0", "data": { "message": "Mensagem", "cnpj": "XXXXX00000XXXXX", "uf": "UF", "officialName": "NOME OFICIAL", "fantasyName": "NOME FANTASIA", "listaDeInscriçõesEstaduais": [ { "statusDoCNPJ": "", "inscriçãoEstadual": "", "statusDaInscriçãoEstadual": "", "dataDoStatusDaInscriçãoEstadual": "", "tipoDaInscriçãoEstadual": "", "destinatárioDaIE": "", "dataInicialDaAtividade": "", "dataFinalDaAtividade": "", "regimeTributário": "", "porteDaEmpresa": "", "cnaePrincipal": "", "histórico": [ { "nsuNumber": "00XX00", "uf": "UF", "cnpj": "XXXXX00000XXXX", "statusDoCNPJ": "", "inscriçãoEstadual": "", "statusDaInscriçãoEstadual": "", "regimeTributário": "", "dataDaSituação": "", "dataDaAtualização": "2000-00-00T00:00:00.000Z", "motivo": "" } ], "address": { "street": "RUA", "número": "0X", "complemento": "COMPLEMENTO", "neighborhood": "BAIRRO", "city": "CIDADE", "state": "UF", "cep": "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 by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.caf.io/caf-api/caf-api-pt-br/api-core/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 what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. 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.