Generar Código OTP

OTP.GenerateCodeOperation

Descripción

Genera un código OTP para un destinatario y lo almacena en el sistema de seguridad. No envía el código al usuario; solo lo genera y lo retorna. Útil cuando el envío se gestiona por canal propio.

Propiedad Valor
Operation Name
OTP.GenerateCodeOperation
Método HTTP
POST
Content-Type
application/json
Nota: Esta operación únicamente genera y almacena el código. Para enviarlo al usuario usa tu propio canal de comunicación o utiliza OTP.SendOperation.

Request — OTPGenerateCodeRequestDTO

Parámetros del cuerpo de la solicitud:

Campo Tipo Requerido Descripción
To
 string Sí
Número de teléfono o correo electrónico del destinatario
Type
 OTPType No
Tipo del código OTP. Default: "Authentication"

Ejemplo de Request

Payload (solo para propósitos de serialización)
Payload JSON 
{
    "To": "573001234567",
    "Type": "Authentication"
}
Request completo
Request JSON 
{
    "Data": {
        "Token": {
            "Id": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
        },
        "Operation": {
            "Version": "1.0",
            "Name": "OTP.GenerateCodeOperation",
            "Payload": "{\"To\":\"573001234567\",\"Type\":\"Authentication\"}"
        }
    }
}

Response — OTPGenerateCodeResponseDTO

Estructura de respuesta de la operación:

Campo Tipo Descripción
Successful
 bool
true si el código fue generado correctamente
Identifier
 string
Identificador del código OTP en el sistema de seguridad
Code
 string
Código OTP generado
Status
 string
Estado del código generado
Message
 string
Mensaje de error o informativo

Ejemplos de Response

Response exitoso
Response — Éxito 
{
    "Successful": true,
    "Identifier": "x9z8y7w6-otp-secure-id",
    "Code": "482917",
    "Status": "Active",
    "Message": null,
    "ErrorCode": null,
    "ExceptionMessage": null,
    "UserMessage": null
}
Response con error
Response — Error (tenant no configurado) 
{
    "Successful": false,
    "Identifier": null,
    "Code": null,
    "Status": null,
    "Message": "El cliente no existe o no está configurado.",
    "ErrorCode": null,
    "ExceptionMessage": null,
    "UserMessage": null
}