Customize Embedded Document Branding Through the API

SignWell API customers can customize the branding of individual embedded documents without creating a separate API Application for every brand or customer.

This is useful for platforms that embed SignWell requesting or signing experiences for multiple customers and need the branding to change dynamically from one document to another.

What You Can Customize

Document-level branding supports:

Company logo
Accent color
Button label color
Link color
Button border radius

Branding is passed through the optional embedded.branding object when creating or updating a document.

For example:

"embedded": {
  "branding": {
    "company_logo": {
      "file_url": "https://example.com/logo.png"
    },
    "accent_color": "#51B6C4",
    "button_label_color": "#FFFFFF",
    "link_color": "#1A0DAB",
    "button_border_radius": 20
  }
}

You can use document-level branding with:

Create Document
Create Document from Template
Update and Send Document

You only need to provide the properties you want to override.

For logos, you can provide either a public image URL or a Base64-encoded image. If a URL-based logo cannot be displayed when the embedded page loads, the page will continue without the custom logo rather than preventing the document from loading.

Document Branding vs. API Applications

Use document-level branding when branding needs to change dynamically for individual documents or customers.

Use an API Application when you want a reusable branding and application configuration that can be applied across multiple documents.

For the complete request schema, logo requirements, validation rules, Update & Send behavior, and API response details, see the SignWell API documentation:

If you have questions about using the SignWell API, contact us at support@signwell.com.