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

Update User Onboarding Data Per Step

Developing
POST
/onboarding/step/<int:step>
1.
Get user based on JWT identity
2.
Receive JSON payload from frontend relevant to current step
3.
Validate data for given step using helper function: validate_onboarding_step_data
4.
Update user record in db with new data
5.
Advance user's onbaording step if successful
6.
Marks onboarding as completed if final step reached
Frontend interaction:
Frontend will POST user's input for each onboarding step to this endpoint.
On success, frontend advances to next step/completion message, or if there is an error, frontend should display error messages returned.
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/onboarding/step/<int:step>'
Response Response Example
{}

Request

None

Responses

🟢200Success
application/json
Body

Modified at 2025-06-20 16:14:20
Previous
Onboarding Status
Next
Onboarding Completed
Built with