Accept Invitation

Activates the invited advisor's account. No request body is required — the password is managed internally.

Before calling this endpoint, call GET /branches/public/v1/common/invites/check?token=<token> to retrieve the advisor's customerUid, then create a session scoped to that user (POST /entrypoint/org/v1/sessions with customerUid). Include the returned sessionId as X-Session-Id and your clientId as X-Client-Id on this request.

On 200, the advisor account is immediately active.

On 403, the account is created but additional verifications are required (phone confirmation, KYC). Continue using the same session headers for the /limited/ endpoints.

Possible error codes:

CodeStatusDescription
INVITATION_DOES_NOT_EXIST400Token is invalid or already used
REQUIRED_INVITATION_TOKEN400token query parameter is missing
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Activates the invited advisor's account. No request body is required — the password is managed internally.

Before calling this endpoint, validate the invite token (Step 1) to get the advisor's customerUid, create a scoped session, then pass X-Session-Id + X-Client-Id with this request.

A 200 means the account is immediately active. A 403 means the account is created but additional onboarding steps (phone verification) are required — continue with the /limited/ endpoints using the temporaryAccessToken from the response.

Query Params
string
required

The 6-character invitation code from the advisor's invitation email.

Headers
string
required

Session ID returned from the login endpoint.

string
required

The ClientId (ci_test_… or ci_live_…) used to create the session. The gateway verifies that the session belongs to this credential.

Responses

Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json