Voa

Referência da API

A API também oferece o endpoint MCP /mcp. Envie a chave no cabeçalho Authorization: Bearer <chave>.
Operações
POST/v1/apply_fixesPOST/v1/auditGET/v1/auth/callbackGET/v1/auth/loginPOST/v1/buildGET/v1/docsGET/v1/dominioGET/v1/glosas/{codigo}POST/v1/hashPOST/v1/keys/refreshGET/v1/limitsPOST/v1/lista-de-esperaGET/v1/operadorasGET/v1/operadoras/{registro_ans}GET/v1/operadoras/{registro}/redePOST/v1/parse_demonstrativoPOST/v1/plan_reconciliationGET/v1/redePOST/v1/sadt_catalogPOST/v1/sadt_missingPOST/v1/sandbox/lotesGET/v1/sandbox/lotes/{protocolo}/demonstrativoPOST/v1/tuss_lookupPOST/v1/tuss_searchPOST/v1/validateGET/oauth/client.json

POST/v1/apply_fixes

Operação HTTP da API.

Corpo da solicitação
loteobjectobrigatório
reportobjectobrigatório
Respostas
200Resposta bem-sucedida
422Entrada inválida

POST/v1/audit

Operação HTTP da API.

Corpo da solicitação
contextoobject
datastring
loteobjectobrigatório
Respostas
200Resposta bem-sucedida
422Entrada inválida

GET/v1/auth/callback

Concluir o login com a conta Voa.

Respostas
200Resposta bem-sucedida

GET/v1/auth/login

Iniciar o login com a conta Voa.

Respostas
200Resposta bem-sucedida

POST/v1/build

Operação HTTP da API.

Corpo da solicitação
loteobjectobrigatório
Respostas
200Resposta bem-sucedida
422Entrada inválida

GET/v1/docs

Operação HTTP da API.

Respostas
200Resposta bem-sucedida
422Entrada inválida

GET/v1/dominio

Operação HTTP da API.

Respostas
200Resposta bem-sucedida
422Entrada inválida

GET/v1/glosas/{codigo}

Operação HTTP da API.

Respostas
200Resposta bem-sucedida
422Entrada inválida

POST/v1/hash

Operação HTTP da API.

Corpo da solicitação
xmlstringobrigatório
Respostas
200Resposta bem-sucedida
422Entrada inválida

POST/v1/keys/refresh

Renovar uma chave de acesso usando o token de renovação.

Corpo da solicitação
refresh_tokenstringobrigatório
Respostas
200Resposta bem-sucedida

GET/v1/limits

Consultar a configuração de uso da API.

Respostas
200Resposta bem-sucedida

POST/v1/lista-de-espera

Receba um aviso por e-mail quando o módulo for lançado.

Corpo da solicitação
emailstringobrigatório
empresastringobrigatório
moduloobjetoobrigatório
Valores: recurso, extrator, cloud
tipos_documentoarray
volume_mensalobjetoobrigatório
Valores: ate_500, 500_a_2000, 2000_a_10000, 10000_a_50000, acima_50000
Respostas
202Inscrição recebida.
422Entrada inválida
429Limite diário atingido.
503Lista de espera indisponível.

GET/v1/operadoras

Operação HTTP da API.

Respostas
200Resposta bem-sucedida
422Entrada inválida

GET/v1/operadoras/{registro_ans}

Operação HTTP da API.

Respostas
200Resposta bem-sucedida
422Entrada inválida

GET/v1/operadoras/{registro}/rede

Listar os estabelecimentos da rede hospitalar de uma operadora.

Respostas
200Resposta bem-sucedida
422Entrada inválida
503Rede hospitalar indisponível.

POST/v1/parse_demonstrativo

Interpretar um demonstrativo de pagamento TISS.

Corpo da solicitação
xmlstringobrigatório
Respostas
200Resposta bem-sucedida
422Entrada inválida

POST/v1/plan_reconciliation

Planejar a conciliação entre guias e demonstrativos.

Corpo da solicitação
decisoesarrayobrigatório
guiasarrayobrigatório
id_keystring
operadora_keystring
prestador_keystring
status_keystring
Respostas
200Resposta bem-sucedida
422Entrada inválida

GET/v1/rede

Listar as operadoras que atendem um estabelecimento (CNPJ ou CNES).

Respostas
200Resposta bem-sucedida
422Entrada inválida
503Rede hospitalar indisponível.

POST/v1/sadt_catalog

Consultar os campos do catálogo SP/SADT.

Corpo da solicitação
Respostas
200Resposta bem-sucedida
422Entrada inválida

POST/v1/sadt_missing

Identificar campos ausentes em uma guia SP/SADT.

Corpo da solicitação
valuesobjectobrigatório
Respostas
200Resposta bem-sucedida
422Entrada inválida

POST/v1/sandbox/lotes

Enviar um lote à operadora simulada.

Corpo da solicitação
cenarioobjeto
Valores: aprovado, duplicidade, carteirinha_vencida, sem_autorizacao, falha_transitoria, falha_permanente
tentativainteger
xmlstringobrigatório
Respostas
200Resposta bem-sucedida
422Entrada inválida

GET/v1/sandbox/lotes/{protocolo}/demonstrativo

Consultar o demonstrativo de um lote simulado.

Respostas
200Resposta bem-sucedida
422Entrada inválida

POST/v1/tuss_lookup

Consultar um código TUSS.

Corpo da solicitação
codestringobrigatório
datastring
include_expiredboolean
tabelastring
Respostas
200Resposta bem-sucedida
422Entrada inválida

POST/v1/tuss_search

Pesquisar códigos TUSS.

Corpo da solicitação
datastring
include_expiredboolean
limiteinteger
tabelastring
textstringobrigatório
Respostas
200Resposta bem-sucedida
422Entrada inválida

POST/v1/validate

Validar um lote TISS e retornar os achados.

Corpo da solicitação
contextoobject
datastring
loteobject
operadorastring
xmlstring
Respostas
200Resposta bem-sucedida
422Entrada inválida

GET/oauth/client.json

Obter a configuração pública do cliente OAuth.

Respostas
200Resposta bem-sucedida