Verificar Código OTP

OTP.VerifyCodeOperation

Descripción

Verifica el código OTP ingresado por el usuario. Valida el código contra el almacenado en el sistema de seguridad usando el Identifier, el destinatario y el tipo de OTP.

Propiedad Valor
Operation Name
OTP.VerifyCodeOperation
Método HTTP
POST
Content-Type
application/json

Request — OTPVerificationCodeRequestDTO

Parámetros del cuerpo de la solicitud:

Campo Tipo Requerido Descripción
Identifier
 string No
Identificador del código OTP retornado por OTP.GenerateCodeOperation o OTP.SendOperation
To
 string No
Número de teléfono o correo electrónico del destinatario original
Code
 string Sí
Código OTP de 6 dígitos ingresado por el usuario
Type
 OTPType No
Tipo del código OTP. Default: "Authentication". Debe coincidir con el generado

Ejemplo de Request

Payload (solo para serialización)
Payload — OTP.VerifyCodeOperation 
{
  "Identifier": "x9z8y7w6-otp-secure-id",
  "To": "573001234567",
  "Code": "482917",
  "Type": "Authentication"
}
Request completo
Request completo — OTP.VerifyCodeOperation 
{
  "Data": {
    "Token": {
      "Id": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
    },
    "Operation": {
      "Version": "1.0",
      "Name": "OTP.VerifyCodeOperation",
      "Payload": "{\"Identifier\":\"x9z8y7w6-otp-secure-id\",\"To\":\"573001234567\",\"Code\":\"482917\",\"Type\":\"Authentication\"}"
    }
  }
}

Response — OTPVerificationCodeResponseDTO

El servicio retorna la siguiente estructura de respuesta:

Campo Tipo Descripción
Successful
 bool
true si el código es válido y no ha expirado
Status
 string
Estado de la verificación reportado por el sistema de seguridad:
  • Verified: Código válido y verificado correctamente.
  • Active: Código activo, aún pendiente de validar.
  • Expired: El código ya expiró.
  • Invalid: El código es incorrecto o no existe.
Code
 string
Código OTP verificado retornado por el sistema de seguridad
Message
 string
Mensaje de error o informativo. Posibles valores:
  • The OTP Code is expired.
  • Error in OTP Validation.
  • The OTP Code has already been processed.
ErrorCode
 string
Código de error en caso de excepción
ExceptionMessage
 string
Detalle técnico de la excepción
UserMessage
 string
Mensaje para el usuario final en caso de error

Ejemplos de Response

Response exitoso
Response exitoso 
{
  "Successful": true,
  "Status": "Verified",
  "Code": "482917",
  "Message": null,
  "ErrorCode": null,
  "ExceptionMessage": null,
  "UserMessage": null
}
Response con código incorrecto o expirado
Response con error de verificación 
{
  "Successful": false,
  "Status": "Invalid",
  "Code": null,
  "Message": "El código ingresado no es válido o ha expirado.",
  "ErrorCode": null,
  "ExceptionMessage": null,
  "UserMessage": null
}