Elegibilidade
/v1/elegibilidadesPergunta à operadora se o beneficiário pode ser atendido
procedimentos é aceito em toda operadora. Onde ela responde só pela carteirinha, alcance vem CARTEIRINHA e avisos diz que os procedimentos não foram verificados.
- Escopo:
- elegibilidade:executar
- Resposta:
- 200 ou 202
- Espera:
- aceita
Prefer: wait=N
Pedido
Corpo (JSON)
| 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 1–30 caracteres | Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador. |
| procedimentos | lista de texto até 20 itens | Os códigos que você quer verificar. Onde a operadora só responde pela carteirinha, alcance vem CARTEIRINHA e eles não foram verificados — não são negativa. |
| dataAtendimento | texto formato AAAA-MM-DD | Data em que o atendimento aconteceu ou vai acontecer, AAAA-MM-DD. |
* 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 POST https://api.miydas.com.br/v1/elegibilidades \
-H "Authorization: Bearer $MIYDAS_CHAVE" \
-H "Prefer: wait=20" \
-H "Content-Type: application/json" \
-d '{
"registroANS": "334561",
"carteira": "00000000000000000",
"procedimentos": [
"40304361"
]
}'Resposta 200 / 202
| data | Elegibilidade | O recurso. Os campos estão na tabela abaixo. |
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"
}
}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_criarO sandbox responde sempre em GET, mesmo para uma operação POST: ele devolve a forma da resposta, não executa nada.
A 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
| Código | HTTP | Quando | O que fazer |
|---|---|---|---|
| OPERADORA_NAO_ENCONTRADA | 404 | A empresa não tem essa operadora (registro ANS) cadastrada. | Veja as operadoras em GET /v1/operadoras. |
| OPERACAO_NAO_COBERTA | 422 | A operadora não oferece esta operação. details.operacoesDisponiveis lista o que ela oferece. | Não repita: a resposta não muda. |
| CREDENCIAL_AUSENTE | 422 | A empresa não cadastrou a credencial desta operadora. | Cadastre a credencial no Miydas e repita. |
| AMBIENTE_TESTE_INDISPONIVEL | 422 | A chave é de teste (myd_test_…) e o pedido não cabe na homologação: a empresa não tem homologação configurada para esta operadora; ou a operação grava dado de produção (lote, retorno, recurso de glosa, cancelamento por número, anexos, documentos, cadastro de convênio); ou tenta trocar o endereço, o conector ou a agenda da conexão de homologação. A chave de teste nunca opera em produção. | Configure a homologação da operadora no Miydas; para autorização e elegibilidade use /v1/autorizacoes e /v1/elegibilidades; o resto, com a chave de produção. |
| LIMITE_EXCEDIDO | 429 | Muitas operações em andamento para esta operadora nesta empresa. | Espere e repita — com a mesma Idempotency-Key, se for escrita. |
Depois de aceita, ainda pode falhar — e aí o erro aparece em processamento.erro, não na resposta do pedido:
OPERADORA_INDISPONIVEL— A operadora não respondeu, ou respondeu fora do padrão. SepodeRepetirfor true, repita depois. Se for false (escrita), consulte antes de repetir — o pedido pode ter chegado.CREDENCIAL_RECUSADA— A operadora recusou a credencial cadastrada. Atualize a credencial no Miydas.CONEXAO_INCOMPLETA— Falta um dado obrigatório na conexão da empresa com a operadora (ex.: nome do contratado). Nada foi enviado à operadora. Complete a conexão no Miydas e repita — a mensagem diz o que falta.PEDIDO_RECUSADO— A operadora recusou o pedido antes de analisar (ex.: código de procedimento que ela não aceita). A mensagem traz o motivo dela. Corrija o pedido conforme o motivo e peça de novo — nada foi autorizado.PEDIDO_INCOMPLETO— Falta um dado que esta operadora exige (ex.: indicação clínica na Bradesco). Nada foi enviado. Complete o pedido e repita.OPERADORA_OCUPADA— O acesso da empresa à operadora estava em uso por outra pessoa no momento. Nada foi enviado. Repita em alguns minutos.DADOS_RECUSADOS— A operadora — ou a validação do Miydas antes do envio — recusou os dados do pedido.messagediz qual dado quando isso se sabe: o conselho do profissional, o registro ANS na credencial da operadora, procedimentos acima do limite, o cadastro do prestador na operadora (a conexão sem o nome do contratado sai como CONEXAO_INCOMPLETA). Recusado antes do envio, nada chegou à operadora epodeRepetiré true; recusado pela operadora numa escrita,podeRepetiré false, como em toda escrita que chegou lá. Corrija o dado apontado — no pedido ou na credencial da operadora no Miydas — e faça um pedido novo: repetir igual dá a mesma recusa. Solicitação de autorização que não chegou à operadora (a mensagem diz) pode ser refeita com o mesmonumeroGuiaPrestador.
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.