Advisor Onboarding

These endpoints handle the onboarding flow for Advisor users invited by a branch super-advisor or admin.

Flow at a Glance

#StepEndpointAuth
1Validate invite tokenGET /branches/public/v1/common/invites/checkNone
Create scoped sessionPOST /entrypoint/org/v1/sessionsClient credentials + customerUid
2Accept invitationPOST /org/branches/public/v1/advisor/invites/acceptSession headers
3Verify phone OTP (if required)POST /users/private/v1/limited/generate-new-phone-codeTemporary token
4Confirm phone OTP (if required)PUT /users/private/v1/limited/check-phone-codeTemporary token
5Exchange tokenPUT /users/private/v1/limited/token-exchangeTemporary token

Session Setup (between Steps 1 and 2)

Step 1 returns a customerUid. Before calling Step 2, create a session scoped to that advisor:

POST /entrypoint/org/v1/sessions
Content-Type: application/json

{
  "clientId":     "<your-client-id>",
  "clientSecret": "<your-client-secret>",
  "customerUid":  "<customerUid from Step 1>"
}

Include these two headers on every request from Step 2 onward:

X-Session-Id: <sessionId>
X-Client-Id:  <clientId>

Step 2 Response Codes

HTTPMeaning
200Account is immediately active — onboarding complete.
403Account created; additional verifications required. Continue with Steps 3–5.

No request body is needed. The password is managed internally.