PartnerDetails Type

PartnerDetails type represents the partner authentication and provider information required for SDK initialization. The code snippet below shows how to use the PartnerDetails type to create a partner details object.

JavaScript

type PartnerDetails = {
  partnerId: string;
  partnerToken: string;
  providerName: string;
  providerOrgId: string;
  providerSpecialty?: string;
  providerId?: string;
};

Properties

Hide properties

string

required

The unique identifier of the partner to use when authenticating with the Suki Platform.

string

required

Signed JWT issued by your identity provider for the current user. Suki does not issue this token. See Partner authentication.

string

required

The full name of the user/provider. First name, middle name, and last name separated by a space.

string

required

The unique identifier of the organization in the partner system to which the provider belongs.

string

default:"FAMILY_MEDICINE"

The specialty of the provider, if applicable. Defaults to FAMILY_MEDICINE.

string

The unique identifier of the provider in the partner system.

Last modified on October 23, 2026

Get Started

Concepts & Feature Guides

API Reference

Resources

PartnerDetails Type

Properties

​Properties

Properties