Ogmma Revenue

Elegibilidade

GET/v1/elegibilidades

Elegibilidades já feitas, das mais recentes

Escopo:
elegibilidade:ler
Resposta:
200

Pedido

Parâmetros de query

CampoTipoO que é
registroANStexto
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.
carteiratexto
até 30 caracteres
Número da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
detexto
formato AAAA-MM-DD
Início do período, AAAA-MM-DD. O intervalo é fechado: o dia informado entra.
atetexto
formato AAAA-MM-DD
Fim do período, AAAA-MM-DD. O intervalo é fechado: o dia inteiro entra.
limiteinteiro
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.
deslocamentointeiro
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

datalista de ElegibilidadeO recurso. Os campos estão na tabela abaixo.
paginacaoPaginacaoOnde esta página está no total. Vem fora de data.

Campos de Elegibilidade

CampoTipoO que é
idtextoIdentificador 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.
operadoraobjetoA operadora do documento, identificada pelo registro ANS.
registroANStextoRegistro 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.
nometextoRazão social da operadora como a ANS a publica. Informativo — a chave é o registro.
carteiratextoNúmero da carteirinha do beneficiário na operadora, como está no cartão. Sem máscara nem separador.
processamentoProcessamentoO andamento da consulta COM A OPERADORA. Enquanto ele não concluir, elegivel é nulo.
elegivelbooleanoA operadora respondeu que o beneficiário pode ser atendido.
alcancetexto
um de: CARTEIRINHA, PROCEDIMENTO
Até onde a operadora respondeu: pela carteirinha, ou por procedimento.
beneficiarioobjetoO 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.
nometextoNome do beneficiário como a operadora o devolveu — pode divergir do seu cadastro.
validadeCarteiratextoÚltimo dia de validade da carteirinha informado pela operadora.
planotextoNome do plano do beneficiário na operadora.
procedimentosPedidoslista de textoOs 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.
procedimentoslista de objetosOs procedimentos do documento.
codigotextoCódigo do procedimento na tabela declarada.
descricaotextoDescrição do procedimento, como ela vai no documento.
elegivelbooleanoA operadora cobre ESTE procedimento para este beneficiário.
motivoslista de textoO que ela alegou sobre este procedimento.
foraDoContratobooleanoNão está no contrato do prestador com a operadora
motivoslista de textoO que a operadora alegou sobre a elegibilidade como um todo.
avisoslista de textoO que você precisa saber para não ler esta resposta errado — por exemplo, que a operadora respondeu só pela carteirinha.
testebooleanotrue: criado por chave de teste (myd_test_…), executado na homologação da operadora e visível só para chaves de teste.
criadaEmtextoQuando 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_listar

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

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.