Obter dados

🌐 URLs dos Ambientes

🔹 Homologação

https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/integracao/dados-beneficiario/{{cpf_beneficiario}}

🔹 Produção

https://integracao.medsenior.com.br/api/v1/beneficiario/integracao/dados-beneficiario/{{cpf_beneficiario}}

📌 Endpoint

GET /api/v1/beneficiario/integracao/dados-beneficiario/{{cpf_beneficiario}}

🔐 Autenticação

Este endpoint requer um token de autorização.

Authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO

🔽 Cabeçalhos

Nome	Valor
accept	application/json
content-type	application/json

🔽 Parâmetros de Entrada

Nome	Tipo	Obrigatório	Descrição
cpfBenficiario	string	Sim	Parametro a ser enviado junto à url

🔄 Exemplo de Requisição

🔹 Ambiente de homologação

curl -X 'GET' \
'https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/integracao/dados-beneficiario/{{cpf_beneficiario}}' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json' 

🔹 Ambiente de produção

curl -X 'GET' \
'https://integracao.medsenior.com.br/api/v1/beneficiario/integracao/buscar/dados-beneficiario/{{cpf_beneficiario}}' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json'

✅ Resposta de Sucesso

• Status Code: 200 OK
• Exemplo de Resposta:

{
  "data": {
    "matricula": "NÚMERO_DE_MATRÍCULA_DO_BENEFICIÁRIO",                            // Número de matrícula do beneficiário
    "nome": "NOME_COMPLETO_DO_BENEFICIÁRIO",                                       // Nome completo do beneficiário
    "cpf": "CPF_DO_BENEFICIÁRIO",                                                  // CPF do beneficiário (somente números)
    "nascimento": "DATA_DE_NASCIMENTO_DD/MM/AAAA",                                 // Data de nascimento no formato dd/MM/yyyy
    "celular": "CELULAR_COM_DDD",                                                  // Número de celular com DDD
    "email": "EMAIL_DO_BENEFICIÁRIO",                                              // Endereço de e-mail do beneficiário
    "situacao": "SITUAÇÃO_DO_BENEFICIÁRIO",                                        // Situação atual do beneficiário (ex: Ativo, Inativo)
    "plano": "NOME_DO_PLANO_DE_SAÚDE",                                             // Nome do plano de saúde
    "idPlano": "IDENTIFICADOR_INTERNO_DO_PLANO",                                   // Identificador interno do plano
    "tipo": "TIPO_DE_VÍNCULO_COM_O_PLANO",                                         // Tipo de vínculo com o plano (ex: Titular, Dependente)
    "dataAdesao": "DATA_DE_ADESÃO_AO_PLANO",                                       // Data de adesão ao plano
    "acomodacao": "TIPO_DE_ACOMODAÇÃO",                                            // Tipo de acomodação contratada (ex: APARTAMENTO, ENFERMARIA)
    "registroANS": "REGISTRO_DA_OPERADORA_NA_ANS",                                 // Registro da operadora na ANS
    "uf": "UF_DO_ENDEREÇO",                                                        // Unidade federativa (estado)
    "cidade": "CIDADE_DO_BENEFICIÁRIO",                                            // Cidade de residência do beneficiário
    "logradouro": "NOME_DA_RUA_OU_AVENIDA",                                        // Nome da rua/avenida
    "numeroResidencia": "NÚMERO_DA_RESIDÊNCIA",                                    // Número da residência
    "cep": "CEP_DO_ENDEREÇO",                                                      // CEP do endereço (somente números)
    "bairro": "BAIRRO_DO_ENDEREÇO",                                                // Bairro do endereço
    "cartaoSus": "NÚMERO_DO_CARTÃO_SUS",                                           // Número do Cartão Nacional de Saúde (SUS)
    "segmentacaoAssistencial": "TIPO_DE_SEGMENTAÇÃO_ASSISTENCIAL",                // Segmentação assistencial do plano (ex: Ambulatorial, Hospitalar)
    "abrangencia": "ABRANGÊNCIA_GEOGRÁFICA_DO_PLANO",                              // Abrangência geográfica do plano (ex: Grupo de Municípios, Nacional)
    "numeroContrato": "NÚMERO_DO_CONTRATO_DO_PLANO",                               // Número do contrato do plano
    "registroPlanoANS": "REGISTRO_DO_PLANO_NA_ANS",                                // Número do registro do plano na ANS
    "quantidadeNotificacoesNaoLidas": 0,                                           // Número de notificações não lidas pelo beneficiário
    "tipoContrato": "TIPO_DE_CONTRATO",                                            // Tipo de contrato (pode estar em branco)
    "termosPendentes": [
      {
        "id": "ID_DO_TERMO_1",                                                     // Identificador único do termo
        "titulo": "TÍTULO_DO_TERMO_1",                                             // Título do termo pendente
        "conteudo": "TEXTO_COMPLETO_DO_TERMO_1",                                   // Texto completo do termo com cláusulas
        "enderecoArquivo": "URL_DO_TERMO_1_PDF"                                    // URL para visualizar/baixar o termo
      },
      {
        "id": "ID_DO_TERMO_2",                                                     // Identificador único de outro termo
        "titulo": "TÍTULO_DO_TERMO_2",                                             // Título de outro termo (LGPD, consentimento)
        "conteudo": "TEXTO_DO_TERMO_2",                                            // Texto explicativo com cláusulas e consentimentos
        "enderecoArquivo": "URL_DO_TERMO_2_PDF"                                    // Link para acesso ao termo em PDF
      }
    ]
  },
  "success": true,
  "failure": false,
  "messages": []
}

❌ Códigos de Erro

Status Code	Significado	Descrição
400	Bad Request	Parâmetros inválidos ou ausentes.
401	Unauthorized	Falha na autenticação do token.
500	Server Error	Erro interno ao obter o beneficiário