Verificar un usuario
API operation: Open the endpoint in Scalar
Usa POST /users/{user_id}/verify para verificar el email o cellphone del usuario autenticado. La operación pública actual es User.verification.
El usuario autenticado debe coincidir con {user_id}. La solicitud requiere un valor entero para channel, elegido entre los valores declarados en Scalar, y puede incluir un code de verificación de entre cuatro y ocho caracteres. La verificación de cellphone también puede usar cellphone y country_phone_code cuando el flujo seleccionado lo admita.
{
"channel": 1,
"code": "123456"
}
El código es sintético. Nunca publiques ni reutilices un código de verificación real.
Consulta el modelo de códigos para conocer los conceptos relacionados de código de verificación. Scalar sigue siendo la fuente de autoridad para los valores de canal, autenticación, campos de solicitud, respuestas y errores.
Referencia de OpenAPI
Operación: POST /users/{user_id}/verify
Parámetros de ruta
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
user_id | integer | Sí | — |
Campos del cuerpo de la solicitud
| Nombre | Tipo | Obligatorio |
|---|---|---|
cellphone | any | No |
channel | integer | Sí |
code | string | No |
country_phone_code | any | No |
Respuestas
| Código | Descripción |
|---|---|
| 200 | Respuesta exitosa. El contenido de result varía según la operación y se devuelve como JSON. |
| 400 | Respuesta de error (error=true). Los errores de validación y de negocio comparten este código. |
| 401 | Envelope de error: sesión ausente, inválida, o nivel de usuario fuera de los permitidos. Respuesta de error para el código declarado por la operación. Consulta result para ver los detalles disponibles. Envelope de error: el proyecto no existe o no tiene una suscripción activa. |
| 404 | Respuesta vacía: la versión de API solicitada no está admitida. |
| 429 | Envelope de error: se excedió un límite de consumo del proyecto (o el sujeto está baneado). Lleva Retry-After y X-RateLimit-Limit/Remaining/Reset/Scope/Key. |
| 500 | Respuesta de error: falló la búsqueda o inicialización del proyecto. |
| 503 | Envelope de error: la aplicación está temporalmente en mantenimiento. Envelope de error: el proyecto está temporalmente en mantenimiento, o los límites de consumo no se pudieron evaluar y el límite aplicable está configurado con on_error = closed (cabecera Retry-After: 1). |