Verify a user
API operation: Open the endpoint in Scalar
Use POST /users/{user_id}/verify to verify the authenticated user's email address or cellphone. The current public operation is User.verification.
The authenticated user must match {user_id}. The request requires an integer channel from the values declared in Scalar and can include a verification code between four and eight characters. Cellphone verification can also use cellphone and country_phone_code where supported by the selected flow.
{
"channel": 1,
"code": "123456"
}
The code is synthetic. Never publish or reuse a real verification code.
See the Codes model for the surrounding verification-code concepts. Scalar remains authoritative for channel values, authentication, request fields, responses, and errors.
OpenAPI reference
Operation: POST /users/{user_id}/verify
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
user_id | integer | Yes | — |
Request body fields
| Name | Type | Required |
|---|---|---|
cellphone | any | No |
channel | integer | Yes |
code | string | No |
country_phone_code | any | No |
Responses
| Code | Description |
|---|---|
| 200 | OK (Envelope) |
| 400 | Bad Request (ErrorResponse) |
| 401 | Unauthorized |
| 404 | Not Found |
| 429 | Too Many Requests (ErrorResponse) |
| 500 | Internal Server Error (ErrorResponse) |
| 503 | Service Unavailable (ErrorResponse) |