View Source

O que é

Na consulta Receita Federal - Certidão de Débitos Relativos a Créditos Tributários Federais e à Dívida Ativa da União - você pode atestar se uma pessoa ou empresa possui dívidas relacionadas a tributos federais e à dívida ativa da união.

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/receita/certidao-negativa

URL Base:

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

Retornos possíveis da requisição

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

Status 201

{
  "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}

Status 422

{
  "message": "The given data was invalid.",
  "errors": {
    "cpf": [
      "O campo cpf é obrigatório."
    ],
    "nome": [
      "O campo name é obrigatório."
    ]
  }
}

Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )

Valores possíveis do campo “status“

Status	Significado
negativa	NÃO foram encontrados débitos para o documento pesquisado
positiva	Foram encontrados débitos relacionados ao documento pesquisado
indefinido	As informações são insuficientes para gerar a certidão.
positiva_negativa	Certidão positiva com efeitos de negativa
atencao	O documento possui alguma anormalidade, para mais detalhes você deve observar o campo `situacao` e `mensagem`.

Valores possíveis do campo “situacao“

Situação	Significado
suspenso	Inscrição suspensa pela Secretaria da Receita Federal do Brasil
inexistente	O número informado não consta do cadastro.
baixado	Baixado pela Secretaria da Receita Federal do Brasil - RFB
anulado	Anulado pela Secretaria da Receita Federal do Brasil - RFB
nula	Inscrição nula desde…
irregular	Inscrição pendente de regularização
inapta	Inscrição declarada inapta

Resposta com registro encontrado

{
  "status": "positiva",
  "mensagem": "As informações disponíveis na Secretaria da Receita Federal do Brasil - RFB sobre o contribuinte são insuficientes para a emissão de certidão por meio da Internet.",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

{
  "status": "negativa",
  "nome": "NOME DA EMPRESA",
  "codigo": "6DA4.AF2D.8589.8312",
  "dataEmissao": "06/08/2020 18:09:57",
  "dataValidade": "02/02/2021",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}

Resposta com erro

{
  "status": "atencao",
  "situacao": "inexistente",
  "mensagem": "O número informado não consta do cadastro CNPJ",
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."
}