CND Federal + PGFN (Consulta de Certidão Conjunta)

O que é#

Esta consulta recupera uma certidão conjunta já emitida (Certidão de Débitos Relativos a Créditos Tributários Federais e à Dívida Ativa da União — RFB/PGFN) para o CPF/CNPJ pesquisado. Diferente da consulta de emissão, aqui não se emite uma nova certidão — apenas se localiza uma certidão previamente emitida. É retornada somente a certidão mais recente encontrada no período pesquisado, mesmo quando a fonte lista várias.

Sobre a requisição#

Método: POST

Endereço: URL Base + /api/maestro/cnd-federal-pgfn/consulta-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. Aceita valor formatado ou apenas dígitos. (Alternativamente, os campos `cpf` e `cnpj` podem ser enviados separadamente.)
dataNascimento	string	Sim, caso `cpfCnpj` seja um CPF.	Data de nascimento da pessoa a ser consultada, no formato `DD/MM/YYYY`.
tipoPesquisa	string	Sim.	Critério de pesquisa. Valores aceitos: `DATA_EMISSAO` (pesquisa por data de emissão) ou `DATA_VALIDADE` (pesquisa por data de validade).
periodoInicio	string	Não.	Início do período de pesquisa, no formato `DD/MM/YYYY`. Quando omitido, o padrão é a data de hoje menos 1 ano.
periodoFim	string	Não.	Fim do período de pesquisa, no formato `DD/MM/YYYY`. Quando omitido, o padrão é a data de hoje.

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
negativa	NÃO foram encontrados débitos para o documento pesquisado
positiva_negativa	Certidão positiva com efeitos de negativa
positiva	Certidão positiva (há débitos)

Valores possíveis do campo "situacao"

Situação	Significado
Válida	A certidão retornada ainda está dentro do prazo de validade
Expirada	A certidão retornada já passou do prazo de validade

Respostas com registro encontrado

JSON

{
    "nome": "NOME DA EMPRESA DE EXEMPLO LTDA",
    "cnpj": "99.999.999/9999-99",
    "cpf": null,
    "dataHoraEmissao": "01/01/2020 09:26:09",
    "validade": "01/07/2020",
    "codigoControle": "1A1A.2B2B.3C3C.4D4D",
    "status": "negativa",
    "situacao": "Válida",
    "pdf": "base64"
}

JSON

{
    "nome": "NOME DA EMPRESA DE EXEMPLO LTDA",
    "cnpj": "99.999.999/9999-99",
    "cpf": null,
    "dataHoraEmissao": "01/01/2020 09:26:09",
    "validade": "01/07/2020",
    "codigoControle": "1A1A.2B2B.3C3C.4D4D",
    "status": "positiva_negativa",
    "situacao": "Válida",
    "pdf": "base64"
}

JSON

{
    "nome": "FULANO DE TAL",
    "cnpj": null,
    "cpf": "999.999.999-99",
    "dataHoraEmissao": "01/01/2020 09:26:09",
    "validade": "01/07/2020",
    "codigoControle": "1A1A.2B2B.3C3C.4D4D",
    "status": "positiva",
    "situacao": "Expirada",
    "pdf": "base64"
}

Respostas sem certidão disponível

Quando não existe certidão emitida para os dados consultados, ou quando a data de nascimento informada não confere com o cadastro (apenas CPF), a resposta traz o campo status igual a erro e uma mensagem, sem pdf.

JSON

{
    "status": "erro",
    "mensagem": "Não existe certidão emitida para os dados consultados"
}

JSON

{
    "status": "erro",
    "mensagem": "Data de nascimento diferente do cadastrado"
}