PGFN - Lista de Devedores

O que é#

Na consulta PGFN - Lista de Devedores - você verifica se uma pessoa ou empresa possui dívidas inscritas na dívida ativa da União e do FGTS, na condição de devedor principal.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/pgfn/lista-devedores

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

JSON

{
  "requestId": "00000000-0000-0000-0000-000000000000"
}

Status 422

JSON

{
  "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

Resposta com registro encontrado

CPF encontrado

JSON

{
  "id": "***999999**",
  "encodedId": "XXXXXXXXXXXXXXXX%3D%3D",
  "nome": "NOME DA PESSOA OU EMPRESA",
  "codmunicipio": 7777,
  "nomeMunicipio": "CIDADE EXEMPLO",
  "uf": "SP",
  "totaldivida": 9999.99,
  "totaltributario": 9999.99,
  "naturezas": [
    {
      "total": 9999.99,
      "debitos": [
        {
          "valor": 9999.99,
          "numero": "99999999999"
        }
      ],
      "natureza": 1
    }
  ],
  "status": "positiva"
}

JSON

{
  "status": "negativa"
}

CNPJ encontrado

JSON

{
  "id": "999999999999999",
  "encodedId": "XXXXXXXXXXXXXXXX%3D%3D",
  "nome": "NOME DA EMPRESA",
  "codmunicipio": 7777,
  "nomeMunicipio": "CIDADE EXEMPLO",
  "uf": "SP",
  "cnae": "0000 0000 0000 0000 0000",
  "descricaoCnae": "DESCRICAO CNAE",
  "totaldivida": 9999.99,
  "totaltributario": 9999.99,
  "totalprevidenciario": 9999.99,
  "totalmultatrabalhista": 9999.99,
  "totalnaotributario": 9999.99,
  "totalfgts": 9999.99,
  "naturezas": [
    {
      "total": 9999.99,
      "debitos": [
        {
          "valor": 9999.99,
          "numero": "99999999999"
        },
        {
          "valor": 9999.99,
          "numero": "99999999999"
        }
      ],
      "natureza": 1
    },
    {
      "total": 9999.99,
      "debitos": [
        {
          "valor": 9999.99,
          "numero": "99999999999"
        }
      ],
      "natureza": 2
    },
    {
      "total": 9999.99,
      "debitos": [
        {
          "valor": 9999.99,
          "numero": "99999999999"
        }
      ],
      "natureza": 3
    },
    {
      "total": 9999.99,
      "debitos": [
        {
          "valor": 9999.99,
          "numero": "99999999999"
        }
      ],
      "natureza": 6
    },
    {
      "total": 9999.99,
      "debitos": [
        {
          "valor": 9999.99,
          "numero": "FGSP999999999"
        },
        {
          "valor": 9999.99,
          "numero": "FGSP999999999"
        }
      ],
      "natureza": 7
    }
  ],
  "status": "positiva"
}