Polarity API Docs
Auth Routes
Copy Page
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
Auth Routes
Copy Page
Get Current User (Protected Routes Access)
Developing
GET
/auth/user
Try it
Run in Apidog
Run in Apidog
1.
Frontend includes JWT access token as part of Authorization header(Bearer: Token) for API requests
2.
Backend uses @jwt_required() to protect routes
3.
If the token is valid, and not expired/blacklisted, request proceeds, otherwise reject.
4.
Gets user id from JWT token
5.
Queries db for user with user id
6.
Checks if user exists
7.
Onboarding Completion Check
Checks if onboarding required fields are complete
if complete, then user's onboarding status marked complete and commits to db
8.
Returns JSON response with user's ID, name, username, email, onboarding step/status, budget profile.
ALLOWS logged-in users to fetch their profile/budget data and update onboarding status if required fields met.
Request
Request Example
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
--request
GET
'/auth/user'
Response
Response Example
{
}
Request
None
Responses
🟢
200
Success
application/json
Generate Code
Body
Generate Code
Modified atÂ
2025-06-20 16:02:57
Previous
Login
Next
Token Expiry Refresh