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.
Óbito
Verifica se consta óbito para determinado CPF.
Casos de Uso
- Integração com Óbito
- 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
- Onboarding de Clientes e Fornecedores
- Prevenção de Lavagem de Dinheiro
- Análise de Risco/Crédito
- Compliance/ESG
- Prevenção de Roubo de Identidade
Benefícios
- Documentação de Óbito 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/ObitoEndpoint
GET https://apiv3.directd.com.br/api/Obito?Cpf={0}&Token=Seu_TokenDescrição: Endpoint para realizar consultas Óbito.
Nota: Esta consulta não gera comprovantes.
Campos Retornados
- CPF: CPF do indivíduo
- Flag Consta Óbito: Retorna se o indivíduo veio a óbito ou não. True(verdadeiro) ou false(falso)
- Nome: Nome do indivíduo/registro
- Status: Retorna detalhes sobre o status do registro em questão
Parâmetros
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
CPF | string | Sim | O parâmetro CPF 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": {
"cpf": "string",
"nome": "string",
"constaObito": 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
- 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