Mobile use case
Get an SSO token and inject it into your mobile app. Your backend calls SSO, receives the token, and passes it to the mobile app to open a WebView.
POST /users/sso · auth: API Key + Secret
Your backend calls SSO with ?fields=vsee. Response includes the SSO token and VSee credentials.
headers:
| Field | Required | Description |
|---|---|---|
X-ApiKey | yes | API Key |
X-ApiSecret | yes | API Secret |
X-AccountCode | yes | Account code |
queryParams:
| Field | Required | Description |
|---|---|---|
fields | no | Set to 'vsee' to include VSee ID and token |
bodyFields:
| Field | Required | Description |
|---|---|---|
first_name | yes | Patient's first name |
last_name | yes | Patient's last name |
type | yes | User type: 200 = Patient |
email | no | Patient email address |
code | yes | Unique patient identifier on your end (max 128 chars) |
Send the SSO token (data.token.token) from the response to your mobile app via your existing auth flow or internal API.
Redirect to https://{your_clinic}.vseepreview.com/auth?sso_token={sso_token}&next=/u/{room_slug}
In the mobile app, open a WebView pointing to the auth URL.