Skip to main content

Validar código confirmação

🌐 URLs dos Ambientes

🔹 Homologação

https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/usuario/validar-codigo-confirmacao

🔹 Produção

https://integracao.medsenior.com.br/api/v1/beneficiario/usuario/validar-codigo-confirmacao

📌 Endpoint

POST /api/v1/beneficiario/usuario/validar-codigo-confirmacao

🔐 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
cpfstringSimCpf do beneficiário utilizado no endpoint enviar codigo
codigostringSimcodigo enviado para o e-mail/celular utilizado no enpoint de enviar codigo
  • Exemplo Json de Entrada
{
cpf: {{cpf usado no endpoint de enviar codigo }},
codigo: {{codigo enviado para o e-mail/celular utilizado no enpoint de enviar codigo}}
}

🔄 Exemplo de Requisição

🔹 Ambiente de homologação

curl -X 'POST' \
'https://integracao.hml.cloud.medsenior.com.br/api/v1/beneficiario/usuario/validar-codigo-confirmacao' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json' \
-d '{
cpf: {{cpf usado no endpoint de enviar codigo }},
codigo: {{codigo enviado para o e-mail/celular utilizado no enpoint de enviar codigo}}
}'

🔹 Ambiente de produção

curl -X 'POST' \
'https://integracao.medsenior.com.br/api/v1/beneficiario/usuario/validar-codigo-confirmacao' \
-H 'accept: application/json' \
-H 'authorization: Bearer TOKEN_GERADO_NA_AUTENTICACAO' \
-H 'content-type: application/json' \
-d '{
cpf: {{cpf usado no endpoint de gerar codigo}},
codigo: {{codigo enviado para o e-mail/celular utilizado no enpoint de enviar codigo}}
}'

✅ Resposta de Sucesso

  • Status Code: 200 OK
  • Exemplo de Resposta:
{
"data": {
"codigoValidado": true,
"codigoExpirado": false
},
"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.