# Branding

Branding sets what signers see: your name, your accent colour and your logo on the signing pages and emails. You can take our name off, and list the sites allowed to embed signing.

## Set your branding

Call `update_branding` with a regular key. Agent keys can't change branding. Every field is optional, and fields you leave out stay as they are.

```
curl https://docuinked.com/v1/branding \
  -H "Authorization: Bearer $DOCUINKED_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"display_name": "Cedar Row Rentals",
       "accent_color": "#0F766E",
       "logo_png_base64": "iVBORw0KGgo...",
       "hide_docuinked_branding": true,
       "embed_origins": ["https://app.example.com"]}'
```

The reply is the branding as it now stands, the same as `get_branding`.

| Field | What it does |
|---|---|
| `display_name` | The name signers see on the page and in the From line of signing emails |
| `accent_color` | Buttons and highlights, as `#RRGGBB` |
| `logo_png_base64` | A PNG under 200 KB, shown at the top of signer pages and emails |
| `hide_docuinked_branding` | `true` removes our name from signer pages and emails |
| `embed_origins` | Up to 10 sites allowed to frame signing, each like `https://app.example.com` with no path |

## Read it back

```
curl https://docuinked.com/v1/branding -H "Authorization: Bearer $DOCUINKED_API_KEY"
```

`get_branding` returns `display_name`, `accent_color`, `has_logo`, `logo_url`, `hide_docuinked_branding` and `embed_origins`.

## Branding for each of your customers

On a platform, each sub-account has its own branding. Add the header `DocuInked-Account: acct_...` to the same call to set it for one customer. See [sub-accounts](/docs/accounts).

## What branding changes, and what it doesn't

Signer pages, signing emails and embedded signing use your name, logo and colour. With branding hidden, emails come from your name alone. Without it, they read "your name via docuinked".

Some things stay ours. The sealed PDF is sealed by docuinked, and its certificate page says so, because the seal and the evidence are what we stand behind. Signing links use our domain, and emails come from our address. Custom signing domains and custom email sending domains are coming, but they aren't available yet.

## Common questions

### Why must embed origins use https?

A signing page holds a person's signature and consent, so it may only sit inside a page that is itself private in transit. Plain http origins, paths and wildcards are refused.

### Can I use an SVG or JPEG logo?

Not yet. The logo must be a PNG under 200 KB. A transparent PNG about 300 pixels wide looks best on both the page and the email.

### Does removing your branding change the certificate?

No. The certificate page inside the sealed PDF always names docuinked as the service that sealed it, so anyone checking the file knows where to verify it.
