​
Overview

This guide describes the process for a new partner to get onboarded and registered with the Suki Developer Platform (SDP). Before you can use Suki’s APIs and SDKs, you must complete a one-time onboarding process. After you are onboarded, you can then register your users and begin your integration.

​
Key Concepts

​
Partner

An organization that integrates with Suki to use our services. A partner can contain multiple organizations.

​
Organization

A group of users within a partner, such as a hospital or a clinic.

​
Provider

A user within an organization, such as a doctor or a nurse, who uses Suki’s services.

​
partner_id

A unique identifier that Suki assigns to you during the onboarding process. This ID is used to:
  • Link your application to its configuration in the Suki Developer Platform.
  • Determine which JWKS endpoint URL to use for token validation.
  • Establish the permission mapping between your roles and Suki’s capabilities.
partner_id is a required field for all API calls and SDK initializations. Suki will provide you with a unique partner_id after you send us the JWKS endpoint URL.

​
partner_token

The user’s unique token from your . You will send this token to Suki to authenticate your providers.
Identity Providers: Instead of Suki handling user logins directly, we trust the authentication that your system performs.The process works as follows:
  • A provider/user signs in to your application using your identity provider (e.g., Okta, Azure AD).
  • Your IDP issues a unique token for that user.
  • You send this token to Suki in your API requests. Suki verifies the token to confirm the user’s identity and grant them access.

​
Onboarding Process

Follow these steps to get your organization onboarded with the Suki Developer Platform.

​
Step 1: Contact the Suki team

To begin, you will need to contact the Suki Customer Success team. Please be prepared to provide the following information:
  • Your official business name, email address, and phone number.
  • A description of your business and how you plan to use Suki.
  • The name of a contact person for the integration.
  • The authentication mechanism you will use to authenticate your users.
Authentication MethodsSuki supports the following public key sharing authentication mechanisms. You will use your own identity provider to issue the token.
  • Stored Secret - You provide your public key to Suki, and we store it securely in our database as an encrypted file.
  • JWKS URL - You host your public keys at a public JSON Web Key Set () endpoint, and Suki fetches them dynamically to verify tokens.
  • Okta - You use Okta as your Identity Provider, and Suki obtains the public key from your Okta issuer URL.
  • JWT Assertion - You share your public key as a signed JWT that follows the RFC 7523 standard. Suki then verifies this JWT using our public key.
For more information on each of the authentication mechanisms, see the Partner Authentication guide.

​
Step 2: Suki reviews your information

After you provide your information, the Suki team will review it to begin the onboarding process.

​
Step 3: Receive your Partner ID

Once your information is verified, Suki will provide you with a unique partner_id. This ID identifies your application and is required for all API calls and SDK initializations.

​
Getting Support

If you have questions or need help, you have several options:
  • Contact the Suki Customer Success or Program Manager team.
  • Message us on Suki created dedicated Slack channel for your integration.
  • Create a support ticket.