{
  1. Introduction
    1. Service description
    2. Environments
  2. Getting started
    1. Authentication
    2. Upload document
    3. Create dossier
    4. Send invites
    5. Dossier download
  3. Events
    1. Event webhooks
    2. Subscribe to events
    3. Retrieve status callback
  4. Error handling
  5. Use cases
    1. Change language / locale
    2. Send invite using SMS
    3. Send invite using WhatsApp Business Platform
    4. Include invite in your own system
    5. Require identification
    6. Require payment
    7. Cancel a dossier
    8. Configure branding
    9. Configure invitee emails
    10. Create dossier based on a template
  6. Swagger API documentation

Change the language / locale

To change the language for a dossier you can set the locale field. The locale can be set on a dossier and invitee level.

The following locales are supported: de-DE, en-US, es-ES, fr-FR, hu-HU, it-IT, ja-JP, nl-NL, pl-PL, pt-PT, ro-RO and sk-SK.

Dossier locale

The default locale is en-US. The dossier locale affects the language of the audit report and the emails sent to the dossier owner.

Request

POST /dossiers

Request body

{
    "name": "Contract",
    "locale": "nl-NL"
}

Invitee locale

The default invitee locale is inherited from the dossier locale. In the example below, the locale for John Doe is set to de-DE. As no locale is set for Jane Doe, it'll inherit the locale nl-NL from the dossier level.

Request

POST /dossiers

Request body

{
    "name": "Contract",
    "locale": "nl-NL",
    "invitees": [
        {
            "name": "John Doe",
            "locale": "de-DE"
        },
        {
            "name": "Jane Doe"
        }
    ]
}