For the complete documentation index, see llms.txt. This page is also available as Markdown.

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

O qsa parâmetro é necessário para a qsa_consistent regra, mas não é obrigatório para as outras regras.

Atributo
Tipo
Descrição

código de status

String

Status da consulta (detalhes)

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

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 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.

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

O qsa parâmetro é necessário para a qsa_consistent regra, mas não é obrigatório para as outras regras.

Atributo
Tipo
Descrição

código de status

String

Status da consulta (detalhes)

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

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 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.

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

Atributo
Tipo
Descrição

código de status

String

Status da consulta (detalhes)

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)

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

Atributo
Tipo
Descrição

código de status

String

Status da consulta (detalhes)

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

Regra
Descrição

has_no_sintegra_record

A regra será inválida se o CNPJ não estiver cadastrado no Sintegra.

Atualizado