Consultar status

Retorna o status atual de um contrato específico.

Retorna o status atual do contrato identificado por CPF, número do cartão e plano.

POST /v1/TeleMedicina/ConsultaStatus

POST https://api.sauddy.com.br/v1/TeleMedicina/ConsultaStatus
Authorization: Bearer <token>
Content-Type: application/json

Corpo da requisição

CampoTipoObrigatórioDescrição
cpfstringSimCPF do beneficiário, com ou sem máscara.
numeroCartaostringSimNúmero do cartão retornado na adesão.
codigoOnixstringSimCódigo do plano do contrato.

Exemplos

curl -X POST https://api.sauddy.com.br/v1/TeleMedicina/ConsultaStatus \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "cpf": "12345678909",
    "numeroCartao": "1234567890123456",
    "codigoOnix": "7426"
  }'

Resposta de sucesso — 200 OK

{
  "data": {
    "codOnix": "7426",
    "cpf": "12345678909",
    "data_inicio_associacao": "2026-10-09 14:32:10",
    "desc_status": "Ativo",
    "numeroCartao": "1234567890123456",
    "statuscartao": 1
  },
  "errorMessage": "",
  "success": true
}
Campo de dataTipoDescrição
statuscartaonumberCódigo do status: 1 ativo, 2 suspenso, 3 cancelado, 0 pendente. Veja Status do contrato.
desc_statusstringDescrição do status: Ativo, Suspenso ou Cancelado.
numeroCartaostringNúmero do cartão do beneficiário.
codOnixstringCódigo do plano.
cpfstringCPF do beneficiário (somente dígitos).
data_inicio_associacaostringData e hora da adesão (AAAA-MM-DD HH:mm:ss, UTC).

Homologação:

Em homologação a consulta sempre retorna o contrato como Ativo (statuscartao: 1), ecoando os dados enviados, e não inclui data_inicio_associacao.

Erros

HTTPQuando acontecemessage
400Campo obrigatório ausente, vazio ou não documentadoLista dos problemas
400codigoOnix que não é um plano válido (também em homologação)codigoOnix inválido: "9999". Códigos aceitos: ...
401Token ausente, inválido ou expiradoToken não informado. ou Token inválido ou expirado.
404Nenhum contrato da sua empresa com esse CPF, cartão e planoContrato não encontrado.