El endpoint GDPR_VERIF verifica el código PIN introducido por el usuario contra el token devuelto por una solicitud GDPR_MSG previa.
Documentación relacionada de SMS Phone Confirmation:
- API - Description - SMS Phone Confirmation - GDPR_MSG
- SMS Phone Confirmation introduction
- SMS Confirmation Swagger documentation
Solicitud GET
Endpoint
https://{SERVER_ADDRESS}/GDPR_VERIF/?Phone={PHONE}&Token={SMS_TOKEN}&Pin={CODE_PIN}
Reemplace los valores entre llaves con su propia información:
| Parámetro | Valor | Descripción | Obligatorio/Opcional |
|---|---|---|---|
| SERVER_ADDRESS | {SERVER_ADDRESS} |
Dirección del servidor DQE que procesará los datos. | Obligatorio |
| Phone | {PHONE} |
Número de teléfono en formato internacional. | Obligatorio |
| Token | {SMS_TOKEN} |
Identificador devuelto por la solicitud GDPR_MSG (campo smsToken). |
Obligatorio |
| Pin | {CODE_PIN} |
Código de verificación de 6 dígitos recibido por el usuario vía SMS. | Obligatorio |
Solicitud POST
Endpoint
https://{SERVER_ADDRESS}/GDPR_VERIF/
Añada los parámetros siguientes en el cuerpo de la solicitud usando x-www-form-urlencoded.
| Parámetro | Valor | Descripción | Obligatorio/Opcional |
|---|---|---|---|
| Phone | {PHONE} |
Número de teléfono en formato internacional. | Obligatorio |
| Token | {SMS_TOKEN} |
Identificador devuelto por la solicitud GDPR_MSG (campo smsToken). |
Obligatorio |
| Pin | {CODE_PIN} |
Código de verificación de 6 dígitos recibido por el usuario vía SMS. | Obligatorio |
Respuesta
Respuesta correcta
| Clave | Descripción | Formato |
|---|---|---|
| status |
OK si el PIN es válido, KO en caso contrario. |
STRING |
| phone | Número de teléfono en formato internacional. | STRING |
| dateTime | Fecha y hora de la verificación. | STRING |
| channels | Canales de comunicación seleccionados. | JSON OBJECT |
| errors | Detalles del error. | JSON OBJECT |
Códigos de error:
| Código | Descripción |
|---|---|
00 |
Sin errores. |
01 |
Faltan parámetros. |
02 |
El PIN debe contener 6 dígitos. |
03 |
PIN caducado. |
04 |
PIN no válido para este token o número de teléfono. |
05 |
Token no válido. |
Ejemplo:
{
"status": "OK",
"phone": "33631525429",
"errors": {
"00": "00 - No errors"
},
"channels": {
"phone": 0,
"post": 0,
"sms": 1,
"email": 1
},
"dateTime": "2019-07-29 11:34:48.998397"
}
Ver también
Relacionada con