> ## Documentation Index
> Fetch the complete documentation index at: https://developer.suki.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Partner Onboarding

> Complete one-time onboarding to get a Partner ID, register auth and webhook settings, then start integrating Suki APIs and SDKs

<Callout icon="handshake" color="orange">
  **Not a Suki partner yet?**

  * Onboarding is a **one-time process**. You cannot self-provision credentials.
  * To get started, contact the **Suki Partnerships team**.
    They configure your authentication, environments, and webhooks, then issue your **Partner ID** that you will use for API and SDK authentication.

  <div style={{ marginTop: '0.75rem' }}>
    <a className="doc-guide-btn partner-contact-cta" href="https://www.suki.ai/suki-partners/" target="_blank" rel="noopener noreferrer">
      Contact Partnership Team
    </a>
  </div>
</Callout>

Onboarding is the process of registering your organization on the Suki Developer Platform. During onboarding, Suki creates your partner account, configures your integration, and provisions the credentials and settings required to use Suki APIs and SDKs.

You **cannot self-provision** these credentials. The Suki Partnerships team works with you throughout the onboarding process to configure your account.

During onboarding, you provide:

* **Authentication method:** How your identity provider authenticates users and issues a Partner Token (JWT). Suki uses this token to verify users before they access Suki APIs or SDKs. Suki recommends OAuth 2.0 or OpenID Connect with a public **JWKS URL**. For more information, see [Partner authentication](/documentation/how-to/partner-authentication).
* **Environments:** The environments you plan to use, such as staging and production, so Suki can provision the appropriate access, credentials, and base URLs.
* **Webhook configuration (optional):** The HTTPS callback URL that Suki should use to send webhook notifications to your backend. If you plan to use webhooks, provide this during onboarding. For more information, see [Configure webhooks](/documentation/webhook/configuration).

After onboarding is complete, Suki issues a <Tooltip tip="A unique identifier assigned by Suki during onboarding that links an application to its configuration in the Suki Developer Platform." cta="View in Glossary" href="/Glossary/p">Partner ID</Tooltip> (`partner_id`) that identifies your integration.

Refer to the sections below for the full checklist of what you provide, what you receive, and the step-by-step onboarding flow.

## What you provide and what you receive

When you contact Suki, provide the following information so the partnership team can begin onboarding your organization. The exact fields vary by product (API, Web SDK, or Mobile SDK), but most partners provide the following information:

<Tabs>
  <Tab title="What Partner Provides">
    | What Partner provides                                                                                                                                                                                          | Why Suki needs it                                                                             |
    | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------- |
    | **Business details:** official name, contact email, phone, and the person owning the integration                                                                                                               | To create your partner record and know who to contact during setup and support                |
    | **Use case:** Ambient, Form filling, Dictation, or a mix, plus target platforms (web, mobile, backend)                                                                                                         | To provision the right products, SDKs, and environments for your integration                  |
    | **Authentication method:** **Recommended:** OAuth 2.0 / OpenID Connect that issues a JWT, verified with a public **JWKS URL**. Refer to [Partner authentication](/documentation/how-to/partner-authentication) | So Suki can verify Partner Tokens and confirm your users before they access Suki APIs or SDKs |
    | **User identifier field:** JWT claim that uniquely identifies the user (`sub`, `email`, or another agreed field)                                                                                               | So Suki can map each verified token to the correct clinician or user in your organization     |
    | **Host URLs** (SDK embeds): public test and production app URLs                                                                                                                                                | So Suki can allowlist your apps when you embed a Suki SDK iframe                              |
    | **Webhook callback URL** (optional at start): HTTPS endpoint for notifications. See [Configure webhooks](/documentation/webhook/configuration)                                                                 | So Suki can POST session complete, fail, and related notifications to your backend            |
  </Tab>

  <Tab title="What Suki Provides">
    | Suki provides                            | What you use it for                                                           |
    | :--------------------------------------- | :---------------------------------------------------------------------------- |
    | **Partner ID** (`partner_id`)            | Required on API auth calls and SDK initialization                             |
    | **Registered public-key method**         | Usually your JWKS URL on the partner record so Suki can verify Partner Tokens |
    | **Staging and production guidance**      | Environments and base URLs for your integration path                          |
    | **Webhook secret** (if webhooks enabled) | Verify that inbound webhook POSTs came from Suki                              |
  </Tab>
</Tabs>

<Note>
  Onboarding does **not** give you a long-lived API key. Instead, your users sign in through your identity provider, and you pass the resulting **Partner Token (JWT)** to Suki. Suki verifies the token and returns SDK access or an `sdp_suki_token` for Partner APIs. To learn how to authenticate users with Suki, refer to the [Partner authentication](/documentation/how-to/partner-authentication) guide.
</Note>

## Key concepts to understand before onboarding

As a partner, you must understand the following key concepts and their roles and relationships in the Suki Developer Platform.

| Term             | Meaning                                                                                           |
| :--------------- | :------------------------------------------------------------------------------------------------ |
| **Partner**      | Your organization on the Suki Developer Platform. One partner can include multiple organizations. |
| **Organization** | A group of users under a partner, such as a hospital or clinic.                                   |
| **Provider**     | A clinician or other user in an organization who uses Suki capabilities.                          |

## How authentication works in the Suki Developer Platform

Suki does not host your login screens or store end-user passwords. Your identity provider authenticates each user and issues a JWT, known as the **Partner Token**. Suki verifies that token with the public keys you registered during onboarding, then grants access.

```mermaid actions={false} theme={"theme":{"light":"github-dark","dark":"material-theme-darker"}}
flowchart LR
    A[User signs in<br/>to your app] --> B[IDP issues<br/>Partner Token JWT]
    B --> C[Your app sends<br/>token to Suki]
    C --> D[Suki verifies<br/>with your JWKS]
    D --> E[Access granted<br/>SDK or sdp_suki_token]

    style A fill:#FFF394,stroke:#333,color:#000
    style B fill:#FFF394,stroke:#333,color:#000
    style C fill:#FFF394,stroke:#333,color:#000
    style D fill:#FFF394,stroke:#333,color:#000
    style E fill:#FFF394,stroke:#333,color:#000
```

If you cannot host a JWKS URL, Suki supports other public-key methods during onboarding. To learn about the supported methods and the recommended setup, refer to the [Partner authentication](/documentation/how-to/partner-authentication) guide.

## How the onboarding process works

The onboarding and verification process typically takes **a few business days** after you submit all required information and Suki verifies your details. While you wait, review the [Partner authentication](/documentation/how-to/partner-authentication) and [Integration decision guide](/documentation/get-started/integration-decision-guide) to determine the API or SDK integration path you'll use after your account is approved.

**Here is a high-level overview of the onboarding process:**

```mermaid actions={false} theme={"theme":{"light":"github-dark","dark":"material-theme-darker"}}
flowchart TD
    A([Start]) --> B[Contact Partnership Team]
    B --> C[Share checklist items:<br/>business, use case, auth, JWKS,<br/>identifier, hosts, webhook]
    C --> D[Suki reviews and provisions<br/>partner record]
    D --> E[You receive Partner ID<br/>and confirmed settings]
    E --> F[Set up Partner Auth,<br/>then integrate APIs or SDKs]
    F --> G([Go live])

    classDef stepStyle fill:#FFE148,stroke:#D4A017,stroke-width:2px,color:#000000
    classDef milestoneStyle fill:#FFF394,stroke:#FFE148,stroke-width:2px,color:#000000
    classDef doneStyle fill:#FFD700,stroke:#D4A017,stroke-width:3px,color:#000000

    class B,C,D stepStyle
    class E milestoneStyle
    class F,G doneStyle
```

### Detailed steps of the onboarding process

<Steps>
  <Step title="Contact Suki" icon="user-plus">
    Reach out through [Contact Partnership team](https://www.suki.ai/suki-partners/) (or your Suki account contact). Have the [checklist](#what-you-provide-and-what-you-receive) ready: business details, use case, recommended auth (OAuth JWT + JWKS URL), user identifier field, host URLs if you embed an SDK, and webhook URL if you want notifications from day one.
  </Step>

  <Step title="Suki Reviews and Provisions" icon="check-circle">
    Suki registers your public-key method and other settings on the partner record, then provisions staging or production access as agreed. Missing JWKS, identifier, or allowlist details are the most common cause of delay, so send them complete the first time.
  </Step>

  <Step title="Receive Your Partner ID" icon="key">
    On approval, you receive your **Partner ID**. Confirm that your registered JWKS URL, identifier field, host allowlist, and webhook URL (if any) match what your code will use, then move on to authentication setup.
  </Step>
</Steps>

## Getting support

<AccordionGroup>
  <Accordion title="Contact the Suki Team">
    Reach out to your Suki Customer Success or Program Manager, or use [Contact Partnership Team](https://www.suki.ai/suki-partners/).
  </Accordion>

  <Accordion title="Slack Channel">
    Use the dedicated Slack channel created for your integration team after onboarding starts.
  </Accordion>

  <Accordion title="Support Ticket">
    Create a [Support ticket](https://forms.suki.ai/SukiSupport/form/SukiSDKSupport/formperma/T3z7hYJ7Ph-J7JrWSN08QJn32BYjarkxqm8Lm8XFPow) for technical issues or questions.
  </Accordion>
</AccordionGroup>

## Next steps

After you have a Partner ID and confirmed settings:

<Icon icon="file-lines" iconType="solid" /> **[Partner authentication](/documentation/how-to/partner-authentication)** - Register OAuth JWT + JWKS (recommended) and understand Partner Token verification.

<Icon icon="file-lines" iconType="solid" /> **[Integration decision guide](/documentation/get-started/integration-decision-guide)** - Choose Web SDK, Headless Web SDK, Mobile SDK, Dictation SDK, or Partner APIs.

<Icon icon="file-lines" iconType="solid" /> **[Ambient API quickstart](/api-reference/quickstart)** - First ambient session on staging with paste-ready scripts.

<Icon icon="file-lines" iconType="solid" /> **[Form filling API quickstart](/form-filling-api-reference/quickstart)** - First Form filling session on staging.

<Icon icon="file-lines" iconType="solid" /> **[Configure webhooks](/documentation/webhook/configuration)** - Callback URL and secret if you deferred webhooks during onboarding.
