El Objeto de Validación de Teléfono
Descripción
El objeto Validación de Teléfono representa el proceso de verificación de números telefónicos dentro de tus proyectos de Verifik. Este objeto contiene toda la información necesaria para rastrear y gestionar solicitudes de verificación de teléfono.
Atributos
client
Tipo: ObjectId
Requerido: Solo lectura
La cuenta de cliente a la que pertenece esta validación de teléfono. Se establece automáticamente en función de tu token de autenticación.
project
Tipo: ObjectId
Requerido: Opcional
El proyecto donde se realiza esta validación de teléfono. Es el _id generado al crear un proyecto.
projectFlow
Tipo: ObjectId
Requerido: Sí
El flujo de proyecto donde se realiza esta validación de teléfono. Es el _id generado al crear un flujo de proyecto.
status
Tipo: String
Requerido: Sí
El estado actual del proceso de validación de teléfono. Puede ser:
"new"- Solicitud de validación creada pero aún no procesada (predeterminado)"sent"- Se ha enviado el código de verificación al usuario"validated"- El teléfono ha sido verificado exitosamente"failed"- La validación de teléfono falló o expiró
countryCode
Tipo: String
Requerido: Sí
El código de marcación internacional del número telefónico (p. ej., "+1" para EE. UU., "+44" para Reino Unido, "+57" para Colombia).
phone
Tipo: String
Requerido: Sí
El número de teléfono que se está validando (los espacios se eliminan automáticamente).
type
Tipo: String
Requerido: Sí
El tipo de validación de teléfono que se está realizando:
"validation"- Validación general de número telefónico"login"- Verificación de teléfono durante el inicio de sesión"onboarding"- Verificación de teléfono durante el registro de usuario
validationMethod
Tipo: String
Requerido: Sí
El método utilizado para la validación de teléfono:
"verificationCode"- Código OTP enviado por SMS"manual"- Proceso de verificación manual
verificationCode
Tipo: String
Requerido: Opcional
El código OTP generado para la verificación de teléfono (solo presente cuando validationMethod es "verificationCode").
expiresAt
Tipo: Date
Requerido: Opcional
La fecha y hora de expiración del código de validación.
redirectUrl
Tipo: String
Requerido: Opcional
URL a la que redirigir después de una validación exitosa.
webhookUrl
Tipo: String
Requerido: Opcional
URL de webhook para notificaciones del estado de la validación.
identityUrl
Tipo: String
Requerido: Opcional
URL de verificación de identidad para pasos de verificación adicionales.
requires2FA
Tipo: Boolean
Requerido: Opcional
Indicador que señala si se requiere autenticación de dos factores.
ipAddress
Tipo: String
Requerido: Opcional
Dirección IP del usuario que realiza la validación.
attempts
Tipo: Number
Requerido: Opcional
Número de intentos de validación realizados.
maxAttempts
Tipo: Number
Requerido: Opcional
Número máximo de intentos de validación permitidos.
createdAt
Tipo: Date
Requerido: Sí
Fecha y hora cuando se creó la validación de teléfono.
updatedAt
Tipo: Date
Requerido: Sí
Fecha y hora de la última actualización de la validación de teléfono.
validatedAt
Tipo: Date
Requerido: Opcional
Fecha y hora cuando la validación de teléfono se completó correctamente.
Objeto de Ejemplo
{
"_id": "phone_validation_123456789",
"client": "client_123456789",
"project": "project_123456789",
"projectFlow": "flow_123456789",
"status": "validated",
"countryCode": "+1",
"phone": "1234567890",
"type": "validation",
"validationMethod": "verificationCode",
"verificationCode": "123456",
"expiresAt": "2024-01-15T11:30:00Z",
"redirectUrl": "https://example.com/success",
"webhookUrl": "https://example.com/webhook",
"requires2FA": false,
"ipAddress": "192.168.1.1",
"attempts": 1,
"maxAttempts": 3,
"createdAt": "2024-01-15T10:30:00Z",
"updatedAt": "2024-01-15T10:32:00Z",
"validatedAt": "2024-01-15T10:32:00Z"
}