Certidão PGFN
O serviço de Certidão PGFN retorna os dados da Certidão de Débitos Relativos a Créditos Tributários Federais e à Dívida Ativa da União. Usa a fonte principal e, se necessário, fontes alternativas configuráveis no Background Check.
Quando usar
Descrição
O serviço de Certidão PGFN fornece os dados da Certidão de Débitos Relativos a Créditos Tributários Federais e à Dívida Ativa da União da entidade consultada, incluindo status, número de protocolo e conteúdo completo da certidão.
Fontes de consulta
Fonte 1 — consulta padrão. Sempre utilizada primeiro.
Fonte 2 (Consulta complementar automática) — acionada somente quando a fonte 1 não emitir a certidão oficial.
Pode ser desativada na configuração do Background Check; com ela desligada, consultas que falharem na fonte 1 podem retornar indisponíveis ou incompletas.
Fonte 3 (Consulta Lista de Devedores PGFN) — opção adicional, desligada por padrão.
Quando a certidão oficial não puder ser emitida pelas fontes anteriores, aceita o resultado da consulta à Lista de Devedores / Dívida Ativa.
Funciona com a fonte 2 ligada ou desligada.
Requisição
Autenticação por chave de API (cabeçalho Authorization: Bearer), criada no painel com esta consulta no escopo.
POST /api/v1/{tenant}/pessoas/certidao-pgfn
| Campo | Obrigatório | Descrição |
|---|---|---|
document |
sim | CPF da pessoa, com ou sem máscara. |
{
"document": "000.000.000-00"
}
Campos de retorno
Campos dentro de data. [] indica lista.
| Campo | Tipo |
|---|---|
Origin |
texto |
InputParameters |
texto |
ProtocolNumber |
texto |
BaseStatus |
texto |
AdditionalOutputData.PGFNClearance |
texto |
AdditionalOutputData.QueryType |
texto |
AdditionalOutputData.TaxPayer |
texto |
AdditionalOutputData.EmissionDate |
data |
AdditionalOutputData.ValidityDate |
data |
AdditionalOutputData.RawResultFile |
texto |
AdditionalOutputData.RawResultFileType |
texto |
AdditionalOutputData.DataSource |
texto |
AdditionalOutputData.<chave> |
texto |
QueryDate |
data |
Exemplo de resposta
Estrutura real da resposta, com valores fictícios.
{
"execution_id": "00000000-0000-0000-0000-000000000000",
"status": "success",
"message": "Consulta realizada com sucesso",
"query_name": "Certidão PGFN",
"query_slug": "certidao-pgfn",
"data": {
"Origin": "texto",
"InputParameters": "texto",
"ProtocolNumber": "texto",
"BaseStatus": "texto",
"AdditionalOutputData": {
"PGFNClearance": "texto",
"QueryType": "texto",
"TaxPayer": "texto",
"EmissionDate": "2026-01-01",
"ValidityDate": "2026-01-01",
"RawResultFile": "texto",
"RawResultFileType": "texto",
"DataSource": "texto",
"<chave>": "texto"
},
"QueryDate": "2026-01-01"
},
"consulted_at": "2026-01-01T12:00:00Z",
"query_cost": "0.730"
}
Cobrança e respostas
- O valor é cobrado por consulta bem-sucedida.
- 200 — consulta processada (veja status no corpo da resposta)
- 401 — token ausente, inválido, inativo ou expirado
- 403 — serviço fora do escopo da chave, IP não autorizado ou limite de consumo excedido
- 422 — campo obrigatório ausente/inválido ou payload acima do limite do serviço
- 429 — limite de requisições por minuto da chave excedido
- 504 — tempo máximo de execução do serviço excedido