PartnerDetails Type

PartnerDetails type represents the partner authentication and provider information

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

partnerId · string · required

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

partnerToken · string · required

The idToken of the user/provider to use when authenticating with the Suki Platform.

providerName · string · required

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

providerOrgId · string · required

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

providerSpecialty · string · default: "FAMILY_MEDICINE"

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

providerId · string

The unique identifier of the provider in the partner system.