# 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.

- **Identificador:** `pessoas/consulta-de-cpf-na-receita-federal-ondemand`
- **Categoria:** Dados cadastrais
- **Audiência:** PF
- **Endpoint:** `POST /api/v1/{tenant}/pessoas/consulta-de-cpf-na-receita-federal-ondemand`
- **Preço de tabela:** R$ 0,100 por consulta bem-sucedida
- **Página:** https://www.proteo.com.br/api/consultas/pessoas/consulta-de-cpf-na-receita-federal-ondemand

## 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.

## Parâmetros (corpo JSON)

| Campo | Obrigatório | Descriçã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 |

## Campos de retorno (`data`)

| Campo | Tipo |
|---|---|
| `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 (valores fictícios)

```json
{
  "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"
}
```