Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.knotapi.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The Knot SDK supports localization, allowing you to present the merchant linking experience in your users’ preferred language. Localization is controlled via the locale parameter, a BCP-47 language tag passed when configuring the SDK. The locale you pass controls both the SDK’s display language and which regional version of the merchant site loads where applicable. For example, passing en-CA will load the Canadian version of a merchant’s site, while en-US will load the U.S. version. If your app supports users in multiple regions, we recommend always passing an explicit locale to match the user’s region.

​
Supported Locales

LocaleLanguageRegion
en-USEnglishU.S.
en-CAEnglishCanada
es-USSpanishU.S.
fr-CAFrenchCanada
If no locale is provided, the SDK defaults to en-US, displaying in English and loading the U.S. version of the merchant site where applicable.

​
Usage

Pass the locale parameter when configuring the SDK to localize the experience. For example, to display the SDK in Spanish:
Javascript
knotapi.open({
  sessionId: "Your Session ID",
  clientId: "Your Client ID",
  environment: "production",
  locale: "es-US",
  // ... other parameters
});
The locale parameter is available across all mobile SDKs. See the iOS, Android, React Native, and Flutter SDK guides for platform-specific examples.

​
What is Localized

When a supported locale is set, all text in the Knot SDK is localized. Merchant login flows are also localized, and the SDK loads the regional version of the merchant’s site where the merchant supports the provided locale.