O que é#

A Certidão de Débitos Relativos a Créditos Tributários Federais e à Dívida Ativa da União tem como finalidade confirmar se uma pessoa jurídica possui pendências financeiras.

Sobre a requisição#

  • Método: POST
  • Endereço: https://api.plexi.com.br/api/maestro/cnd-federal-pgfn/certidao-conjunta
  • URL Base: https://api.plexi.com.br/

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.
dataNascimento string Sim, caso cpfCnpj seja um CPF. Data de nascimento da pessoa a ser consultada, no formato DD/MM/YYYY

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.

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

Status 422

Significa que ocorreu um erro de validação dos dados enviados.

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

Exemplos de retornos do resultado da pesquisa#

Valores possíveis do campo "status"

Status Significado
negativo NÃO foram encontrados débitos para o documento pesquisado
positiva_negativa Certidão positiva com efeitos de negativa
indefinido A partir do resultado encontrado na fonte, não foi possível determinar o status.

Respostas com registro encontrado

JSON
{
    "nome": "NOME DA EMPRESA DE EXEMPLO LTDA",
    "cnpj": "99.999.999/9999-99",
    "cpf": null,
    "dataHoraEmissao": "01/01/2020 12:00:00",
    "validade": "01/07/2020",
    "codigoControle": "1A1A.2B2B.3C3C.4D4D",
    "status": "negativo",
    "pdf": "base64"
}
JSON
{
    "nome": "NOME DA EMPRESA DE EXEMPLO LTDA",
    "cnpj": "99.999.999/9999-99",
    "cpf": null,
    "dataHoraEmissao": "01/01/2020 12:00:00",
    "validade": "01/07/2020",
    "codigoControle": "1A1A.2B2B.3C3C.4D4D",
    "status": "positiva_negativa",
    "pdf": "base64"
}
JSON
{
    "status": "indefinido",
    "mensagem": "As informações disponíveis na Secretaria da Receita Federal do Brasil - RFB sobre o contribuinte 99.999.999/9999-99 são insuficientes para a emissão de certidão por meio da Internet.",
    "pdf": "base64"
}
JSON
{
    "status": "indefinido",
    "mensagem": "CNPJ: 99.999.999/9999-99 com situação cadastral declarada inapta pela Secretaria Especial da Receita Federal do Brasil - RFB em 01/01/2024.",
    "pdf": "base64"
}