Skip to main content
Use the language parameter to set the language for individual signers in your signature requests. This ensures that each recipient receives emails and signing pages in the designated language, regardless of their Box account settings or browser configuration.

​
Overview

By default, Box Sign determines the language for each signer based on:
  • The signer’s Box account language setting (if they’re logged in at time of signing)
  • English (if they’re not logged in)
In some workflows, especially legal or compliance scenarios, you may need to explicitly enforce display in a particular language. With the language parameter, you can explicitly set the language for a signer, ensuring compliance with legal and regulatory requirements. This language applies to:
  • All email notifications sent to the signer
  • The signing experience page

​
Set the language

To set the language for a signer, add the language field to the signer object in your API request.
cURL
curl -i -X POST "https://api.box.com/2.0/sign_requests" \
     -H "authorization: Bearer <ACCESS_TOKEN>" \
     -d '{
       "signers": [
          {
            "role": "signer",
            "email": "[email protected]",
            "language": "nl"
          }
        ],
       "source_files": [
          {
            "type": "file",
            "id": "123456789"
          }
       ],
       "parent_folder":
          {
            "type": "folder",
            "id": "0987654321"
          }
     }'

​
Supported language codes

Box Sign supports the language codes defined in the Box API language codes specification. For the complete list of supported languages and their codes, see Language codes. Common language codes include:
  • en — English
  • nl — Dutch
  • fr — French
  • de — German
  • es — Spanish
  • ja — Japanese

​
Error handling

If you specify an unsupported language code, the API returns a 400 Bad Request error. Example error response: 
{
  "type": "error",
  "status": 400,
  "code": "invalid_request_parameters",
  "help_url": "https://developer.box.com/guides/api-calls/permissions-and-errors/common-errors/",
  "message": "invalid_request_parameters",
  "request_id": "abcdef123456"
}
To fix this error, check that your language code matches one of the supported Language codes.