Skip to main content
Before you integrate the Form filling SDK, ensure you have partner credentials, Medical form template IDs, a browser on HTTPS with microphone access, and a production webhook.

​
Partner credentials

You need partnerId and partnerToken from Suki after Partner onboarding. Form filling does not open until sign-in succeeds with valid credentials.

​
Medical form templates

The Form filling SDK supports multiple Medical form templates, such as Vitals, Neuro, and Skin. Each template has a unique type, such as VITALS_ASSESSMENT or NEURO_ASSESSMENT. For a complete list, refer to Form filling templates. Work with Suki’s Support team to get the required IDs enabled for your partner account. Pass those IDs in the form_template_ids parameter when you call client.start() or render <FormFilling>. form_template_ids is an array of template_id values. Each template_id is a unique 36-character UUID assigned to your partner account.
  • Template IDs are different for staging and production environments.
  • Unsupported template IDs are ignored when you call start().
If you also use the Form filling API, template_id values are returned from Suki Medical form templates (GET /api/v1/info/suki-medical-form-templates).
SDK integrations should still use IDs provided by Suki support.

​
Browser and layout

  • Run the SDK in a browser on HTTPS. Microphone access requires a secure context.
  • Give the Form filling container explicit height so the hosted UI is visible.
  • If your app uses a Content-Security-Policy header, allow the hosted Form filling iframe in frame-src:.
Form filling runs in an iframe from that URL. If your CSP blocks it, the UI may not appear or you may see error SUKI_FF_002.

​
Partner webhook

After the clinician submits, Suki processes the Form filling session before structured JSON is ready. Processing may take some time and finishes after the clinician closes the tab. The SDK calls onSubmit in the browser when results are available. For production, also register a Partner webhook during Partner onboarding. Suki sends the same structured data to your server when processing completes. For more information, refer to the Webhook quickstart and Signature verification, or use the Webhook handler example.
Do not rely on onSubmit alone to save results. Use a webhook in production so structured data still reaches your server if the tab closes before processing finishes.

​
Provider context

Form filling only requires partnerId and partnerToken to sign in. Provider fields are optional when you set autoRegister: false (recommended unless you use provider auto-registration). autoRegister defaults to true, and when it is true you must also pass providerName and providerOrgId. If your app already knows which clinician is using Form filling, pass their details when you create SukiAuthManager:
  • providerId: your identifier for that clinician in your system.
  • providerName: display name shown in the hosted UI.
  • providerSpecialty: clinical specialty, for example FAMILY_MEDICINE.
These fields tie the session to the right provider in your workflow. For allowed specialty values, refer to Specialties. Refer to Authentication for autoRegister and the full sign-in options.

​
Next steps

Refer to the Quickstart after you have credentials and template IDs.
Last modified on August 7, 2026