💡 A API PGFN - Lista de Devedores da União permite consultar informações sobre débitos relativos a Créditos Tributários Federais e à Dívida Ativa da União, disponíveis nos registros da Receita Federal e da Procuradoria Geral da Fazenda Nacional (PGFN). A API fornece detalhes sobre débitos, incluindo situação, valores e natureza das dívidas.
Introdução
A API PGFN - Lista de Devedores da União oferece uma ferramenta essencial para verificar débitos inscritos na PGFN. Ideal para compliance, análise de crédito e auditorias financeiras, permite obter informações detalhadas sobre dívidas de pessoas físicas ou jurídicas.
URL Base
A API está hospedada no seguinte endereço:
https://api.directd.com.br
Endpoint
Consulta Lista de Devedores da União
GET /api/PGFNListaDevedoresUniao
Descrição: Endpoint utilizado para verificar dívidas inscritas na PGFN. A consulta pode gerar comprovantes em PDF caso habilitado.
Autenticação
Para acessar esta API, é necessário fornecer um token de autenticação.
Regras de Autenticação
- O token deve ser enviado como parâmetro na URL.
- O token é obrigatório para todas as consultas.
Campos da API
Informações Gerais
- Documento Consultado: CPF ou CNPJ utilizado na consulta.
- Nome: Nome completo do devedor.
- Tipo de Pessoa: Pessoa Física ou Jurídica.
- Tipo do Devedor: Classificação do devedor pela PGFN.
- Código do Município: Identificador do município relacionado ao débito.
- UF: Unidade Federativa (Estado) do devedor.
- Unidade Responsável: Unidade que gerencia a dívida.
- Total Dívida: Soma total dos débitos registrados.
- Total Tributário: Soma dos débitos tributários.
Naturezas das Dívidas
- Número de Inscrição: Identificação única do débito.
- Tipo de Dívida: Tributária ou Não Tributária.
- Status: Ativo ou Inativo.
- Receita Principal: Receita relacionada ao débito.
- Situação da Inscrição: Situação do débito (parcelado, regularizado, etc.).
- Valor Total: Soma total do débito específico.
- Entidade Responsável: Instituição que registrou o débito.
- Data de Inscrição: Data de registro na PGFN.
- Unidade de Inscrição: Unidade administrativa responsável.
Parâmetros
Nome | Tipo | Obrigatório | Descrição |
---|---|---|---|
CPF | string | Não | CPF do devedor. Aceita formatação com ou sem máscara. |
CNPJ | string | Não | CNPJ do devedor. Aceita formatação com ou sem máscara. |
TOKEN | string | Sim | Token de autenticação obrigatório. |
GERARCOMPROVANTE | string | Não | Parâmetro opcional para gerar comprovantes em PDF (Habilitar ou Desabilitar ). |
Exemplos de Requisição
Exemplo Usando cURL
curl 'https://api.directd.com.br/api/PGFNListaDevedoresUniao?CPF=12345678909&TOKEN=seu_token_aqui&GERARCOMPROVANTE=Habilitar'
Respostas
Exemplo de Sucesso (200)
{
"metaDados": {
"consultaNome": "PGFN - Lista de Devedores da União",
"consultaUid": "pgfn-123456",
"usuario": "João Silva",
"mensagem": "Sucesso",
"apiVersao": "v3",
"tempoExecucaoMs": 250
},
"retorno": {
"documentoConsultado": "123.456.789-09",
"nome": "JOÃO SILVA",
"tipoPessoa": "Pessoa Física",
"tipoDevedor": "Principal",
"codigoMunicipio": 3550308,
"uf": "SP",
"totalDivida": 50000.00,
"totalTributario": 45000.00,
"naturezas": [
{
"numeroInscricao": "2023-00001",
"tipoDivida": "Tributária",
"status": "Ativo",
"receitaPrincipal": "IRPF",
"situacaoInscricao": "Parcelado",
"total": 25000.00,
"debitos": [
{ "valor": 12500.00 },
{ "valor": 12500.00 }
],
"natureza": 1,
"entidadeResponsavel": "Receita Federal",
"dataInscricao": "2023-01-15",
"tipoCredito": "Regular",
"unidadeInscricao": "Unidade SP"
}
],
"possuiDivida": true,
"status": "Ativo"
}
}
Erros Comuns
Código | Descrição |
---|---|
400 | Requisição inválida: parâmetros incorretos. |
401 | Não autenticado: token inválido ou ausente. |
403 | Não autorizado: saldo insuficiente para realizar a consulta. |
404 | Não encontrado: registro não localizado. |
408 | Tempo esgotado: consulta não foi concluída no prazo. |
500 | Erro interno: falha no processamento da consulta. |
503 | Serviço em manutenção: indisponível temporariamente. |
Notas Importantes
- Apenas um CPF ou CNPJ pode ser informado por requisição.
- O comprovante em PDF é opcional e gera um custo adicional.
- Certifique-se de que seu saldo na plataforma seja suficiente para a consulta.