Lista todos os contratos de um CPF na sua empresa, em todos os planos e status, do mais recente para o mais antigo. É a forma de recuperar o numeroCartao de um beneficiário.
GET /v1/TeleMedicina/contratos/:cpf
GET https://api.sauddy.com.br/v1/TeleMedicina/contratos/{cpf}
Authorization: Bearer <token>
Parâmetros de rota
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
cpf | string | Sim | CPF do beneficiário. Prefira enviar somente os dígitos, ex.: 12345678909. |
Exemplos
curl https://api.sauddy.com.br/v1/TeleMedicina/contratos/12345678909 \
-H "Authorization: Bearer $TOKEN"
Resposta de sucesso — 200 OK
{
"data": [
{
"nome": "Maria da Silva",
"numeroCartao": "1234567890123456",
"onix": "7426",
"onixDescricao": "Individual - Essencial",
"status": "Ativo",
"dataContrato": "2026-10-09 14:32:10",
"dataCancelamento": null
},
{
"nome": "Maria da Silva",
"numeroCartao": "6543210987654321",
"onix": "7499",
"onixDescricao": "Familiar - Essencial",
"status": "Cancelado",
"dataContrato": "2025-03-02 10:15:00",
"dataCancelamento": "2026-01-10 08:00:00"
}
],
"errorMessage": "",
"success": true
}
| Campo de cada item | Tipo | Descrição |
|---|---|---|
nome | string | Nome do beneficiário. |
numeroCartao | string | Número do cartão do contrato. |
onix | string | Código do plano (codigoOnix). |
onixDescricao | string | Nome do plano. |
status | string | Ativo, Suspenso ou Cancelado. |
dataContrato | string | Data e hora da adesão (AAAA-MM-DD HH:mm:ss, UTC). |
dataCancelamento | string ou null | Data e hora do cancelamento, ou null se não foi cancelado. |
Se o CPF não tiver contratos na sua empresa, a resposta é 200 com data vazio ([]).
Homologação:
Em homologação a resposta é sempre um único contrato de exemplo, com numeroCartao SDY-HOMOL-1234567890123456.
Erros
| HTTP | Quando acontece | message |
|---|---|---|
400 | CPF com menos de 11 dígitos | CPF inválido. |
401 | Token ausente, inválido ou expirado | Token não informado. ou Token inválido ou expirado. |