Validate Email Validation (Validar la validación de correo electrónico)
Endpoint
POST /v2/email-validations/validate
Descripción Este endpoint valida una contraseña de un solo uso (OTP) enviada a la dirección de correo electrónico del usuario como parte del proceso de verificación de correo. Garantiza que el OTP proporcionado por el usuario sea correcto y vincula el estado de verificación al usuario.
Headers
Content-Type
String
Yes
Set to application/json
.
Authorization
String
Yes
Bearer token for API authorization.
Body Parameters
project
String
Yes
Unique identifier for the project.
projectFlow
String
Yes
Identifier for the specific project flow.
email
String
Yes
Email address of the user to validate.
validationMethod
String
Yes
The validation method, set to verificationCode
.
type
String
Yes
Type of validation, e.g., login
.
otp
String
Yes
The one-time password provided by the user.
Request
Response
Response Body
email
String
Email address that was validated.
type
String
Validation type, e.g., login
.
showFaceLivenessRecommendation
Boolean
Indicates if face liveness check is recommended.
appLogin
Object
Contains detailed information about the validated login session.
appLogin._id
String
Unique ID of the login session.
appLogin.name
String
Name of the user.
appLogin.status
String
Status of the validation, e.g., validated
.
token
String
JWT token generated after successful validation.
Notas
El OTP debe generarse previamente y enviarse al correo electrónico del usuario.
Asegúrate de que tu aplicación maneje los tokens JWT de manera segura después de la validación.
Si se recomienda la verificación de liveness facial, guía a los usuarios para completar este paso en tu flujo.
Last updated