O que é#
A Certidão Negativa de Débito do Ibama é o documento responsável por comprovar que a você ou sua empresa está em conformidade com as obrigações referentes a controle e fiscalização do Ibama.
Fonte de Dados: https://servicos.ibama.gov.br/sicafiext/
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/ibama/certidao-negativa-debito
Parâmetros do header#
| Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
| Authorization | String | Sim | Chave de API gerada no cadastro no Plexi, prefixada com Bearer |
| Callback | String | Não | URL para onde o resultado da requisição será enviado via HTTP POST. |
Parâmetros do body#
| Nome | Tipo | Obrigatório? | Descrição |
|---|---|---|---|
| cpfCnpj | string | Sim | CPF ou CNPJ a ser pesquisado, com ou sem máscara. Exemplos: 99999999999 ou 999.999.999-99 |
| nome* | string | Sim | Nome da Pessoa Pesquisada |
| endereco* | string | Sim | Endereço da Pessoa Pesquisada |
| bairro* | string | Sim | Bairro da Pessoa Pesquisada |
| uf* | string | Sim | Nome do Estado/UF da pessoa pesquisada |
| municipio* | string | Sim | Nome do Município da Pessoa Pesquisada |
Sobre dados de endereço#
Os campos marcados com * são obrigatórios e utilizados pelo IBAMA para emitir certidão negativa de pessoas não cadastradas e seus valores são registrados pelo Ibama junto a certidão. Você pode verificar se o documento (cpfCnpj) utilizado é cadastrado através do campo cadastrado na resposta da sua requisição (consulte exemplos de resposta no rodapé da documentação).
Os campos de uf e municipio são texto livre para facilitar a digitação, porém, caso seja impossível encontrar o valor correspondente por similaridade ou indisponibilidade da localidade na base do Ibama será apresentada uma mensagem de suporte (consulte as estruturas de resposta logo abaixo).
Estrutura da resposta#
| Status | Significado | Descrição | Informações retornadas |
|---|---|---|---|
| 201 | Created | Solicitação criada | Campo requestId, com o ID da requisição criada. |
| 422 | Unprocessable Entity | A solicitação contém erro | Em quais campos houve erro. |
Exemplos de retornos quando você faz a requisição#
Status 201
A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.
{
"requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}Status 422
Significa que ocorreu um erro de validação dos dados enviados.
Exemplo de requisição:
{
"cpfCnpj": "99999999999",
"nome": "FULANO DE TAL",
"endereco": "Rua Exemplo",
"bairro": "Bairro Exemplo",
"uf": "SaoPaulo",
"municipio": "Adam"
}Recebe a instrução de erro:
{
"message": "The given data was invalid.",
"errors": {
"cpfCnpj": ["O valor do campo cpfCnpj é invalido"],
"municipio": ["Município inválido: Adam. Você quis dizer: Adamantina, Aramina"]
}
}Exemplos de retornos do resultado da pesquisa#
Valores possíveis do campo "status"
| Status | Significado |
|---|---|
| negativo | NÃO foram encontrados débitos no documento pesquisado |
| positivo | Foram encontrados débitos relacionados ao documento pesquisado |
Respostas com registro encontrado
{
"status": "positivo",
"cadastrado": "SIM",
"numeroCertidao": null,
"dataEmissao": null,
"dataValidade": null,
"nome": "EMPRESA EXEMPLO LTDA",
"cpfCnpj": "99.999.999/9999-99",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}{
"status": "negativo",
"cadastrado": "NÃO",
"numeroCertidao": 999999,
"dataEmissao": "01/01/2020",
"dataValidade": "01/01/2021",
"nome": null,
"cpfCnpj": "99.999.999/9999-99",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}{
"status": "negativo",
"cadastrado": "SIM",
"numeroCertidao": "99999999",
"dataEmissao": "01/01/2020",
"dataValidade": "01/01/2021",
"nome": "EMPRESA EXEMPLO LTDA",
"cpfCnpj": "99.999.999/9999-99",
"pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}
