Arvo - APIs Externas
  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
  1. Contas

API - Contas

POST
/claims
Endpoint para recever as contas médicas que serão analisadas pelas inteligências da ARVO.
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]
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 Header

Parâmetros Bodyapplication/json

Exemplo
{
    "dadosEnvio": {
        "identificadorEnvio": "string",
        "nomeOperadora": "string"
    },
    "guias": [
        {
            "dadosGuia": {
                "identificadorGuia": "string",
                "numeroLote": "string",
                "numeroGuia": "string",
                "numeroGuiaPrincipal": "string",
                "numeroGuiaPrestador": "string",
                "tipoGuia": "SADT",
                "dataRegistro": "2019-08-24T14:15:22Z",
                "dataPagamento": "2019-08-24T14:15:22Z",
                "tipoIntercambio": "ORIGEM",
                "tipoRede": "PROPRIA",
                "regraIntercambio": "NACIONAL"
            },
            "dadosInternacao": {
                "regimeInternacao": "HOSPITALAR",
                "dataInternacao": "2019-08-24T14:15:22Z",
                "dataAlta": "2019-08-24T14:15:22Z"
            },
            "dadosAtendimento": {
                "identificadorAtendimento": "string",
                "tipoAtendimento": "REMOCAO",
                "indicadorAcidente": "S",
                "tipoConsulta": "PRIMEIRA | SEGUIMENTO | PRE-NATAL",
                "regimeAtendimento": "AMBULATORIAL",
                "saudeOcupacional": "ADMISSIONAL",
                "motivoEncerramento": "string"
            },
            "dadosSolicitacao": {
                "dataSolicitacao": "2019-08-24T14:15:22Z",
                "caraterAtendimento": "ELETIVO",
                "indicacaoClinica": "string",
                "indicadorCoberturaEspecial": "S"
            },
            "dadosAutorizacao": {
                "dataAutorizacao": "2019-08-24T14:15:22Z",
                "senhaAutorizacao": "string",
                "statusSenha": "AUTORIZADO",
                "tipoAutorizacao": "MANUAL"
            },
            "dadosSolicitante": {
                "dadosContratado": {
                    "identificador": "CNPJ do contratado | CPF do contratado | Código do contratado na operadora",
                    "nome": "string"
                },
                "profissionalSolicitante": {
                    "nome": "string",
                    "cbo": "string",
                    "conselhoProfissional": {
                        "numero": "string",
                        "conselho": "CRESS",
                        "uf": "RO"
                    }
                }
            },
            "dadosExecutante": {
                "identificador": "CNPJ do contratado | CPF do contratado | Código do contratado na operadora",
                "cnpj": "string",
                "cnes": "string",
                "nome": "string",
                "profissionalExecutante": {
                    "nome": "string",
                    "cbo": "string",
                    "conselhoProfissional": {
                        "numero": "string",
                        "conselho": "CRESS",
                        "uf": "RO"
                    }
                }
            },
            "dadosBeneficiario": {
                "identificador": "CPF | Número carteirinha | Código anonimizado pela operadora",
                "dataNascimento": "2019-08-24T14:15:22Z",
                "genero": "MASCULINO",
                "indicadorRecemNascido": "S",
                "idade": 0
            },
            "itens": [
                {
                    "identificadorItem": "string",
                    "glosaPrestador": "S",
                    "sequencialItem": 0,
                    "codigo": "string",
                    "codigoTabela": "string",
                    "identificadorPacote": "string",
                    "descricao": "string",
                    "codigoCid": "string",
                    "viaAcesso": "UNICA",
                    "tecnicaUtilizada": "CONVENCIONAL",
                    "quantidadeExecutada": 0,
                    "quantidadePaga": 0,
                    "quantidadeGlosada": 0,
                    "unidadeMedida": "string",
                    "glosa": {
                        "motivo": "string",
                        "tipo": "string"
                    },
                    "indicadorLiminar": "S",
                    "indicadorOpme": "S",
                    "indicadorQuimioterapia": "S",
                    "indicadorRadioterapia": "S",
                    "valorUnitario": 0,
                    "valorTotal": 0,
                    "valorPago": 0,
                    "valorGlosado": 0,
                    "dataExecucao": "2019-08-24T14:15:22Z",
                    "horaInicial": "14:15:22Z",
                    "horaFinal": "14:15:22Z",
                    "categoria": "DIARIA",
                    "subcategoriaSADT": "UCO",
                    "grauParticipacao": "CIRURGIAO",
                    "dataAutorizacao": "2019-08-24T14:15:22Z",
                    "quantidadeSolicitadaAutorizacao": 0,
                    "quantidadeAutorizada": 0,
                    "statusAutorizacao": "string"
                }
            ]
        }
    ]
}

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 --request POST '/claims' \
--header 'X-API-Key: public_key' \
--header 'X-Signature: b64(HMAC(public_key + timestamp + identificadorEnvio))' \
--header 'X-Timestamp: 1763477090' \
--header 'Content-Type: application/json' \
--data-raw '{
    "dadosEnvio": {
        "identificadorEnvio": "string",
        "nomeOperadora": "string"
    },
    "guias": [
        {
            "dadosGuia": {
                "identificadorGuia": "string",
                "numeroLote": "string",
                "numeroGuia": "string",
                "numeroGuiaPrincipal": "string",
                "numeroGuiaPrestador": "string",
                "tipoGuia": "SADT",
                "dataRegistro": "2019-08-24T14:15:22Z",
                "dataPagamento": "2019-08-24T14:15:22Z",
                "tipoIntercambio": "ORIGEM",
                "tipoRede": "PROPRIA",
                "regraIntercambio": "NACIONAL"
            },
            "dadosInternacao": {
                "regimeInternacao": "HOSPITALAR",
                "dataInternacao": "2019-08-24T14:15:22Z",
                "dataAlta": "2019-08-24T14:15:22Z"
            },
            "dadosAtendimento": {
                "identificadorAtendimento": "string",
                "tipoAtendimento": "REMOCAO",
                "indicadorAcidente": "S",
                "tipoConsulta": "PRIMEIRA | SEGUIMENTO | PRE-NATAL",
                "regimeAtendimento": "AMBULATORIAL",
                "saudeOcupacional": "ADMISSIONAL",
                "motivoEncerramento": "string"
            },
            "dadosSolicitacao": {
                "dataSolicitacao": "2019-08-24T14:15:22Z",
                "caraterAtendimento": "ELETIVO",
                "indicacaoClinica": "string",
                "indicadorCoberturaEspecial": "S"
            },
            "dadosAutorizacao": {
                "dataAutorizacao": "2019-08-24T14:15:22Z",
                "senhaAutorizacao": "string",
                "statusSenha": "AUTORIZADO",
                "tipoAutorizacao": "MANUAL"
            },
            "dadosSolicitante": {
                "dadosContratado": {
                    "identificador": "CNPJ do contratado | CPF do contratado | Código do contratado na operadora",
                    "nome": "string"
                },
                "profissionalSolicitante": {
                    "nome": "string",
                    "cbo": "string",
                    "conselhoProfissional": {
                        "numero": "string",
                        "conselho": "CRESS",
                        "uf": "RO"
                    }
                }
            },
            "dadosExecutante": {
                "identificador": "CNPJ do contratado | CPF do contratado | Código do contratado na operadora",
                "cnpj": "string",
                "cnes": "string",
                "nome": "string",
                "profissionalExecutante": {
                    "nome": "string",
                    "cbo": "string",
                    "conselhoProfissional": {
                        "numero": "string",
                        "conselho": "CRESS",
                        "uf": "RO"
                    }
                }
            },
            "dadosBeneficiario": {
                "identificador": "CPF | Número carteirinha | Código anonimizado pela operadora",
                "dataNascimento": "2019-08-24T14:15:22Z",
                "genero": "MASCULINO",
                "indicadorRecemNascido": "S",
                "idade": 0
            },
            "itens": [
                {
                    "identificadorItem": "string",
                    "glosaPrestador": "S",
                    "sequencialItem": 0,
                    "codigo": "string",
                    "codigoTabela": "string",
                    "identificadorPacote": "string",
                    "descricao": "string",
                    "codigoCid": "string",
                    "viaAcesso": "UNICA",
                    "tecnicaUtilizada": "CONVENCIONAL",
                    "quantidadeExecutada": 0,
                    "quantidadePaga": 0,
                    "quantidadeGlosada": 0,
                    "unidadeMedida": "string",
                    "glosa": {
                        "motivo": "string",
                        "tipo": "string"
                    },
                    "indicadorLiminar": "S",
                    "indicadorOpme": "S",
                    "indicadorQuimioterapia": "S",
                    "indicadorRadioterapia": "S",
                    "valorUnitario": 0,
                    "valorTotal": 0,
                    "valorPago": 0,
                    "valorGlosado": 0,
                    "dataExecucao": "2019-08-24T14:15:22Z",
                    "horaInicial": "14:15:22Z",
                    "horaFinal": "14:15:22Z",
                    "categoria": "DIARIA",
                    "subcategoriaSADT": "UCO",
                    "grauParticipacao": "CIRURGIAO",
                    "dataAutorizacao": "2019-08-24T14:15:22Z",
                    "quantidadeSolicitadaAutorizacao": 0,
                    "quantidadeAutorizada": 0,
                    "statusAutorizacao": "string"
                }
            ]
        }
    ]
}'

Respostas

🟢201Criado
application/json
Claims successfuly received
Body

Exemplo
{
    "message": "string",
    "received_at": "2019-08-24T14:15:22Z"
}
🟠400Pedido inválido
🟠422Erro de parâmetro
🔴500Erro do servidor
Modificado em 2025-11-18 16:38:02
Próxima página
Webhook - Análise
Built with