A locale is an annotation for a language that we use to determine which language to display the application in for the user.

🇸🇪 🇫🇮 🇩🇰 🇪🇸 🇧🇪 🏴󠁧󠁢󠁳󠁣󠁴󠁿 🏴󠁧󠁢󠁥󠁮󠁧󠁿 🇵🇹

Locale for the user

Our features are offered in multiple languages. To set a language for a user, please provide a locale in the create user request. If no locale is provided, a locale based on the country of residence will be added to the user object.

Format

The locale consists of two parts separated with -. The first part is a 2-3 letter language tag according to IETF BCP 47. The second part is a two letter region code according to ISO 3166-1 alpha-2.

Examples:

  • sv-SE: Swedish - Sweden.
  • fi-FI: Finnish - Finland.
  • en-SE: English - Sweden.

Supported locales

We support a number of locales. Call the supported locales endpoint to find out which you have access to.

Using locales

There are several ways to specify which language to present to the user.

  • Putting a locale on the user when creating or updating the user.
  • Provide a locale when fetching entities that support locales.

If you do nothing, the application will select a default locale which differs based on your relevant market. E.g. Swedish in Sweden, Finnish in Finland etc.


Did this page help you?