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
| Nome | Valor |
|---|---|
| accept | application/json |
| content-type | application/json |
🔽 Parâmetros de Entrada
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| emailId | string | Somente quando o tipo do contato utilizado for e-email | Id do contato resultante do consumo do endpoint obter contatos |
| celularId | string | Somente quando o tipo do contato utilizado for celular | Id do contato resultante do consumo do endpoint obter contatos |
| cpf | string | Sim | Cpf do beneficiário dono do contato |
| primeiroAcesso | booleano | Sim | flag 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 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 gerar o protocolo. |