i18n: país, idioma e localização do documento

O Autentique suporta documento em diversas jurisdições e idiomas, veja como funciona.

Na API, as configurações de internacionalização do documento são definidas pelo campo locale dentro de document.

Esse campo permite informar:

• country: país/jurisdição do documento

• language: idioma do documento

• timezone: fuso horário

• date_format: formato de data

Jurisdição (country)

O campo country define a jurisdição do documento utilizando códigos de país no padrão ISO 3166.

Caso não seja informado, o valor padrão será:

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

Documentos internacionais

Ao criar um documento com uma jurisdição diferente de BR, algumas funcionalidades específicas do contexto brasileiro deixam de ser aplicadas.

Por exemplo:

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

Nesse cenário:

• O envio para signatários utilizando o método de entrega por SMS não é suportado a todos os DDIs.

• A configuração new_signature_style passa a ser considerada como true.

• A configuração ignore_cpf passa a ser considerada como true.

• Campos de CPF posicionados no documento são ignorados.

• Verificações adicionais realizadas através da SERPRO são ignoradas.

• Verificações adicionais realizadas via SMS são ignoradas.

Considerações

A jurisdição não altera o conteúdo do arquivo enviado nem realiza traduções automáticas.

Ela define quais regras de negócio, validações e recursos estarão disponíveis durante o processo de assinatura.

Idioma (language)

O campo language define o idioma utilizado na experiência do documento e no fluxo de assinatura.

Caso não seja informado, o valor padrão será:

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

Atualmente são suportados os seguintes idiomas:

Valor	Idioma
pt-BR	Português (Brasil)
en-US	Inglês (Estados Unidos)
es-MX	Espanhol (México)

Exemplo

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

O que é afetado pelo idioma

O idioma define a linguagem utilizada pela plataforma durante a experiência dos participantes, incluindo:

• Telas de assinatura.

• Mensagens exibidas durante o fluxo de assinatura.

• Textos de confirmação.

• Instruções apresentadas aos signatários.

• Conteúdo de comunicações automáticas enviadas pela plataforma.

O que não é afetado pelo idioma

A configuração de idioma não realiza tradução automática do conteúdo enviado.

Por exemplo, se um PDF em português for enviado com:

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

O documento continuará em português. Apenas a interface e as comunicações relacionadas ao processo de assinatura serão apresentadas em inglês.

Prioridade de exibição do idioma

Quando possível, a plataforma utiliza o idioma configurado no documento como referência principal para a experiência dos participantes.

Por esse motivo, recomenda-se definir explicitamente o campo language ao criar documentos destinados a usuários de diferentes regiões.

Fuso horário (timezone)

O campo timezone define o fuso horário utilizado pelo documento para exibição e processamento de informações relacionadas a data e hora.

Caso não seja informado, o valor padrão será:

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

Exemplo

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

Valores aceitos

O campo aceita qualquer identificador válido da base de fusos horários IANA (Olson Time Zone Database).

Exemplos:

"America/Sao_Paulo"

"America/New_York"

"Europe/London"

"Asia/Tokyo"

A lista completa de identificadores pode ser consultada em:

https://www.php.net/manual/en/datetimezone.listidentifiers.php

O que é afetado pelo fuso horário

O fuso horário configurado no documento é utilizado para interpretar e exibir informações de data e hora associadas ao processo de assinatura.

Por exemplo:

• Data e hora de assinatura.

• Data e hora exibidas em registros de auditoria.

• Eventos registrados na trilha de evidências.

• Informações temporais exibidas aos participantes.

Recomendações

Ao criar documentos destinados a participantes de diferentes regiões, recomenda-se definir explicitamente o campo timezone para garantir consistência na exibição das informações temporais.

Exemplo:

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

Observações

• O valor deve seguir exatamente um identificador IANA válido.

• Caso um fuso horário inválido seja informado, a requisição poderá ser rejeitada pela API.

• A configuração do fuso horário é independente do idioma (language) e da jurisdição (country).

Formato de data (date_format)

O campo date_format define o padrão utilizado para exibição de datas relacionadas ao documento e ao processo de assinatura.

Caso não seja informado, o valor padrão será:

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

Valores suportados

Atualmente são suportados os seguintes formatos:

Valor	Exemplo
DD_MM_YYYY	31/12/2026
MM_DD_YYYY	12/31/2026

Exemplo

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

O que é afetado pelo formato de data

O formato configurado é utilizado para exibir datas associadas ao documento e ao processo de assinatura.

Por exemplo:

• Datas exibidas durante o fluxo de assinatura.

• Registros da trilha de auditoria.

• Evidências geradas pelo processo de assinatura.

• Informações apresentadas aos participantes.