Documentação da API
Informações gerais da API
https://inidon.com.br/api/v2/cnpj/{cnpj}
Endpoint utilizado para obter todas informações das fontes utilizadas sobre o CNPJ informado.
Parâmetros
Dado | Nome do campo | Tipo de dado | Tamanho | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
CNPJ | cnpj * | int | 14 |
Headers
Nome | Parametros | Valor | Tipo de dado | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
Authorization | Email e Senha | Basic base64(email:senha) | String |
[
{
"cnpj": String,
"data_ocorrencia": String,
"razao_social": String,
"motivo_ocorrencia": String,
"situacao_cadastral": String,
"id_matriz": String,
"data_inicio_atividade": String,
"codigo_natureza": String,
"logradouro": String,
"numero": String,
"cnae": String,
"complemento": String,
"bairro": String,
"cep": String,
"uf": String,
"municipio": String,
"telefone": String,
"email": String,
"capital_social": String,
"porte": String,
"fonte": String
},
{
...
}
]
Retorno - Situação na Receita Federal do Brasil
Dado | Nome do campo | Tipo de dado | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
CNPJ | cnpj | String | |||||||||
Data da Ocorrência | data_ocorrencia | String | |||||||||
Razão Social | razao_social | String | |||||||||
Motivo da Ocorrência | motivo_ocorrencia | String | |||||||||
Situação Cadastral | situacao_cadastral | String | |||||||||
Matriz / Filial | id_matriz | String | |||||||||
Data de Início das Atividades | data_inicio_atividade | String | |||||||||
Código de Natureza | codigo_natureza | String | |||||||||
Logradouro | logradouro | String | |||||||||
Número | numero | String | |||||||||
CNAE | cnae | String | |||||||||
Complemento | complemento | String | |||||||||
Bairro | bairro | String | |||||||||
CEP | cep | String | |||||||||
Estado | uf | String | |||||||||
Município | municipio | String | |||||||||
Telefone | telefone | String | |||||||||
String | |||||||||||
Capital Social | capital_social | String | |||||||||
Porte | porte | String | |||||||||
Fonte da Consulta | fonte | String |
Resposta:
[
{
"ie": String,
"data_ocorrencia": String,
"data_inatividade":String,
"motivo_situacao": String,
"situacao":String,
"estado": String,
"cnpj": String,
"fonte":String
},
{
...
}
]
Retorno - Situação no Sintegra
Dado | Nome do campo | Tipo de dado | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Inscrição Estadual | ie | String | |||||||||
Data de Ocorrência | data_ocorrencia | String | |||||||||
Data de Inatividade | data_inatividade | String | |||||||||
Motivo da Situação | motivo_situacao | String | |||||||||
Situação Cadastral | situacao | String | |||||||||
Estado | estado | String | |||||||||
CNPJ | cnpj | String | |||||||||
Fonte da Consulta | fonte | String |
Resposta:
[
{
"OCORRENCIA": String,
"STATUS": String,
"CNPJ": Integer,
"IE": Integer,
"DATA_DA_OCORRENCIA": String,
"DATA_DE_INATIVIDADE": String,
"ESTADO": String,
"fonte": String
},
{
...
}
]
Retorno - Diário Oficial do Estado
Dado | Nome do campo | Tipo de dado | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Ocorrênca | OCORRENCIA | String | |||||||||
Status | STATUS | String | |||||||||
CNPJ | CNPJ | Integer | |||||||||
Inscrição Estadual | IE | Integer | |||||||||
Data da Ocorrência | DATA_DA_OCORRENCIA | String | |||||||||
Data de Inatividade | DATA_DE_INATIVIDADE | String | |||||||||
Estado | ESTADO | String | |||||||||
Fonte | fonte | String |
Comprovantes de consulta
Serão retornados os comprovantes dos dados retornados, identificados da seguinte forma:
- Tipo de Informação
{
"receita_": "https://inid....",
"sintegra_": "https://inid...."
}
Caso uma das informações não apresente resultado, será exibida a mensagem: Não consta nenhum resultado para o critério informado.
Retorno - Análise Inidon
Campo Análise: irá retornar uma classificação baseada nos dados apresentados na consulta, além de um resumo da situação. Como segue exemplo abaixo:
{
"classificacao": String,
"legenda": String,
}
Os seguintes resultados são os que poderão ocorrer em suas consultas:
- Sem Risco
- Risco Baixo
- Risco Moderado
- Risco Alto
- Risco Extremo
Retorno - Avisos
Campo Avisos: irá retornar um array de strings contendo avisos referentes à instabilidades na Receita Federal do Brasil e/ou Sintegra. Como segue exemplo abaixo:
[
"A consulta ...",
"A consulta ..."
]