Definições e respostas

Definições

Definições utilizadas nas respostas de consultas de CPF e CNPJ retornados no objeto data da nossa API

Matriz PPE (Pessoa Politicamente Exposta)

Matriz pep[] contendo lista de possíveis cargos da PPE:

Parâmetro	Tipo	Descrição
abbreviation	string	Sigla da função do cargo político
role	string	Função do cargo político
level	string	Nível de hierarquia política
organ	string	Órgão de atuação política
startExercise	Date	Data de início do cargo no formato ISO 8601
endExercise	Date	Data de fim do cargo no formato ISO 8601
endShortage	Date	Data de fim da carência do cargo no formato ISO 8601

Matriz address (CPF)

Matriz address contendo informações sobre endereço.

Parâmetro	Tipo	Descrição
street	string	Endereço residencial.
number	string	Número no endereço.
complement	string	Complemento do endereço.
district	string	Bairro do endereço.
cep	string	CEP do endereço.
city	string	Cidade do endereço.
federativeUnit	string	Unidade da Federação do endereço com 2 letras

Matriz simpleNational

Matriz simpleNational contendo informações sobre possível optante pelo Simples Nacional:

Parâmetro	Tipo	Descrição
isParticipant	boolean	true ou false atualmente.
startDate	Date	Data de início como Simples Nacional no formato ISO 8601
endDate	Date	Data de fim como Simples Nacional no formato ISO 8601

Matriz taxRegimes

Matriz taxRegimes[], contendo uma lista de objetos de regimes tributários adotados pela organização:

Parâmetro	Tipo	Descrição
year	number	Ano de registro.
taxRegime	string	Lucro Presumido, Lucro Real ou Simples Nacional.
taxationMethod	string	Lucro Presumido, Lucro Real ou Simples Nacional.
updatedAt	Date	Data em que as informações foram obtidas na Receita Federal.

Matriz simei

Matriz simei contendo informações sobre possível optante pelo SIMEI:

Parâmetro	Tipo	Descrição
isParticipant	bolean	true ou false atualmente.
startDate	date	Data de início como SIMEI no formato ISO 8601
endDate	Date	Data de fim como SIMEI no formato ISO 8601

Matriz address (CNPJ)

Matriz address contendo informações sobre o endereço:

Parâmetro	Tipo	Descrição
cep	string	CEP do endereço com 9 dígitos.
type	string	Tipo de endereço, podendo ser: Aeroporto, Avenida, Caminho, Colonia, Esplanada, Estrada, Fazenda, Ladeira, Lago, Loteamento, Nao Informado, Passarela, Quadra, Recanto, Rua, Sitio, Vale, Vereda, Via
street	string	Endereço da empresa.
number	string	Número no endereço da empresa.
complement	string	Complemento do endereço.
district	string	Bairro do endereço.
federativeUnit	string	Unidade da Federação do endereço com 2 letras.
city	city	Cidade do endereço.
state	state	Objeto contento informações sobre o estado segundo o IBGE.
country	country	Objeto contendo informações sobre o pais segundo o IBGE.

city

Parâmetro	Tipo	Descrição
id	string	Identificador do município.
name	string	Nome do município.
ibgeId	string	ID da cidade segundo o IBGE
siafiId	string	ID da cidade no SIAFI

state

Parâmetro	Tipo	Descrição
id	string	Identificador do estado.
name	string	Nome do estado.
abbreviation	string	Sigla da Unidade da Federação.
ibgeId	int	ID do estado segundo o IBGE

country

Parâmetro	Tipo	Descrição
id	int	Identificador M49, designado pela Organização das Nações Unidas.
iso2	string	Identificador especificado pela norma ISO ALPHA-2, que define o identificador do país usando 2 letras.
iso3	string	Identificador especificado pela norma ISO ALPHA-3, que define o identificador do país usando 3 letras.
name	string	Nome do país.
comexId	string	🚧

Matriz branch

Matriz branch contendo informações sobre o órgão competente sendo ID e Tipo, respectivamente:

Parâmetro	Tipo	Descrição
id	int	ID do órgão
type	string	Órgão: id 1: Matriz id 2: Filial

Matriz phones

Matriz phones contendo no mínimo 1 telefone da empresa:

Parâmetro	Tipo	Descrição
ddd	string	Número de DDD do telefone
number	string	Número de telefone

Matriz fax

Matriz fax contendo possíveis números de fax da empresa:

Parâmetro	Tipo	Descrição
ddd	string	Número de DDD do fax
number	string	Número de fax

Matriz situation

Matriz situation contendo dados da situação cadastral da empresa na Receita Federal:

Parâmetro	Tipo	Descrição
id	int	ID da situação cadastral.
name	string	Nome da situação cadastral, sendo: id 1: Baixada id 2: Ativa id 3: Suspensa id 4: Inapta id 8: Baixada
date	string	Data da situação cadastral no formato ISO 8601.
reasonId	string	ID do motivo da situação.
reason	string	Descrição do motivo da situação.

Matriz legalNature

Matriz legalNature contendo dados da natureza jurídica.
Clique AQUI para acessar a lista oficial de códigos e descrições.

Parâmetro	Tipo	Descrição
code	string	Código da natureza jurídica com 4 dígitos sem hífen.
description	string	Descrição da natureza jurídica.

Matriz cnae

Matriz cnae contendo dados do CNAE principal da empresa.
Clique AQUI para acessar a tabela de códigos e descrições.

Parâmetro	Tipo	Descrição
primary	cnaeData	Objeto com informações da CNAE Primaria da empresa
secondaries[]	cnaeData[]	Lista de Objetos das CNAE's secundárias da empresa.

cnaeData

Parâmetro	Tipo	Descrição
id	string	Código completo do CNAE, somente números.
division	string	Código da divisão.
group	string	Código do grupo.
class	string	Código da classe.
subClasse	string	Código da sub classe.
description	string	Descrição do CNAE.

Matriz size

Matriz size contendo dados do porte da empresa.

Parâmetro	Tipo	Descrição
id	string	ID do porte.
description	string	Descrição do porte da empresa, sendo: id 0: Demais id 1: Matriz id 3: Demais id 5: Demais

Matriz partners

Matriz partners[] contendo dados do QSA da empresa.

Parâmetro	Tipo	Descrição
cpfCnpj	string	Número do CNPJ formatado caso seja um sócio PJ.
name	string	Nome do sócio PF ou PJ (sem acentuação).
type	string	Tipo de sócio.
capitalSocial 🚧	float	Porcentagem de capital social do sócio na empresa.
legalRepresentativeCpf	string	Caso o sócio seja uma empresa, este é o número de CPF do representante legal por ela.
legalRepresentativeName	string	Caso o sócio seja uma empresa, este é o nome do Representante legal por ela.
ageRange	string	Caso o sócio seja uma PF, esta é a faixa etária.
updatedAt	Date	Data em que as informações foram obtidas na Receita Federal.
legalRepresentativeQualification	qualification	Código de qualificação da pessoa física ou jurídica do representante legal na sociedade (Conforme a Tabela), de acordo com a natureza jurídica.
countryId	string	identificador do pais.
country	country	País de origem do sócio.
qualification	qualification	Objeto contendo código de qualificação da pessoa física ou jurídica na sociedade (Conforme a Tabela), de acordo com a natureza jurídica.

qualification

Objeto contendo código de qualificação da pessoa física ou jurídica na sociedade (Conforme a Tabela), de acordo com a natureza jurídica.

Parâmetro	Tipo	Descrição
id	int	Código de qualificação.
description	string	Descrição da qualificação.

Matriz risk

Matriz risk contendo informações do score na SERASA.

Parâmetro	Tipo	Descrição
level	int	ID do nível.
description	string	Descrição do nível de risco, sendo: nivel 0: Desconhecido nivel 1: Baixo nivel 2: Médio nivel 3: Alto nivel 4: Altíssimo
score	string	Faixa de pontuação do nível de score. CPF: Baixo: 701-1000 Médio: 501-700 Alto: 301-500 Altíssimo: 0-300 CNPJ: Baixo: 601-1000 Médio: 251-600 Alto: 101-250 Altíssimo: 0-100

Matriz stateSubscriptions

Matriz stateSubscriptions[] contendo lista de inscrições estaduais da empresa.

Parâmetro	Tipo	Descrição
subscriptionId	string	Número da inscrição estadual.
isActive	boolean	Indica se a inscrição está ativa ou não.
updatedAt	date	Data em que as informações foram obtidas na Receita Federal.
state	state	Dados do estado segundo oIBGE.

Matriz suframaSubscriptions

Matriz suframaSubscriptions[] Contento uma lista de objetos com um número de identificação e controle gerado por ocasião do cadastramento e vinculado a cada pessoa jurídica ou física, devendo ser utilizada exclusivamente para a viabilização dos serviços prestados pela SUFRAMA.

Parâmetro	Tipo	Descrição
isActive	boolean	Indica se a inscrição está ativa ou não no SUFRAMA.
subscription	string	número da inscrição no SUFRAMA.

Resposta de sucesso padrão (200 OK)

As requisições de sucesso para CPF e CNPJ retornam, além dos dados do pacote solicitado objeto data, os seguintes argumentos também são retornados no objeto metadata:

Parâmetro	Tipo	Descrição
packageUsed	int	ID do pacote usado.
balance	int	Saldo do pacote usado após consulta.
queryId	string	ID da consulta com 16 dígitos.
delay	float	Tempo levado para realizar a consulta em segundos.

Resposta erro padrão (400 Bad Request)

As requisições com erros para as rotas de CPF, CNPJ e Saldo retornam por padrão os seguintes argumentos:

Parâmetro	Tipo	Descrição
status	boolean	1 para sucesso na requisição e 0 para falha na requisição. Neste caso, 0 devido a erros enviados no corpo da requisição.
pacoteUsado	int	ID do pacote utilizado na consulta
erroCodigo	int	Código do erro.
erro	string	Mensagem de erro
nome	string	Nome completo do titular (sem acentuação). Apenas para solicitações na rota de CPF, neste caso, nome retornará null
razao	string	Nome da razão social da empresa. Apenas para solicitações na rota de CNPJ. Neste caso, razão retornará null .

Códigos de Erro

Confira abaixo todos os tipos de erros retornados no parâmetro erro e erroCodigo:

Erros CPF

erroCodigo	erro	Descrição
100	Invalid CPF!	Número digitado não é um CPF válido.
101	Enter an 11 digit CPF!	CPF informado possui menos de 11 dígitos.
102	The CPF entered does not exist in the Federal Revenue databases! Please check your CPF number and try again.	O CPF é válido, porém não pertence a nenhuma pessoa. Em alguns casos, o CPF é válido, existente na Receita Federal, mas ainda não propagou na API conforme prazo estipulado nos termos de uso.

Erros CNPJ

erroCodigo	erro	Descrição
200	Invalid CNPJ!	Número digitado não é um CNPJ válido.
201	Enter an 11 digit CNPJ!	CNPJ informado possui menos de 14 dígitos.
202	The CNPJ provided does not exist in the Federal Revenue databases! Please check your CNPJ number and try again.	O CNPJ é válido, porém não pertence a nenhuma empresa. Em alguns casos, o CNPJ é válido, existente na Receita Federal, mas ainda não propagou na API conforme prazo estipulado nos termos de uso.

Erros CPF / CNPJ

erroCodigo	erro	Descrição
1000	Invalid Token!	O token informado não pertence ao IP que está realizando a consulta.
1001	Not enough credits!	Você não possui créditos no pacote informado, para realizar consultas.
1002	Account suspended and/or inactive!	Entre em contato conosco para verificar o motivo.
1003	Blacklist until DATE	IP e Token suspenso temporariamente por descumprir uma das Regras de Uso.
1004	Package unavailable for consultation!	O ID do pacote informado é inválido ou não está disponível para consultas.
1005	It is not possible to consult CPF/CNPJ in this package!	Falha ao processar solicitação com o fornecedor ou erro interno. Verifique com o suporte.
1006	Supplier 2 offline. Contact us!	Fornecedor de dados off-line ou enfrentando instabilidades. Tente novamente ou entre em contato conosco.
1007	Limit of requests (20) per second exceeded. Please try again.	Limite máximo de 20 consultas por segundo.
1008	Token not found.	Token não informado ou não enviado corretamente no formato Bearer Token.
2000	packageId must be one of the following values: 1, 7, 2, 8, 9, 3, 13, 14 and 15 packageId must be one of the following values: 4, 5, 10, 6, 11 and 12 packageId must be one of the following values: 1, 10, 11, 12, 13, 14, 15, 2, 3, 4, 5, 6, 7, 8 and 9</li<>	Erro de validação O Id do pacote informado não esta de acordo com a lista de pacotes disponíveis de apara a rota de CPF. O Id do pacote informado não esta de acordo com a lista de pacotes disponíveis para a rota de CNPJ. O id do pacote informado não esta de acordo com a lista de pacotes disponíveis para a rota de Saldo.