Elegibilidade

URL de Chamada

GET: https://api-eligibility-prd.ducash.com.br/check/v2/simple/{CPF}

Serviço responsável por informar aos parceiros e clientes se um determinado usuário está elegível a receber descontos utilizando o seu próprio CPF. Para a utilização correta, informe o CPF do paciente ao final da rota.

Obs: Antes de utilizar, resgate seu token de acesso. Detalhes na página de INTRODUÇÃO

Parâmetro enviado

Campo	Tipo	Descrição
CPF	string	Dado do beneficiário que deseja receber o desconto

Obs: O campo acima é obrigatório

---

Parâmetros recebidos

Campo	Tipo	Descrição
CPF	string	CPF do beneficiário
Matrícula	string	Número de inscrição do plano. Esse número se repete em caso de planos que contenham titulares e dependentes como beneficiários.
Nome	string	Nome do beneficiário
Data de Nascimento	string	Data de nascimento do beneficiário
Sexo	string	Sexo do beneficiário
Tipo	string	Tipo de beneficiário (Titular ou Dependente)

Respostas

Exemplo de resposta: CPF encontrado (Status HTTP: 200 OK)

{
    "existente": true,
    "mensagem": null,
    "vida": {
        "cpf": "73721553047",
        "matricula": "123456",
        "nome": "Francisca Otávia dos Santos",
        "dataNascimento": "1976-07-15T03:00:00.000Z",
        "sexo": "Feminino"
        "status": "Ativo"
    }
}

Obs: Dados fictícios

Exemplo de resposta: Falha de autenticação (Status HTTP: 401 Unauthorized)

{
    "code": 3,
    "description": "O token de acesso não é válido.",
    "error": "O token de sandbox não é válido. Consulte a documentação para mais informações."
}

Exemplo de resposta: CPF não encontrado (Status HTTP: 404 Not Found)

{
    "code": 2,
    "description": "CPF não encontrado.",
    "error": null
}

Exemplo de resposta: CPF inativo (Status HTTP: 404 Not Found)

{
    "code": 4,
    "description": "CPF inativo.",
    "error": null
}

Exemplo de resposta: Erro de infraestrutura (Status HTTP: 500 Internal Server Error)

{
    "code": 1,
    "description": "Ocorreu um erro interno, por favor tente novamente mais tarde.",
    "error": null
}