Polarity API Docs
  1. Auth Routes
Polarity API Docs
  • Auth Routes
    • Signup
      POST
    • Login
      POST
    • Get Current User (Protected Routes Access)
      GET
    • Token Expiry Refresh
      POST
    • Logout
      POST
  • Onboarding Routes
    • Onboarding Status
      GET
    • Update User Onboarding Data Per Step
      POST
    • Onboarding Completed
      GET
    • Reset Onboarding
      GET
  1. Auth Routes

Signup

Developing
POST
/auth/signup
auth
1.
User submits signup form (username, email, password, First Name, Last Name)
2.
Validate data (check for existing user, password validity)
3.
Generate encrypted/hashed pw, and create a new user in db
4.
Success response sent
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/auth/signup' \
--header 'Content-Type: application/json' \
--data-raw '{
    "username": "string",
    "email": "string",
    "password": "string",
    "name": "string",
    "age": "string"
}'
Response Response Example
201 - 201 User Created Success
{
    "message": "User Created Successfully",
    "user_id": 123
}

Request

Header Params
Content-Type
string 
optional
Example:
application/json
Body Params application/json
username
string 
required
email
string 
required
password
string 
required
name
string 
required
age
string 
required
Examples

Responses

🟢201Created
application/json
Body
201
string 
required
🔴500Server Error
🟠409Conflict (user already exists)
🟠400Bad Request/validation
Modified at 2025-06-20 16:02:54
Next
Login
Built with