• Classified Listing Docs
    • Classified Listing Plugin
    • Classified Listing All Addons
    • Classified Listing Mobile App
    • Classima Mobile APP
    • Listygo Mobile App
    • Homlisti Mobile App
  • Woocommerce Plugins Docs
    • ShopBuilder Elementor Addon
    • Woo Variation Swatches
    • Woo Variation Gallery
    • Zilly Mobile App
  • General Plugins Docs
    • The Post Grid
    • Testimonial Slider
    • Team Members
    • Food Menu
    • Review & Schema
    • Portfolio
    • Business Review
  • Our Plugins
    • The Post Grid
    • Classified Listing
    • ShopBuilder
    • Food Menu
    • Team
    • Portfolio
    • Testimonial Slider
    • Review & Schema
    • See All Plugins
×
  • Classified Listing Docs
    • Classified Listing Plugin
    • Classified Listing All Addons
    • Classified Listing Mobile App
    • Classima Mobile APP
    • Listygo Mobile App
    • Homlisti Mobile App
  • Woocommerce Plugins Docs
    • ShopBuilder Elementor Addon
    • Woo Variation Swatches
    • Woo Variation Gallery
    • Zilly Mobile App
  • General Plugins Docs
    • The Post Grid
    • Testimonial Slider
    • Team Members
    • Food Menu
    • Review & Schema
    • Portfolio
    • Business Review
  • Our Plugins
    • The Post Grid
    • Classified Listing
    • ShopBuilder
    • Food Menu
    • Team
    • Portfolio
    • Testimonial Slider
    • Review & Schema
    • See All Plugins

Getting Started

4
  • System Requirements
  • Installation
  • Permalink Settings
  • How to use(video)

Main Settings

15
  • Overview
  • General Settings
  • All Listings Page
  • Listing Details Page
  • Payments
  • Tax
  • Email
  • Account & Policy
  • Style
  • MISC Settings
  • Chat Settings Pro
  • Page Setup & Permalink
  • Tools
  • App Settings
  • Membership [Store addon] Pro

Email Settings

3
  • General Settings
  • Email Template
  • Video (How to Use)

Developer Docs

1
  • Developer Docs

Listing Management [Admin]

9
  • Admin End Ads View
  • Category
  • Locations
  • Listing Type
  • Pricing
  • Payment History
  • Export & Import Settings
  • Default Import [XML]
  • Stores [store addon]

AI Integration

5
  • Create Form with AI
  • Frontend AI Integration
  • AI Integration Settings
  • AI Semantic Search
  • AI Image Enhancement

MCP Integration

8
  • Overview
  • Install & Enable MCP Adapter Plugin
  • MCP Adapter Settings
  • AI App Connections
  • Connect the Claude Desktop App
  • Test Your Connection
  • Example Prompts
  • Available Abilities

Radius Booking Integration

10
  • How to Use (Video)
  • Integration with Radius Booking
  • Radius Booking Field in Form Builder
  • Enable Radius Booking on Existing Listing
  • Payout Settings
  • Payout Request from Front End Dashboard
  • Payout Request on Admin Panel
  • Commission Overview — Admin Panel
  • My Account – Booking
  • Appointments – Admin Panel

Theming

4
  • Add theme support for plugin templates
  • Override Ad Submission Form
  • Override ad detail page
  • Theming

Payment

8
  • Checkout Option
  • Offline Payment
  • Paypal
  • Authorize.net [PRO]
  • Stripe [PRO]
  • WooCommerce [PRO]
  • Payfast [Addon]
  • Paystack [Addon]

REST API

54
  • Form Builder Image Sort REST API
  • Form Builder Image Delete REST API
  • Form Builder File Delete REST API
  • Form Builder File Upload REST API
  • Create Listing via Form Builder REST API
  • Email Store Owner REST API
  • Get Single Store REST API
  • Get Store Listings REST API
  • Get Stores REST API
  • Upload My Store Banner REST API
  • Upload My Store Logo REST API
  • My Store REST API
  • My Store REST API
  • Report Listing REST API
  • Update Subscription Payment Method API
  • Cancel Subscription REST API
  • Get Pricing Plans REST API
  • Get Single Payment / Order Details REST API
  • Get Payment History REST API
  • Get Checkout Data REST API
  • Create New Tag REST API
  • Change Order Status REST API
  • Manage Orders REST API
  • Mark Message as Read REST API
  • Chat Message REST API
  • Check Conversation by Listing REST API
  • Start New Conversation API
  • Get Conversation Messages API
  • My Chat List REST API
  • Toggle a favourite listing REST API
  • Get My Favourite Listings REST API
  • Upload My Profile Image REST API
  • Update My Account REST API
  • Get My Account Info REST API
  • Mark Listing as Sold REST API
  • Change Listing Status REST API
  • Renew Listing REST API
  • Delete My Listings REST API
  • Get My Listings REST API
  • Get Single Listing API
  • Create a listing API
  • User Sign Up REST API
  • Login REST API
  • Logout REST API
  • Account Delete REST API
  • Reset Password REST API
  • Contact REST API
  • Configuration API
  • Locations API
  • Categories API
  • Listing Types API
  • Email Seller API
  • Listings API
  • General

Code Snippets

18
  • Mask more digits
  • Change Business Hour Start and End Time
  • Add Price Unit
  • Trim zero from payment price
  • Show mark as sold listing in the search
  • Remove required attribute for phone field
  • Remove Price Type
  • Modify listing submission success message
  • Modify checkout form fields
  • Display listing image in media library
  • Change radius unit and distance
  • Change Price Type
  • Change Favourites to Favorites
  • Change Excerpt Limit
  • Change Currency Symbol
  • Change archive page listing column
  • Add New Price Type
  • Code Snippets

Elementor Addons

11
  • Elementor Addons
  • Listing Category
  • Listing Category Slider
  • All Location
  • Single Location
  • Listings
  • Listing Slider
  • Listing Store
  • Pricing Table
  • Search Form
  • Header Button

Filter Hooks

15
  • rtcl_countries_all_countries
  • rtcl_checkout_fields
  • Checkout
  • rtcl_my_account_endpoint
  • rtcl_account_menu_items
  • My Account
  • rtcl_listing_pricing_types
  • Listing Form
  • rtcl_social_profiles_list
  • rtcl_registration_redirect
  • rtcl_listing_seller_contact_form_data
  • rtcl_listing_query_meta_query
  • rtcl_get_base_location
  • General
  • Filter Hooks

WPML Addon

3
  • System Requirements
  • Location Translations
  • WPML Settings

Action Hooks

14
  • Email
  • rtcl_payment_receipt
  • rtcl_checkout_process_success
  • Checkout
  • rtcl_account_{$menu_key}_endpoint
  • My Account
  • rtcl_listing_form_before_category_retrieve
  • rtcl_listing_form_after_save_or_update
  • Listing Form
  • rtcl_new_user_created
  • rtcl_listing_loop_item
  • rtcl_after_author_meta
  • General
  • Action Hooks

AJAX Filter Builder

2
  • Add Filter Items
  • Filter Widget

Listing Management [Front End]

3
  • Front End View
  • Front End Submission
  • My Account Menu

Frequently Asked Questions (Faq’s)

29
  • Frequently Asked Questions(Faq’s)
  • Fix taxonomy page listing sorting issue
  • Disallow query string and specific URL [SEO]
  • Enable New Dashboard [Canvas]
  • Custom Fields for Listview
  • Custom Fields for Filter
  • Pay Per Ad
  • Admin Menu Access
  • How to change listing archive category description position
  • Category & Location Menu Link
  • Add Re-Captcha
  • Add Google Map
  • Rank Math SEO Settings
  • Enable Chat
  • Renew listing process
  • How to set Local Time for Business Hour
  • Enable WooCommerce Payment
  • Fix Custom Field Save Issue
  • Enable Mark as Sold
  • How to add Compare
  • How to clear plugin cache?
  • Change Archive Page Title
  • User don’t get Registration & Verification Email?
  • How to change custom fields order?
  • How to add Watermark
  • How to separate login and registration page?
  • How to hide contact information for non logged in users?
  • Enable Social Login
  • Enable User Registration

Shortcodes

9
  • Shortcodes
  • Categories Display
  • Checkout Page
  • Listing Submission Form
  • My Account Page
  • Store List
  • Location Wise Display
  • Category Wise Display
  • Listing Filter

Drag & Drop Form Builder (New)

14
  • How to add your own icon in the builder
  • Multi-Category Selection
  • Enable Form Builder
  • Form List
  • Add New Form
  • Preset Fields
  • Custom Fields
  • Single Listing Layout Builder New
  • Enable Multiple Forms
  • Enable Conditional Logic
  • Add Bulk Options Pro
  • Smart Dependency Pro
  • SEO-Friendly Slug Builder
  • Image Crop Feature

Gutenberg Block

10
  • Gutenberg Block
  • Listing Category
  • Listing Category Slider
  • All Location
  • Single Location
  • Listings
  • Listing Slider
  • Listing Search
  • Pricing Table
  • Stores
  • Home
  • Docs
  • Developer Docs
  • REST API
  • User Sign Up REST API
View Categories

User Sign Up REST API

3 min read

0:00 / 3:48
  • View as Markdown Open this page as plain Markdown (opens in a new tab)
  • Open in ChatGPT Ask questions about this page (opens in a new tab)
  • Open in Claude Ask questions about this page (opens in a new tab)
  • Open in Google AI Studio Ask questions about this page (Google account required) (opens in a new tab)

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 #

HeaderRequiredDescription
Content-Type✅ Yesapplication/json
x-api-key✅ YesREST API access key

Request Body Parameters #

ParameterTypeRequiredDescription
usernamestring✅ YesUsername of the new account. If empty, a username may be generated automatically.
emailstring✅ YesValid email address.
passwordstring✅ YesPassword. If empty, a random password may be generated.
first_namestring Cond.Required if rtcl_registration_name_validation filter is true.
last_namestringCond.Required if rtcl_registration_name_validation filter is true.
phonestring Cond.Required if rtcl_registration_phone_validation filter is true. Must be unique.
rtcl_user_typestringCond.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 #

  1. JWT token is valid for 24 hours.
  2. Optional fields (phone, rtcl_user_type) depend on filters and settings.
  3. Filters:
    • rtcl_registration_need_auth_new_user → require email verification
    • rtcl_registration_generate_username → auto-generate username
    • rtcl_registration_generate_password → auto-generate password
    • rtcl_registration_name_validation → validate first/last name
    • rtcl_registration_phone_validation → validate phone uniqueness
  4. Hooks:
    • rtcl_register_data → called before user creation
    • rtcl_new_user_created → called after user creation
    • rtcl_rest_api_signup_success → called after REST API signup success
What are your Feelings

Share This Article :

  • Facebook
  • X
  • LinkedIn
  • Pinterest
Still stuck? How can we help?

How can we help?

Updated on January 26, 2026
Create a listing APILogin REST API
Table of Contents
  • Endpoint
    • Description
    • Required Request Headers
    • Request Body Parameters
    • Request Body Example
    • cURL Example
    • Success Responses
      • 1. JWT Token Response
      • 2. Verification Mail Response
    • Error Responses
    • Notes
Copyright© 2026 RadiusDocs by RadiusTheme