Informe o CPF e a data de nascimento. A UniObito consulta a situação cadastral na Receita Federal e responde se o titular faleceu, com o ano do óbito quando a Receita informa, o nome e os dados do comprovante.
Toda chamada leva a chave no cabeçalho X-API-Key (ou Authorization: Bearer <chave>). As chaves são criadas no sistema, em Chaves de API. A chave completa aparece uma única vez, na criação.
Quando a chave tem limite, as respostas trazem X-Cota-Restante-Dia e X-Cota-Restante-Mes. O mesmo CPF com a mesma data consultado nas últimas 24 horas volta na hora, marcado com "cache": true, e não consome cota. Para forçar uma consulta nova, envie cache=false.
Uma consulta nova leva em geral de 15 a 60 segundos. Configure o tempo limite do seu sistema para pelo menos 240 segundos.
Resposta curta, pensada para regras de negócio. A data também pode ir como dd/mm/aaaa. O CPF pode ter ou não pontuação.
curl -H "X-API-Key: SUA_CHAVE" "https://SEU_ENDERECO/obito/11144477735?nascimento=1941-07-02"{
"id": 1842,
"cpf": "111.444.777-35",
"falecido": true,
"ano_obito": 2021,
"situacao": "falecido",
"situacao_descricao": "TITULAR FALECIDO",
"nome": "JOAO PEREIRA DE SOUZA"
}{"cpf": "...", "nascimento": "...", "comprovante": false}| Parâmetro | O que faz |
|---|---|
nascimento | Obrigatório. aaaa-mm-dd ou dd/mm/aaaa. |
comprovante | true gera o comprovante da Receita em PDF. O link vem em comprovante_pdf.baixar. |
cache | false ignora o resultado recente e consulta de novo. |
Até 50 itens por chamada. Cada item volta com o próprio resultado ou erro, na mesma ordem.
{"itens": [
{"cpf": "529.982.247-25", "nascimento": "1980-03-15"},
{"cpf": "11144477735", "nascimento": "02/07/1941"}
], "cache": true}Resposta: total, falecidos, com_erro e resultados[] (no mesmo formato do GET /cpf).
| Campo | Conteúdo |
|---|---|
falecido | true: a Receita registra o falecimento. false: sem registro de óbito. null: CPF não localizado ou data de nascimento divergente. |
ano_obito | Ano do óbito, quando o comprovante informa. |
situacao.codigo | regular, falecido, suspensa, pendente, cancelada, nula, data_divergente, cpf_inexistente. |
situacao.descricao | Texto da Receita (ex.: TITULAR FALECIDO, CANCELADA POR ENCERRAMENTO DE ESPÓLIO). |
nome, nome_social | Como constam no comprovante. |
data_inscricao, digito_verificador | Dados do comprovante. |
comprovante_receita | emitido_em e codigo_controle do comprovante. |
comprovante_pdf | disponivel e baixar, quando pedido. |
id | Protocolo da consulta, para buscar de novo em /consultas/{id}. |
Uma situação "cancelada por encerramento de espólio" ou com ano de óbito no comprovante também volta com falecido: true.
Toda resposta de erro tem sucesso: false, codigo e erro (mensagem em português).
| HTTP | codigo | Quando |
|---|---|---|
| 400 | CPF_INVALIDO | CPF com dígitos verificadores errados. |
| 400 | DATA_INVALIDA | Data de nascimento ausente ou inválida. |
| 401 | TOKEN_INVALIDO | Chave ausente ou inexistente. |
| 403 | TOKEN_BLOQUEADO | Chave desativada ou vencida. |
| 413 | LOTE_GRANDE | Mais de 50 itens no lote. |
| 422 | PARAMETRO_INVALIDO | Campos ausentes ou com formato errado. |
| 429 | COTA_ESGOTADA | Limite diário ou mensal da chave atingido. |
| 503 | SERVICO_INDISPONIVEL | A Receita Federal não respondeu a tempo. Tente de novo em alguns minutos. |
falecido: null como "não confirmado": confira a data de nascimento antes de concluir qualquer coisa.UniObito · um sistema UNICONTROLLER. · Dev Jackson Tomelin