Orientações e respostas da equipe da Direct Data

💡A API Óbito verifica se consta óbito registrado para determinado CPF. É essencial para validação cadastral, prevenção de fraudes e outras análises de risco.

---

Introdução

A API Óbito consulta se existe registro de óbito para uma pessoa física, a partir de seu CPF. Indicada para validação cadastral, compliance e prevenção de fraudes.

---

URL Base

A API está hospedada no seguinte endereço:

https://api.directd.com.br

---

Endpoint

Consulta Óbito

GET /api/Obito

Descrição: Endpoint para verificar se consta óbito registrado para um CPF.

Nota: Esta consulta não gera comprovantes.

---

Autenticação

Para acessar esta API, é necessário fornecer um token de autenticação.

Regras de Autenticação:

1. O token deve ser enviado como parâmetro na URL da requisição.
2. O token é obrigatório para realizar consultas.

---

Campos da API

Dados Cadastrais

• CPF: Cadastro de Pessoa Física (obrigatório).
• Nome: Nome completo do indivíduo associado ao CPF.
• Flag Consta Óbito: Informa se há registro de óbito (true ou false).
• Status: Status geral da consulta (ativo, inativo, etc.).

---

Parâmetros

---

Exemplos de Requisição

Usando cURL

curl 'https://api.directd.com.br/api/Obito?CPF=12345678909&TOKEN=seu_token_aqui'

---

Respostas

Sucesso (200)

Exemplo de Resposta

{
  "metaDados": {
    "consultaNome": "Óbito",
    "consultaUid": "obito-123456",
    "usuario": "João Silva",
    "mensagem": "Sucesso",
    "apiVersao": "v3",
    "tempoExecucaoMs": 180
  },
  "retorno": {
    "cpf": "123.456.789-09",
    "nome": "JOÃO SILVA",
    "constaObito": true,
    "status": "Ativo"
  }
}

---

Erros Comuns

---

Notas Importantes

• O CPF e o token são obrigatórios para todas as consultas.
• Essa API não gera comprovantes ou certificados.