Dados cadastrais

Consulta de CPF na Receita Federal (OnDemand)

O serviço de Consulta de CPF na Receita Federal retorna o status do CPF, protocolo e informações de óbito (quando disponíveis). Usa a fonte principal e, se necessário, uma fonte alternativa configurável no Background Check.

Quando usar

Descrição

O serviço de Consulta de CPF na Receita Federal (OnDemand) fornece o resultado da consulta de status do CPF disponível no site da Receita Federal, incluindo status, protocolo de consulta, informação de óbito (quando disponível) e outros detalhes.

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 devolver o resultado esperado.

Pode ser desativada na configuração do Background Check; com ela desligada, consultas que falharem na fonte 1 podem retornar indisponíveis.

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/consulta-de-cpf-na-receita-federal-ondemand

CampoObrigatórioDescrição
document sim CPF da pessoa, com ou sem máscara.
birthdate não Data de nascimento
provided_name não Nome informado para conferência
{
  "document": "000.000.000-00",
  "birthdate": "valor",
  "provided_name": "valor"
}

Campos de retorno

Campos dentro de data. [] indica lista.

CampoTipo
Origin texto
InputParameters texto
ProtocolNumber texto
BaseStatus texto
AdditionalOutputData.Name texto
AdditionalOutputData.Birthdate data
AdditionalOutputData.QueryTime texto
AdditionalOutputData.SocialName texto
AdditionalOutputData.Digit texto
AdditionalOutputData.RegistrationDate data
AdditionalOutputData.IsDead texto
AdditionalOutputData.DeathYear texto
AdditionalOutputData.RawResultFile texto
AdditionalOutputData.RawResultFileType 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": "Consulta de CPF na Receita Federal (OnDemand)",
  "query_slug": "consulta-de-cpf-na-receita-federal-ondemand",
  "data": {
    "Origin": "texto",
    "InputParameters": "texto",
    "ProtocolNumber": "texto",
    "BaseStatus": "texto",
    "AdditionalOutputData": {
      "Name": "texto",
      "Birthdate": "2026-01-01",
      "QueryTime": "texto",
      "SocialName": "texto",
      "Digit": "texto",
      "RegistrationDate": "2026-01-01",
      "IsDead": "texto",
      "DeathYear": "texto",
      "RawResultFile": "texto",
      "RawResultFileType": "texto"
    },
    "QueryDate": "2026-01-01"
  },
  "consulted_at": "2026-01-01T12:00:00Z",
  "query_cost": "0.100"
}

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