PingOne Platform APIs

Localization of agreements

An agreement must support the default environment language. The condition of having "agreement content to show" requires that at least the environment’s default language is configured as an agreement language resource. The agreement language resource that supports the environment’s default language must be enabled. The agreement language resource can have its enabled property set to true only if there is "localized content to show" configured on its associated agreement revisions resource.

Agreement language resources define the locale property, which applies to all agreement revision resources associated with the language.

Agreement language resources

The locale property on the agreement language resource specifies a tag for identifying the language resource associated with an agreement consent (for example, en-US).

How localized agreement content is presented to users

Agreement languages are defined by either the language code (for example, en) or the combination of language code and country code (for example, en-GB). For identifying languages, the API follows the tags for identifying languages described in RFC_4646. For selecting a language code to use in an agreement, the API follows the matching of language tags described in RFC_4647.

When an agreement is active, languages are presented to the user in the following order:

  1. User preference: The end user receives agreement content in the language that matches the user’s preferredLanguage property value.

  2. Browser preference: If the user’s preferredLanguage is not configured (or enabled) as one of the supported agreement language resources for this agreement, the end user receives agreement content in the language associated with the browser’s configured locale.

  3. Environment default language: If the browser’s configured language is not one of the enabled agreement language resources for the agreement, then the agreement content is presented to the end user in the environment’s default language.

For more information, refer to Agreement Management.