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.
PGFN - Lista de Devedores da União
A consulta de Certidão PGFN retorna o resultado da emissão de Certidão de Débitos Relativos a Créditos Tributários Federais e à Dívida Ativa da União, disponível no site da Receita Federal e da própria Procuradoria Geral da Fazenda Nacional (PGFN), junto com os detalhes e informações da certidão.
Casos de Uso
- Integração com PGFN - Lista de Devedores da União | Consulta de Débitos e Dívida Ativa
- Onboarding KYC e validação de identidade
- Análise de risco/crédito com dados cadastrais e socioeconômicos
- Prevenção a fraude em abertura de conta e cadastro
Aplicações
- Prevenção de Autuações Fiscais
- Onboarding de Clientes e Fornecedores
- Análise de Risco/Crédito
Benefícios
- Documentação de PGFN - Lista de Devedores da União | Consulta de Débitos e Dívida Ativa acessível e atualizada
- Dados atualizados e padronizados
- Aumento de aprovação com menos atrito
- Conformidade com políticas internas e LGPD
URL Base
A API está hospedada no seguinte endereço:
https://apiv3.directd.com.br/api/PGFNListaDevedoresUniaoEndpoint
GET https://apiv3.directd.com.br/api/PGFNListaDevedoresUniao?Cpf={0}&Cnpj={1}&Token=Seu_TokenDescrição: Endpoint para realizar consultas PGFN - Lista de Devedores da União.
Nota: Esta consulta gera comprovantes em PDF.
Esta API suporta geração de comprovantes em PDF
Campos Retornados
- Código do Município: Código do município do indivíduo consultado
- Data de Inscrição: Data de inscrição
- Documento Consultado: Documento consultado referente ao CPF/CNPJ
- Entidade Principal: Entidade responsável pela dívida
- Flag Dívida: Inscrição estadual da entidade consultada
- Lista de Débito: Lista de débitos da entidade, caso possua
- Lista de Naturezas: Lista de naturezas do registro
- Natureza: Código da natureza da dívida
- Nome: Nome do indivíduo/registro
- Número de Inscrição: Número da inscrição
- Receita Principal: Receita principal da dívida
- Situação da Inscrição: Situação da inscrição com relação a dívida
- Status: Retorna detalhes sobre o status do registro em questão
- Tipo da Dívida: Descrição do tipo da dívida
- Tipo de Crédito: Tipo de crédito da natureza
- Tipo de Pessoa: Tipo de pessoa do indivíduo consultado
- Tipo do Devedor: Informa que tipo de devedor é o indivíduo consultado
- Total: Total do valor do registro.
- Total da Dívida: Total da dívida do indivíduo consultado
- Total Tributário: Total tributário do indivíduo consultado
- UF: Unidade Federativa (estado) referente ao registro
- Unidade de Inscrição: Unidade de inscrição
- Unidade Responsável: Unidade responsável pela dívida
- Valor: Valor da parcela
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
CPF | string | Sim | O parâmetro CPF pode ser enviado com ou sem formatação. |
CNPJ | string | Sim | O parâmetro CNPJ pode ser enviado com ou sem formatação. |
TOKEN | string | Sim | O parâmetro TOKEN é essencial para efetuar esta consulta. Em caso de dúvidas, por favor, entre em contato com: suporte@directd.com.br |
Exemplo de Resposta
{
"metaDados": {
"consultaNome": "string",
"consultaUid": "string",
"chave": "string",
"usuario": "string",
"mensagem": "string",
"ip": "string",
"resultadoId": 0,
"resultado": "string",
"apiVersao": "v3",
"enviarCallback": false,
"gerarComprovante": false,
"urlComprovante": "string",
"assincrono": true,
"data": "dd/MM/yyyy HH:mm:ss",
"tempoExecucaoMs": 0
},
"retorno": {
"documentoConsultado": "string",
"nome": "string",
"tipoPessoa": "string",
"tipoDevedor": "string",
"cnae": "string",
"cnaeDescricao": "string",
"codigoMunicipio": 0,
"nomeMunicipio": "string",
"unidadeResponsavel": "string",
"uf": "string",
"totalDivida": 0,
"totalTributario": 0,
"totalPrevidenciario": 0,
"naturezas": [
{
"numeroInscricao": "string",
"tipoDivida": "string",
"status": "string",
"receitaPrincipal": "string",
"situacaoInscricao": "string",
"total": 0,
"debitos": [
{
"valor": 0
}
],
"natureza": 0,
"entidadeResponsavel": "string",
"dataInscricao": "string",
"tipoCredito": "string",
"unidadeInscricao": "string"
}
],
"possuiDivida": true,
"status": "string"
}
}Erros Comuns
| Código | Descrição |
|---|---|
400 | Requisição Inválida: a requisição está incorreta ou os parâmetros são inválidos. |
401 | Não Autenticado: o usuário não forneceu as credenciais corretas para acessar o recurso. |
403 | Não Autorizado: o servidor recebeu a requisição, mas se negou a autorizá-la por conta de saldo indisponível. |
404 | Não Encontrado: o servidor não encontrou uma representação atual do recurso solicitado. |
408 | Tempo Esgotado: o servidor não conseguiu retornar a requisição no prazo estabelecido. |
500 | Falha ao Realizar Consulta: o servidor não conseguiu processar a requisição com sucesso. Por favor, entre em contato com o nosso suporte. |
503 | Consulta em Manutenção: a consulta requisitada está em manutenção. Por favor, entre em contato com o nosso suporte. |
Notas Importantes
- Informe apenas um único documento por requisição
- Para obter o comprovante desta consulta, utiliza-se: '&GerarComprovante=habilitar' na URL
- Para utilizar a consulta de forma assíncrona, utiliza-se: '&async=habilitar' na URL
- Em caso de dúvidas/suporte, entre em contato pelo e-mail: suporte@directd.com.br ou pelo nosso WhatsApp: (11) 93906-9228