Endpoint #
POST /wp-json/rtcl/v1/signup
Description #
Registers a new user and returns a JWT token for authentication.
Requires a valid API key in the request headers.
Required Request Headers #
| Header | Required | Description |
|---|---|---|
Content-Type | ✅ Yes | application/json |
x-api-key | ✅ Yes | REST API access key |
Request Body Parameters #
| Parameter | Type | Required | Description |
|---|---|---|---|
username | string | ✅ Yes | Username of the new account. If empty, a username may be generated automatically. |
email | string | ✅ Yes | Valid email address. |
password | string | ✅ Yes | Password. If empty, a random password may be generated. |
first_name | string | Cond. | Required if rtcl_registration_name_validation filter is true. |
last_name | string | Cond. | Required if rtcl_registration_name_validation filter is true. |
phone | string | Cond. | Required if rtcl_registration_phone_validation filter is true. Must be unique. |
rtcl_user_type | string | Cond. | Required if user types are enabled in plugin settings. |
Request Body Example #
{
"username": "john_doe",
"email": "john@example.com",
"password": "securePassword123",
"first_name": "John",
"last_name": "Doe",
"phone": "+880123456789"
}
cURL Example #
curl -X POST https://yourwebsite.com/wp-json/rtcl/v1/signup \
-H "Content-Type: application/json" \
-H "X-API-KEY: your_api_key_here" \
-d '{
"username": "john_doe",
"email": "john@example.com",
"password": "securePassword123",
"first_name": "John",
"last_name": "Doe",
"phone": "+880123456789"
}'
Success Responses #
1. JWT Token Response #
{
"token_type": "Bearer",
"iat": 1674634567,
"expires_in": 1674720967,
"jwt_token": "your.jwt.token.here",
"isLoggedIn": true,
"user": {
"id": 123,
"username": "john_doe",
"email": "john@example.com",
"first_name": "John",
"last_name": "Doe",
"phone": "+880123456789",
"whatsapp_number": "",
"description": "",
"website": "",
"locations": [],
"zipcode": "",
"address": "",
"latitude": "",
"longitude": "",
"pp_thumb_url": "https://example.com/wp-content/uploads/avatar.jpg",
"isAdmin": false,
"subscriptions": []
}
}
2. Verification Mail Response #
If the filter rtcl_registration_need_auth_new_user returns true:
{
"verification_mail": "john@example.com"
}
Error Responses #
❌ API Access Disabled
Status: 403 Forbidden
{
"code": "DENIED_REST_API",
"message": "Denied api call",
"data": {
"status": 403
}
}
❌ Missing Authorization Header
Status: 401 Unauthorized
{
"status": "error",
"error": "MISSING_X_API_KEY_HEADER",
"code": "401",
"error_message": "X_API_KEY header not received. Either authorization header was not sent or it was removed by your server due to security reasons."
}
❌ Invalid Authorization Header
Status: 401 Unauthorized
{
"status": "error",
"error": "INVALID_API_KEY",
"code": "401",
"error_message": "Sorry, you are using invalid API Key."
}
❌ Missing Required Fields
Status: 403 Forbidden
{
"status": "error",
"error": "FORBIDDEN",
"code": 403,
"error_message": "Username, email, and password are required."
}
❌ Invalid Email Address
Status: 400 Bad Request
{
"status": "error",
"error": "registration-error-invalid-email",
"code": 400,
"error_message": "Please provide a valid email address."
}
❌ Email Already Exists
Status: 400 Bad Request
{
"status": "error",
"error": "registration-error-email-exists",
"code": 400,
"error_message": "An account is already registered with your email address. Please log in."
}
❌ Invalid Username
Status: 400 Bad Request
{
"status": "error",
"error": "registration-error-invalid-username",
"code": 400,
"error_message": "Please enter a valid account username."
}
❌ Username Already Exists
Status: 400 Bad Request
{
"status": "error",
"error": "registration-error-username-exists",
"code": 400,
"error_message": "An account is already registered with that username. Please choose another."
}
❌ Missing First Name
Status: 400 Bad Request
{
"status": "error",
"error": "registration-error-invalid-first_name",
"code": 400,
"error_message": "Please enter your first name."
}
❌ Missing Last Name
Status: 400 Bad Request
{
"status": "error",
"error": "registration-error-invalid-last_name",
"code": 400,
"error_message": "Please enter your last name."
}
❌ Missing Password
Status: 400 Bad Request
{
"status": "error",
"error": "registration-error-missing-password",
"code": 400,
"error_message": "Please enter an account password."
}
❌ Missing Phone
Status: 400 Bad Request
{
"status": "error",
"error": "registration-error-invalid-phone",
"code": 400,
"error_message": "Please enter your phone number."
}
❌ Phone Already Exists
Status: 400 Bad Request
{
"status": "error",
"error": "registration-error-phone-exists",
"code": 400,
"error_message": "An account is already registered with your phone number. Please log in."
}
❌ Missing User Type
Status: 400 Bad Request
{
"status": "error",
"error": "registration-error-invalid-user-type",
"code": 400,
"error_message": "Please select a user type option."
}
❌ Generic Registration Error
Status: 400 Bad Request
{
"status": "error",
"error": "registration-error",
"code": 400,
"error_message": "Error: Couldn't register you… please contact us if you continue to have problems."
}
Notes #
- JWT token is valid for 24 hours.
- Optional fields (
phone,rtcl_user_type) depend on filters and settings. - Filters:
rtcl_registration_need_auth_new_user→ require email verificationrtcl_registration_generate_username→ auto-generate usernamertcl_registration_generate_password→ auto-generate passwordrtcl_registration_name_validation→ validate first/last namertcl_registration_phone_validation→ validate phone uniqueness
- Hooks:
rtcl_register_data→ called before user creationrtcl_new_user_created→ called after user creationrtcl_rest_api_signup_success→ called after REST API signup success