Check Invitation Token

Validates the invite token from the invitation email and returns the advisor's customerUid and role.

Call this endpoint first to confirm the token is valid before creating a session. The customerUid returned here is required to create a user-scoped session in Step 2.

Possible error codes:

CodeStatusDescription
INVITATION_DOES_NOT_EXIST400Token not found 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…

The token query parameter is sent automatically via email when an admin creates an advisor using the Administration API. The advisor extracts the token from the invitation link and passes it here to validate it before starting onboarding.

A successful response returns a customerUid — save this to create a user-scoped session before calling Step 2 (Accept Invitation).

Query Params
string
required

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

Responses

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