How to Set Signer Language for a Document

BoldSign supports to set language for signers for better understanding and convenience. This article will guide you on how to set language for signers using the API.

You can allow your signers to receive the emails in their preferred language. The currently supported languages are English, German, Spanish, French, Romanian, Norwegian, Bulgarian, Italian, Danish, Polish, Portuguese, Czech, Dutch, Russian, Japanese, Thai, Simplified Chinese, Traditional Chinese, and Swedish. While sending the signature request, all the signer-related transaction emails and signing page static contents will be translated into the signer’s defined language.

You can set signer language by setting signer locale property and DocumentInfo locale property.

Below are a few code examples demonstrating how to set language for signers.

Code snippet

curl -X 'POST' \
  'https://api.boldsign.com/v1/document/send' \
  -H 'accept: application/json' \
  -H 'X-API-KEY: {Your API Key}' \
  -H 'Content-Type: multipart/form-data' \
  -F 'Signers={
  "name": "David",
  "emailAddress": "[email protected]",
  "formFields": [
    {
      "id": "string",
      "fieldType": "Signature",
      "pageNumber": 1,
      "bounds": {
        "x": 100,
        "y": 100,
        "width": 100,
        "height": 20
      },
      "isRequired": true
}
  ],
  "locale": "PT"
}' \

  -F 'Files={Your file path}' \
  -F 'DocumentInfo[locale]="PT"' \
  -F 'Title=Signer language' \

import boldsign

configuration = boldsign.Configuration(host="https://api.boldsign.com", api_key="YOUR_API_KEY")

with boldsign.ApiClient(configuration) as api_client:
    document_api = boldsign.DocumentApi(api_client)

    form_field = boldsign.FormField(
        id="Signature",
        fieldType="Signature",
        pageNumber=1,
        bounds=boldsign.Rectangle(x=100, y=100, width=200, height=100),
        isRequired=True
    )
    form_field1 = boldsign.FormField(
        id="Signature1",
        fieldType="Signature",
        pageNumber=1,
        bounds=boldsign.Rectangle(x=100, y=100, width=200, height=100),
        isRequired=True
    )

    signer1 = boldsign.DocumentSigner(
        name="David",
        emailAddress="[email protected]",
        signerType="Signer",
        signerRole="Signer",
        formFields=[form_field],
        locale="PT"
    )
    signer2 = boldsign.DocumentSigner(
        name="John",
        emailAddress="[email protected]",
        signerType="Signer",
        signerRole="Signer",
        formFields=[form_field1],
        locale="NO"
    )
    documentInfo1 = boldsign.DocumentInfo(
        locale = "PT",
        title= "sample document"
    )
    documentInfo2 = boldsign.DocumentInfo(
        locale = "NO",
        title= "sample document"
    )

    send_for_sign = boldsign.SendForSign(
        title="Sample document",
        description="Please sign the document",
        files=["YOUR_FILE_PATH"],
        signers=[signer1, signer2],
        documentInfo=[documentInfo1, documentInfo2]
    )

    response = document_api.send_document(send_for_sign)


<?php require_once "vendor/autoload.php";

use BoldSign\Configuration;
use BoldSign\Api\DocumentApi;
use BoldSign\Model\FormField;
use BoldSign\Model\DocumentSigner;
use BoldSign\Model\DocumentInfo;

$config = new Configuration();
$config->setHost("https://api.boldsign.com");
$config->setApiKey('YOUR_API_KEY');

$documentApi = new DocumentApi($config);

$formField = new FormField();
$formField->setId('Signature');
$formField->setFieldType('Signature');
$formField->setPageNumber(1);
$formField->setBounds(new BoldSign\Model\Rectangle(['x' => 100, 'y' => 100, 'width' => 200, 'height' => 100]));
$formField->setIsRequired(true);

$signer = new DocumentSigner();
$signer->setName('David');
$signer->setEmailAddress('[email protected]');
$signer->setSignerType('Signer');
$signer->setFormFields([$formField]);
$signer->setLocale('PT');

$documentInfo = new DocumentInfo();
$documentInfo->setTitle("sample document");
$documentInfo->setLocale('PT');
$sendForSign = new BoldSign\Model\SendForSign();
$sendForSign->setTitle('Sample document');
$sendForSign->setFiles(['YOUR_FILE_PATH']);
$sendForSign->setSigners([$signer]);
$sendForSign->setDocumentInfo([$documentInfo]);

$result = $documentApi->sendDocument($sendForSign);

ApiClient client = Configuration.getDefaultApiClient();
client.setBasePath("https://api.boldsign.com");
client.setApiKey("YOUR_API_KEY");

DocumentApi documentApi = new DocumentApi(client);

FormField formField = new FormField();
formField.setId("Signature");
formField.setFieldType(FormField.FieldTypeEnum.SIGNATURE);
formField.setPageNumber(1);
formField.setBounds(new Rectangle().x(100f).y(100f).width(100f).height(50f));
formField.setIsRequired(true);

DocumentSigner signer = new DocumentSigner();
signer.setName("David");
signer.setEmailAddress("[email protected]");
signer.setSignerType(DocumentSigner.SignerTypeEnum.SIGNER);
signer.setFormFields(Arrays.asList(formField));
signer.setLocale(DocumentSigner.LocaleEnum.PT);

DocumentInfo documentInfo = new DocumentInfo();
documentInfo.setTitle("sample document");
documentInfo.setLocale(DocumentInfo.LocaleEnum.PT);

SendForSign sendForSign = new SendForSign();
sendForSign.setTitle("Sample document");
sendForSign.setFiles(Arrays.asList(new File("YOUR_FILE_PATH")));
sendForSign.setSigners(Arrays.asList(signer));
sendForSign.documentInfo(Arrays.asList(documentInfo));
documentApi.sendDocument(sendForSign);

import * as boldsign from "boldsign";
import * as fs from 'fs';

const documentApi = new boldsign.DocumentApi("https://api.boldsign.com");
documentApi.setApiKey("YOUR_API_KEY");

const formField = new boldsign.FormField();
formField.id = "Signature";
formField.fieldType = boldsign.FormField.FieldTypeEnum.Signature;
formField.pageNumber = 1;
formField.bounds = new boldsign.Rectangle();
formField.bounds.x = 50;
formField.bounds.y = 60;
formField.bounds.width = 100;
formField.bounds.height = 150;
formField.isRequired = true;

const signer = new boldsign.DocumentSigner();
signer.name = "David";
signer.emailAddress = "[email protected]";
signer.signerType = boldsign.DocumentSigner.SignerTypeEnum.Signer;
signer.locale = boldsign.DocumentSigner.LocaleEnum.Pt;
signer.formFields = [formField];

const documentInfo = new boldsign.DocumentInfo();
documentInfo.title = "sample document";
documentInfo.locale = boldsign.DocumentInfo.LocaleEnum.Pt;

const sendForSign = new boldsign.SendForSign();
sendForSign.title = "Sample document";
sendForSign.files = [fs.createReadStream("YOUR_FILE_PATH")];
sendForSign.documentInfo = [documentInfo];
sendForSign.signers = [signer];

const result = documentApi.sendDocument(sendForSign);

Replace the values (Files, Signers, etc.) with the actual values. Set the Locale field to your desired language code. Also, provide DocumentInfo with the necessary information if you want to send the document in different languages other than EN. Upon execution, the document will be created, and a document ID will be generated.