Configure Branding

Change the branding being used in email communication and in the online Sign environment. This helps the invitees to recognize your company and trust the invite. You can customize the colors of the buttons and add your company logo. The company logo is shown in the navigation bar on the sign page and in emails.

There are a few options to configure the branding:

Management interface

Admin users of the account are able to visit the Sign management environment where they can configure the branding on account level. This means that it's automatically inherited for all clients. But you can also configure the branding per client.

Dashboard interface

The Sign dashboard provides the option to configure the branding. This can be done via the settings page. Here you can configure the branding on account level.

API

The branding can also be configured via the API. This is part of the clients API, so the branding will only be used for any dossiers that created via that client.

Create or update branding

Replace {kid} with the client Key ID

POST /clients/{kid}/branding

Request body

{
    "buttonBackgroundColor": "#000000",
    "buttonTextColor": "#ffffff",
    "themePrimaryColor": "#0000ff",
    "themeSuccessColor": "#00ff00",
    "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=",
    "logoEmail": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII="
}
  • buttonBackgroundColor: The background color of the button (used in email)
  • buttonTextColor: The text color for the button (used in email). It's advised to select a color with a high contrast with the background color of the button.
  • themePrimaryColor: The primary color used in the Sign environment.
  • themeSuccessColor: The success color used in the Sign environment.
  • logo: Base64 encoded PNG image. It's advised to use an image with a height of 300 pixels.
  • logoEmail: Base64 encoded PNG image. It's advised to use an image with a maximum height of 600 pixels. This logo is only used in email communication. When this field is not set the logo field will be used instead.

All colors must be formatted in hex format: #ABCDEF

Retrieve branding

To retrieve the current branding for a client sent a GET request to /clients/{kid}/branding. This will return the fields described above.

GET /clients/{kid}/branding

Response

{
  "buttonBackgroundColor": "#000000",
  "buttonTextColor": "#ffffff",
  "themePrimaryColor": "#0000ff",
  "themeSuccessColor": "#00ff00",
  "logo": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII=",
  "logoEmail": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVR42mNk+A8AAQUBAScY42YAAAAASUVORK5CYII="
}

Did this page help you?