Elegibilidade
/v1/elegibilidadesElegibilidades já feitas, das mais recentes
- Escopo:
- elegibilidade:ler
- Resposta:
- 200
Pedido
Parâmetros de query
| Campo | Tipo | O que é |
|---|---|---|
| registroANS | texto formato 6 dígitos | Registro da operadora na ANS, seis dígitos (ex. 334561). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora. |
| carteira | texto até 30 caracteres | Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador. |
| de | texto formato AAAA-MM-DD | Início do período, AAAA-MM-DD. O intervalo é fechado: o dia informado entra. |
| ate | texto formato AAAA-MM-DD | Fim do período, AAAA-MM-DD. O intervalo é fechado: o dia inteiro entra. |
| limite | inteiro 1–100 · padrão 20 | Quantos registros trazer nesta página. O teto varia por rota (50 a 200) e está nas regras do campo. |
| deslocamento | inteiro padrão 0 | Quantos registros pular, para a página seguinte. Use com paginacao.total da resposta; paginacao.temMais diz se vale pedir mais. |
* obrigatório. Campo desconhecido é recusado, não ignorado: a API responde VALIDATION_ERROR em vez de descartar em silêncio.
Exemplo de chamada
curl -X GET https://api.miydas.com.br/v1/elegibilidades \
-H "Authorization: Bearer $MIYDAS_CHAVE"Resposta 200
| data | lista de Elegibilidade | O recurso. Os campos estão na tabela abaixo. |
| paginacao | Paginacao | Onde esta página está no total. Vem fora de data. |
Campos de Elegibilidade
| Campo | Tipo | O que é |
|---|---|---|
| id | texto | Identificador do recurso no Miydas. Opaco e estável — NÃO é o número que a operadora ou o seu sistema usam para a mesma coisa. Guarde-o como veio e não derive significado do formato. |
| operadora | objeto | A operadora do documento, identificada pelo registro ANS. |
| registroANS | texto | Registro da operadora na ANS, seis dígitos (ex. 334561). É a chave de operadora em toda a API — não usamos nome nem código interno para identificar operadora. |
| nome | texto | Razão social da operadora como a ANS a publica. Informativo — a chave é o registro. |
| carteira | texto | Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador. |
| processamento | Processamento | O andamento da consulta COM A OPERADORA. Enquanto ele não concluir, elegivel é nulo. |
| elegivel | booleano | A operadora respondeu que o beneficiário pode ser atendido. |
| alcance | texto um de: CARTEIRINHA, PROCEDIMENTO | Até onde a operadora respondeu: pela carteirinha, ou por procedimento. |
| beneficiario | objeto | O nome do beneficiário, como a operadora o devolveu. Pode divergir do seu cadastro, e em boa parte dos documentos nem vem — a carteirinha é que identifica. |
| nome | texto | Nome do beneficiário como a operadora o devolveu — pode divergir do seu cadastro. |
| validadeCarteira | texto | Último dia de validade da carteirinha informado pela operadora. |
| plano | texto | Nome do plano do beneficiário na operadora. |
| procedimentosPedidos | lista de texto | Os códigos que você perguntou. Devolvidos de volta para que a ausência de um deles em procedimentos seja visível: operadora que só responde pela carteirinha não respondeu por procedimento nenhum. |
| procedimentos | lista de objetos | Os procedimentos do documento. |
| codigo | texto | Código do procedimento na tabela declarada. |
| descricao | texto | Descrição do procedimento, como ela vai no documento. |
| elegivel | booleano | A operadora cobre ESTE procedimento para este beneficiário. |
| motivos | lista de texto | O que ela alegou sobre este procedimento. |
| foraDoContrato | booleano | Não está no contrato do prestador com a operadora |
| motivos | lista de texto | O que a operadora alegou sobre a elegibilidade como um todo. |
| avisos | lista de texto | O que você precisa saber para não ler esta resposta errado — por exemplo, que a operadora respondeu só pela carteirinha. |
| teste | booleano | true: criado por chave de teste (myd_test_…), executado na homologação da operadora e visível só para chaves de teste. |
| criadaEm | texto | Quando o registro nasceu no Miydas, em ISO 8601 com fuso. |
Exemplo de retorno
{
"data": [
{
"id": "cmf3k2x9a0002ele",
"operadora": {
"registroANS": "334561",
"nome": "Unimed Blumenau"
},
"carteira": "00000000000000000",
"processamento": {
"status": "CONCLUIDO",
"iniciadoEm": "2026-09-27T13:00:01.000Z",
"concluidoEm": "2026-09-27T13:00:03.000Z"
},
"elegivel": true,
"alcance": "CARTEIRINHA",
"beneficiario": {
"nome": "PACIENTE EXEMPLO",
"validadeCarteira": "2027-01-31",
"plano": "PLANO EXEMPLO"
},
"procedimentosPedidos": [
"40304361"
],
"procedimentos": [],
"motivos": [],
"avisos": [
"Esta operadora respondeu pela carteirinha: a habilitação de cada procedimento não foi verificada."
],
"teste": false,
"criadaEm": "2026-09-27T13:00:01.000Z"
}
],
"paginacao": {
"total": 1,
"limite": 20,
"deslocamento": 0,
"temMais": false
}
}Experimente sem chave
O sandbox devolve este mesmo corpo, sem autenticação e sem tocar na base de ninguém.
curl https://api.miydas.com.br/v1/sandbox/elegibilidades_listarA chave de teste myd_test_… é outra coisa: ela opera na homologação da operadora e serve para escrever. Para ver o formato antes de ter credencial, convênio e varredura, é este sandbox.
Erros
Esta rota não tem erro próprio: só os comuns a qualquer chamada com chave — chave ausente ou inválida, escopo insuficiente, parâmetro recusado e erro interno.
Toda falha tem o mesmo formato: { "error": "CODIGO", "message": "…", "details": { … } }. error é estável e serve para lógica; message é para gente e pode mudar. Erros comuns a toda rota com chave (lista completa) não se repetem aqui.