Polarity API Docs
  1. Onboarding 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. Onboarding Routes

Onboarding Status

Developing
GET
/onboarding/status
1.
Fetches user from db using JWT identity
2.
Returns whether onboarding is complete or not ("onboarding_completed" field of User model) and onboarding step.
3.
Also returns data collected so far
Frontend interaction:
Frontend calls this endpoint to determine what onboarding step user is on, and pre-fill any previously entered data.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/onboarding/status'
Response Response Example
{}

Request

None

Responses

🟢200Success
application/json
Body
object {0}
Modified at 2025-06-20 16:11:15
Previous
Logout
Next
Update User Onboarding Data Per Step
Built with