i18n: Document Country, Language, and Localization

In the API, a document’s internationalization settings are defined through the locale field within document.

This field supports the following properties:

• country: the document’s country or jurisdiction

• language: the document’s language

• timezone: the time zone

• date_format: the date format

Jurisdiction (country)

The country field defines the document’s jurisdiction using ISO 3166 country codes.

If omitted, the default value is:

{
  "locale": {
    "country": "BR"
  }
}

International Documents

When creating a document under a jurisdiction other than BR, some features specific to the Brazilian context no longer apply.

For example:

{
  "locale": {
    "country": "US"
  }
}

In this scenario:

• Sending documents to signers via SMS is not supported for all international country calling codes.

• The new_signature_style setting is treated as true.

• The ignore_cpf setting is treated as true.

• CPF fields positioned within the document are ignored.

• Additional verification through SERPRO is ignored.

• Additional verification via SMS is ignored.

Considerations

The jurisdiction does not modify the contents of the uploaded file or automatically translate it.

It determines which business rules, validation methods, and features are available during the signing process.

Language (language)

The language field defines the language used throughout the document experience and signing flow.

If omitted, the default value is:

{
  "locale": {
    "language": "pt-BR"
  }
}

The following languages are currently supported:

Value	Language
pt-BR	Portuguese (Brazil)
en-US	English (United States)
es-MX	Spanish (Mexico)

Example

{
  "locale": {
    "language": "en-US"
  }
}

What the Language Setting Affects

The language setting determines the language used by the platform throughout the signer experience, including:

• Signing screens

• Messages displayed during the signing flow

• Confirmation messages

• Instructions shown to signers

• Automated communications sent by the platform

What the Language Setting Does Not Affect

The language setting does not automatically translate the uploaded content.

For example, if a PDF written in Portuguese is uploaded with:

{
  "locale": {
    "language": "en-US"
  }
}

The document will remain in Portuguese. Only the interface and communications related to the signing process will be displayed in English.

Language Display Priority

Whenever possible, the platform uses the language configured for the document as the primary reference for the signer experience.

Therefore, we recommend explicitly setting the language field when creating documents for users in different regions.

Time Zone (timezone)

The timezone field defines the time zone used to display and process the document’s date and time information.

If omitted, the default value is:

{
  "locale": {
    "timezone": "America/Sao_Paulo"
  }
}

Example

{
  "locale": {
    "timezone": "America/New_York"
  }
}

Accepted Values

The field accepts any valid identifier from the IANA Time Zone Database, also known as the Olson Time Zone Database.

Examples:

"America/Sao_Paulo"

"America/New_York"

"Europe/London"

"Asia/Tokyo"

The complete list of identifiers is available in the PHP documentation: https://www.php.net/manual/en/datetimezone.listidentifiers.php

What the Time Zone Setting Affects

The time zone configured for the document is used to interpret and display date and time information associated with the signing process.

For example:

• Signature dates and times

• Dates and times displayed in audit records

• Events recorded in the evidence trail

• Time-related information displayed to signers

Recommendations

When creating documents for signers in different regions, we recommend explicitly setting the timezone field to ensure that time-related information is displayed consistently.

Example:

{
  "locale": {
    "country": "US",
    "language": "en-US",
    "timezone": "America/New_York"
  }
}

Notes

• The value must exactly match a valid IANA identifier.

• If an invalid time zone is provided, the API may reject the request.

• The time zone setting is independent of the language (language) and jurisdiction (country) settings.

Date Format (date_format)

The date_format field defines the format used to display dates associated with the document and signing process.

If omitted, the default value is:

{
  "locale": {
    "date_format": "DD_MM_YYYY"
  }
}

Supported Values

The following formats are currently supported:

Value	Example
DD_MM_YYYY	31/12/2026
MM_DD_YYYY	12/31/2026

Example

{
  "locale": {
    "date_format": "MM_DD_YYYY"
  }
}

What the Date Format Setting Affects

The configured format is used to display dates associated with the document and signing process.

For example:

• Dates displayed during the signing flow

• Audit trail records

• Evidence generated during the signing process

• Information presented to signers