partner_token in the JSON request body for Login and Register.
Because the token is shared across providers, Bearer partners must also send provider_id in every Login and Register request so Suki can identify the active provider.
Important:Suki assigns your partner type during onboarding. If you are not sure whether your organization is configured as a Bearer partner, contact your partnership team.
This guide applies only to Bearer partners. It does not apply to partners that use a per-user ID token or user-scoped access token as partner_token.
Prerequisites
Before you implement Bearer partner authentication, confirm the following:- Bearer partner configuration - Your Suki partner contact confirms that your organization is configured as a Bearer partner.
- Provider ID format - You and Suki agree on a stable provider identifier format, such as an email address or external user ID. Use the same format on every login and register call.
- HTTPS required - Send Login and Register requests as HTTPS POST requests with a JSON body. Do not send credentials in query parameters.
Use cases
Use Bearer partner authentication when your integration matches one of these scenarios:Identity Outside the Partner Token
Your application already knows the signed-in provider, such as through a session or database record, but you cannot include that identity in the
partner_token. Instead, send a stable identifier as provider_id in the authentication request body.No Per-user ID Token
Your identity provider does not issue a per-user ID token for Suki, or you cannot add user claims to the access token. Bearer partner authentication lets you keep your existing token model and identify the provider by using
provider_id.How Bearer partners differ from other partners
| Topic | Standard partner authentication | Bearer partner authentication |
|---|---|---|
| User identity source | Derived from partner_token | Passed as provider_id in the request body |
partner_token type | Per-user ID token or user-scoped token | Typically one shared partner_token for many providers |
provider_id on login or register | Optional and ignored | Required |
In Bearer partner authentication, the partner application provides the provider identity on behalf of the signed-in user. This is different from the HTTP
Authorization: Bearer header format.You still send partner_token in the JSON request body for login and register requests.Authentication workflow
For Bearer partners, Suki validatespartner_id and provider_id on Login. If the provider is not registered, call Register, then call Login again.
The flow matches standard partners after registration. Learn more about registration scenarios in Provider authentication.
Login and Register request fields
Bearer partners use the same login and register endpoints as standard partners. You must includeprovider_id on every login and register call.
Login
Endpoint: LoginMethod: POST
| Field | Bearer partners |
|---|---|
partner_id | Required. Partner ID from Suki. |
partner_token | Required. Shared partner_token your integration uses for authentication. |
provider_id | Required. Stable identifier for the provider in your system. Must match the format agreed with Suki during onboarding. |
Example request
Register
Register a provider once before their first login. Refer to Provider authentication for new user, existing user, and conflict responses.Endpoint: RegisterMethod: POST
| Field | Bearer partners |
|---|---|
partner_id | Required. Partner ID from Suki. |
partner_token | Required. Shared partner_token your integration uses for authentication. |
provider_id | Required. Stable identifier for the provider in your system. Use this as the user identifier at registration. |
provider_name | Required. Display name for the provider. |
provider_org_id | Required. Organization the provider belongs to. |
provider_specialty | Optional. Defaults to FAMILY_MEDICINE if omitted. |