Pular para o conteúdo principal

Enviar código confirmação

🌐 URLs dos Ambientes

🔹 Homologação

https://integracao.hml.cloud.medsenior.com.br/api/v2/beneficiario/{{cpfBeneficiario}}/codigo-confirmacao/enviar

🔹 Produção

https://integracao.medsenior.com.br/api/v2/beneficiario/{{cpfBeneficiario}}/codigo-confirmacao/enviar

📌 Endpoint

POST /api/v2/beneficiario/{{cpfBeneficiario}}/codigo-confirmacao/enviar

🔐 Autenticação

Este endpoint requer um token de autorização.

Authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO

🔽 Cabeçalhos

NomeValor
acceptapplication/json
content-typeapplication/json

🔽 Parâmetros de Entrada

NomeTipoObrigatórioDescrição
emailIdstringSomente quando o tipo do contato utilizado for e-emailId do contato resultante do consumo do endpoint obter contatos
celularIdstringSomente quando o tipo do contato utilizado for celularId do contato resultante do consumo do endpoint obter contatos
cpfstringSimCpf do beneficiário dono do contato
primeiroAcessobooleanoSimflag primeiro acesso resultante do consumo da api validar beneficiario
  • Exemplo Json de Entrada
{
"emailId": "bed1066b-d8b5-47bc-a67f-2fd70a3c442d",
"celularId": "1163cc70-cdf5-4cbb-95d7-9ae7457046fc",
"cpf": "12345678901",
"primeiroAcesso": false
}

🔄 Exemplo de Requisição

🔹 Ambiente de homologação

curl -X 'POST' \
'https://integracao.hml.cloud.medsenior.com.br/api/v2/beneficiario/{{cpfBeneficiario}}/codigo-confirmacao/enviar' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json' \
-d '{
"emailId": "bed1066b-d8b5-47bc-a67f-2fd70a3c442d",
"cpf": "12345678901",
"primeiroAcesso": false
}'

🔹 Ambiente de produção

curl -X 'POST' \
'https://integracao.medsenior.com.br/api/v2/beneficiario/{{cpfBeneficiario}}/codigo-confirmacao/enviar' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json' \
-d '{
"celularId": "1163cc70-cdf5-4cbb-95d7-9ae7457046fc",
"cpf": "12345678901",
"primeiroAcesso": false
}'

✅ Resposta de Sucesso

  • Status Code: 200 OK
  • Exemplo de Resposta:
{
"data": {
"tempoExpiracaoCodigoValidacaoEmSegundos": 299.9998772
},
"isSuccess": true
}

❌ Códigos de Erro

Status CodeSignificadoDescrição
400Bad RequestParâmetros inválidos ou ausentes.
401UnauthorizedFalha na autenticação do token.
500Server ErrorErro interno ao gerar o protocolo.