1. Contas
Arvo - APIs Externas
  • Contas
    • API - Contas
      POST
    • Webhook - Análise
      POST
    • API - Feedback
      POST
    • API - Autorizacao
      POST
    • API - Gen Upload URL
      POST
    • Data Layout
      VIEW
  • Esquemas
    • Autorizacao - API
      • Response 4xx
      • Request Body
      • Response 201
    • Contas - API
      • Request Body
      • Request Body - Dereferenced
      • Response 4xx
      • Response 201
    • Contas - Webhook
      • Request Body
    • Feedback - API
      • Request Body
    • Contas - Schemas
      • dadosEnvio
      • dadosGuia
      • dadosInternacao
      • dadosAtendimento
      • dadosSolicitacao
      • dadosAutorizacao
      • dadosAutorizacao_itens
      • dadosSolicitante
      • dadosSolicitante_dadosContratado
      • dadosSolicitante_profissionalSolicitante
      • dadosSolicitante_profissionalSolicitante_conselhoProfissional
      • dadosExecutante
      • dadosExecutante_profissionalExecutante
      • dadosBeneficiario
      • item
      • dataLayout
      • dataLayout - Dereferenced
      • dataLayout_dadosSolicitante
      • dataLayout_dadosExecutante
      • dataLayout_dadosBeneficiario
      • dataLayout_item
      • dataLayout_dadosAutorizacao
  1. Contas

Webhook - Análise

POST
{URL_CLIENTE}
Envia o resultado da análise das contas enviadas através da rota de contas. Essa API deve ser implementada pela operadora.
A autenticação é feita através de HMAC da seguinte forma:
1.
A Arvo fornece uma API Key (chave pública) e um Secret Key chave privada
2.
O cliente deve passar no request 3 headers:
a. X-API-Key - deve ser a API Key fornecida
b. X-Timestamp - UNIX timestamp do momento em que a requisição é disparada
c. X-Signature - base64 encoded de HMAC (usando sha256) bytes[API Key + timestamp + identificadorEnvio]. Será utilizado o identificadorEnvio do primeiro elemento do array de resposta.
3.
No servidor, iremos assinar a requisição de forma análoga e verificar se o timestamp está no intervalo de 10 minutos (caso tenha passado, a autenticação irá falhar)

Requisição

Parâmetros de Caminho

Parâmetros Bodyapplication/json

Exemplo
[
    {
        "dadosEnvio": {
            "identificadorEnvio": "in do adipisicing labore sint",
            "nomeOperadora": "sunt laborum non Ut amet"
        },
        "dadosGuia": {
            "identificadorGuia": "anim cupidatat sed ea Duis",
            "numeroLote": "76",
            "numeroGuia": "23",
            "dataPagamento": "yyyy-MM-ddTHH:MM:ss"
        },
        "glosaArvo": {
            "agente": "in",
            "justificativa": "adipisicing mollit tempor",
            "valorGlosado": 51332596.06907737,
            "quantidadeGlosada": -16188719.770512834,
            "glosaAns": {
                "motivo": "proident in ad",
                "tipo": "aute"
            },
            "categoriaAnalise": "AUT"
        },
        "itens": [
            {
                "idArvo": "sunt",
                "identificadorItem": "velit sunt",
                "categoria": "TERAPIA",
                "sequencialItem": 18114075,
                "codigo": "in nisi elit",
                "codigoTabela": null,
                "identificadorPacote": null,
                "descricao": null,
                "viaAcesso": "MESMA VIA",
                "grauParticipacao": "PRIMEIRO AUXILIAR",
                "glosaArvo": {
                    "agente": "tempor et sit anim",
                    "justificativa": "Duis velit cupidatat",
                    "valorGlosado": 65219443.036515504,
                    "quantidadeGlosada": -49982304,
                    "glosaAns": {
                        "motivo": "minim enim ullamco",
                        "tipo": "eu dolor consectetur ipsum"
                    },
                    "categoriaAnalise": "AUT"
                },
                "identificadorExecutante": "sunt culpa",
                "senhaAutorizacao": null
            },
            {
                "idArvo": "mollit ad id aute adipisicing",
                "identificadorItem": null,
                "categoria": "EXAME",
                "sequencialItem": null,
                "codigo": "sint reprehenderit proident",
                "codigoTabela": "proident quis in nulla",
                "identificadorPacote": "nulla veniam id in mollit",
                "descricao": null,
                "viaAcesso": "MESMA VIA",
                "grauParticipacao": "PEDIATRA NA SALA DE PARTO",
                "glosaArvo": null,
                "identificadorExecutante": null,
                "senhaAutorizacao": null
            }
        ],
        "dadosExecutante": null
    },
    {
        "dadosEnvio": {
            "identificadorEnvio": "deserunt est adipisicing",
            "nomeOperadora": "voluptate exercitation cillum"
        },
        "dadosGuia": {
            "identificadorGuia": "pariatur eu consectetur id in",
            "numeroLote": "31",
            "numeroGuia": "30",
            "dataPagamento": "yyyy-MM-ddTHH:MM:ss"
        },
        "glosaArvo": null,
        "itens": [
            {
                "idArvo": "voluptate sed reprehenderit dolor",
                "identificadorItem": null,
                "categoria": "TAXA",
                "sequencialItem": 18810091,
                "codigo": "Excepteur labore enim",
                "codigoTabela": null,
                "identificadorPacote": null,
                "descricao": "amet nulla ut",
                "viaAcesso": "UNICA",
                "grauParticipacao": "ANESTESISTA",
                "glosaArvo": null,
                "identificadorExecutante": "cillum pariatur aute",
                "senhaAutorizacao": "in exercitation tempor Ut proident"
            },
            {
                "idArvo": "exercitation ipsum pariatur",
                "identificadorItem": "enim irure anim labore deserunt",
                "categoria": "TAXA",
                "sequencialItem": null,
                "codigo": null,
                "codigoTabela": null,
                "identificadorPacote": "laboris labore nisi",
                "descricao": null,
                "viaAcesso": "MESMA VIA",
                "grauParticipacao": "QUARTO AUXILIAR",
                "glosaArvo": {
                    "agente": "velit ut occaecat non irure",
                    "justificativa": "culpa Ut",
                    "valorGlosado": -17566653.515558213,
                    "quantidadeGlosada": 62976864,
                    "glosaAns": {
                        "motivo": "minim",
                        "tipo": "et nostrud"
                    },
                    "categoriaAnalise": "ADM"
                },
                "identificadorExecutante": "non",
                "senhaAutorizacao": null
            },
            {
                "idArvo": "dolore ut reprehenderit",
                "identificadorItem": "dolore",
                "categoria": "MEDICAMENTO",
                "sequencialItem": null,
                "codigo": "in",
                "codigoTabela": "eu",
                "identificadorPacote": "anim eu",
                "descricao": "laboris Ut ullamco dolor",
                "viaAcesso": "MESMA VIA",
                "grauParticipacao": "CLINICO",
                "glosaArvo": {
                    "agente": "nisi sit dolore",
                    "justificativa": "sed adipisicing et in",
                    "valorGlosado": -85487378.33393809,
                    "quantidadeGlosada": -1978365,
                    "glosaAns": {
                        "motivo": "sint do",
                        "tipo": "ut anim dolore fugiat"
                    },
                    "categoriaAnalise": "MAN"
                },
                "identificadorExecutante": null,
                "senhaAutorizacao": "laborum enim pariatur do"
            }
        ],
        "dadosExecutante": {
            "identificadorExecutante": "ipsum"
        }
    },
    {
        "dadosEnvio": {
            "identificadorEnvio": "voluptate officia in adipisicing est",
            "nomeOperadora": "exercitation Duis qui do id"
        },
        "dadosGuia": {
            "identificadorGuia": "consequat et cillum non aliquip",
            "numeroLote": "33",
            "numeroGuia": "57",
            "dataPagamento": "yyyy-MM-ddTHH:MM:ss"
        },
        "glosaArvo": null,
        "itens": [
            {
                "idArvo": "consequat id sit culpa",
                "identificadorItem": "ea commodo ad",
                "categoria": "PACOTE",
                "sequencialItem": 30922516,
                "codigo": null,
                "codigoTabela": null,
                "identificadorPacote": null,
                "descricao": null,
                "viaAcesso": "DIFERENTES VIAS",
                "grauParticipacao": "INTENSIVISTA",
                "glosaArvo": null,
                "identificadorExecutante": "in non proident Excepteur",
                "senhaAutorizacao": "ipsum ut nostrud mollit"
            },
            {
                "idArvo": "dolor irure deserunt quis",
                "identificadorItem": "cupidatat non est",
                "categoria": "REMOCAO",
                "sequencialItem": null,
                "codigo": null,
                "codigoTabela": "aliquip nulla nostrud exercitation",
                "identificadorPacote": "exercitation eiusmod velit nostrud adipisicing",
                "descricao": "laboris in cupidatat",
                "viaAcesso": "MESMA VIA",
                "grauParticipacao": "QUARTO AUXILIAR",
                "glosaArvo": null,
                "identificadorExecutante": null,
                "senhaAutorizacao": null
            }
        ],
        "dadosExecutante": {
            "identificadorExecutante": "occaecat nulla quis deserunt ex"
        }
    }
]

Códigos de solicitação

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location '' \
--header 'Content-Type: application/json' \
--data '[
    {
        "dadosEnvio": {
            "identificadorEnvio": "in do adipisicing labore sint",
            "nomeOperadora": "sunt laborum non Ut amet"
        },
        "dadosGuia": {
            "identificadorGuia": "anim cupidatat sed ea Duis",
            "numeroLote": "76",
            "numeroGuia": "23",
            "dataPagamento": "yyyy-MM-ddTHH:MM:ss"
        },
        "glosaArvo": {
            "agente": "in",
            "justificativa": "adipisicing mollit tempor",
            "valorGlosado": 51332596.06907737,
            "quantidadeGlosada": -16188719.770512834,
            "glosaAns": {
                "motivo": "proident in ad",
                "tipo": "aute"
            },
            "categoriaAnalise": "AUT"
        },
        "itens": [
            {
                "idArvo": "sunt",
                "identificadorItem": "velit sunt",
                "categoria": "TERAPIA",
                "sequencialItem": 18114075,
                "codigo": "in nisi elit",
                "codigoTabela": null,
                "identificadorPacote": null,
                "descricao": null,
                "viaAcesso": "MESMA VIA",
                "grauParticipacao": "PRIMEIRO AUXILIAR",
                "glosaArvo": {
                    "agente": "tempor et sit anim",
                    "justificativa": "Duis velit cupidatat",
                    "valorGlosado": 65219443.036515504,
                    "quantidadeGlosada": -49982304,
                    "glosaAns": {
                        "motivo": "minim enim ullamco",
                        "tipo": "eu dolor consectetur ipsum"
                    },
                    "categoriaAnalise": "AUT"
                },
                "identificadorExecutante": "sunt culpa",
                "senhaAutorizacao": null
            },
            {
                "idArvo": "mollit ad id aute adipisicing",
                "identificadorItem": null,
                "categoria": "EXAME",
                "sequencialItem": null,
                "codigo": "sint reprehenderit proident",
                "codigoTabela": "proident quis in nulla",
                "identificadorPacote": "nulla veniam id in mollit",
                "descricao": null,
                "viaAcesso": "MESMA VIA",
                "grauParticipacao": "PEDIATRA NA SALA DE PARTO",
                "glosaArvo": null,
                "identificadorExecutante": null,
                "senhaAutorizacao": null
            }
        ],
        "dadosExecutante": null
    },
    {
        "dadosEnvio": {
            "identificadorEnvio": "deserunt est adipisicing",
            "nomeOperadora": "voluptate exercitation cillum"
        },
        "dadosGuia": {
            "identificadorGuia": "pariatur eu consectetur id in",
            "numeroLote": "31",
            "numeroGuia": "30",
            "dataPagamento": "yyyy-MM-ddTHH:MM:ss"
        },
        "glosaArvo": null,
        "itens": [
            {
                "idArvo": "voluptate sed reprehenderit dolor",
                "identificadorItem": null,
                "categoria": "TAXA",
                "sequencialItem": 18810091,
                "codigo": "Excepteur labore enim",
                "codigoTabela": null,
                "identificadorPacote": null,
                "descricao": "amet nulla ut",
                "viaAcesso": "UNICA",
                "grauParticipacao": "ANESTESISTA",
                "glosaArvo": null,
                "identificadorExecutante": "cillum pariatur aute",
                "senhaAutorizacao": "in exercitation tempor Ut proident"
            },
            {
                "idArvo": "exercitation ipsum pariatur",
                "identificadorItem": "enim irure anim labore deserunt",
                "categoria": "TAXA",
                "sequencialItem": null,
                "codigo": null,
                "codigoTabela": null,
                "identificadorPacote": "laboris labore nisi",
                "descricao": null,
                "viaAcesso": "MESMA VIA",
                "grauParticipacao": "QUARTO AUXILIAR",
                "glosaArvo": {
                    "agente": "velit ut occaecat non irure",
                    "justificativa": "culpa Ut",
                    "valorGlosado": -17566653.515558213,
                    "quantidadeGlosada": 62976864,
                    "glosaAns": {
                        "motivo": "minim",
                        "tipo": "et nostrud"
                    },
                    "categoriaAnalise": "ADM"
                },
                "identificadorExecutante": "non",
                "senhaAutorizacao": null
            },
            {
                "idArvo": "dolore ut reprehenderit",
                "identificadorItem": "dolore",
                "categoria": "MEDICAMENTO",
                "sequencialItem": null,
                "codigo": "in",
                "codigoTabela": "eu",
                "identificadorPacote": "anim eu",
                "descricao": "laboris Ut ullamco dolor",
                "viaAcesso": "MESMA VIA",
                "grauParticipacao": "CLINICO",
                "glosaArvo": {
                    "agente": "nisi sit dolore",
                    "justificativa": "sed adipisicing et in",
                    "valorGlosado": -85487378.33393809,
                    "quantidadeGlosada": -1978365,
                    "glosaAns": {
                        "motivo": "sint do",
                        "tipo": "ut anim dolore fugiat"
                    },
                    "categoriaAnalise": "MAN"
                },
                "identificadorExecutante": null,
                "senhaAutorizacao": "laborum enim pariatur do"
            }
        ],
        "dadosExecutante": {
            "identificadorExecutante": "ipsum"
        }
    },
    {
        "dadosEnvio": {
            "identificadorEnvio": "voluptate officia in adipisicing est",
            "nomeOperadora": "exercitation Duis qui do id"
        },
        "dadosGuia": {
            "identificadorGuia": "consequat et cillum non aliquip",
            "numeroLote": "33",
            "numeroGuia": "57",
            "dataPagamento": "yyyy-MM-ddTHH:MM:ss"
        },
        "glosaArvo": null,
        "itens": [
            {
                "idArvo": "consequat id sit culpa",
                "identificadorItem": "ea commodo ad",
                "categoria": "PACOTE",
                "sequencialItem": 30922516,
                "codigo": null,
                "codigoTabela": null,
                "identificadorPacote": null,
                "descricao": null,
                "viaAcesso": "DIFERENTES VIAS",
                "grauParticipacao": "INTENSIVISTA",
                "glosaArvo": null,
                "identificadorExecutante": "in non proident Excepteur",
                "senhaAutorizacao": "ipsum ut nostrud mollit"
            },
            {
                "idArvo": "dolor irure deserunt quis",
                "identificadorItem": "cupidatat non est",
                "categoria": "REMOCAO",
                "sequencialItem": null,
                "codigo": null,
                "codigoTabela": "aliquip nulla nostrud exercitation",
                "identificadorPacote": "exercitation eiusmod velit nostrud adipisicing",
                "descricao": "laboris in cupidatat",
                "viaAcesso": "MESMA VIA",
                "grauParticipacao": "QUARTO AUXILIAR",
                "glosaArvo": null,
                "identificadorExecutante": null,
                "senhaAutorizacao": null
            }
        ],
        "dadosExecutante": {
            "identificadorExecutante": "occaecat nulla quis deserunt ex"
        }
    }
]'

Respostas

🟢201Criado
application/json
Contas médicas com apontamentos recebidas com sucesso
Bodyapplication/json

Exemplo
{}
🟠400Pedido inválido
🔴500Erro do servidor
Modificado em 2026-05-14 14:42:22
Página anterior
API - Contas
Próxima página
API - Feedback
Built with