Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt

Use this file to discover all available pages before exploring further.

Enterprise tenants can apply custom branding to verification pages, transactional emails, and proof bundles. Upload your logo, set brand colors, and preview changes before saving.
Custom branding requires a Business or Enterprise plan, or the White-Label add-on. See billing for plan details.

​
Branding settings

Navigate to Settings > Branding in the console to configure your brand. Upload your organization’s logo. The logo appears on verification pages, transactional emails, and credential cards.
RequirementValue
FormatsPNG, JPEG, SVG, WebP
Max file size2 MB

​
Brand name

Set the name displayed on verification pages and credential cards. This is typically your organization or product name.

​
Colors

Configure two colors that define your brand appearance:
ColorWhere it appearsDefault
PrimaryCard headers, primary UI elements#06b6d4
AccentBadges, tags, secondary highlights#0891b2
Use the color picker or enter a hex value directly (e.g., #1a2b3c).

​
Live preview

The branding page includes a live preview panel that shows how your logo, brand name, and colors appear on a credential card. Changes update in real time as you adjust settings.

​
Configuring branding

1

Upload your logo

Click the upload area or drag and drop your logo file. The preview updates immediately.
2

Set your brand name

Enter your organization name in the Brand Name field.
3

Choose your colors

Use the color pickers to set your primary and accent colors, or enter hex values directly.
4

Save

Click Save Branding to apply your changes. A confirmation banner appears when the save completes.

​
Managing branding via the API

You can read and update branding settings programmatically. All write endpoints require the White-Label entitlement.

​
Get current branding

Request
GET /v1/settings/branding
X-API-Key: tl_live_...
Response
{
  "tenant_id": "tn_abc123",
  "brand_name": "Acme Corp",
  "logo_url": "https://cdn.truthlocks.com/branding/tn_abc123/logo/logo.png",
  "primary_color": "#10b981",
  "accent_color": "#059669"
}
If no branding has been configured, the response returns the default colors (#06b6d4 primary, #0891b2 accent) and no logo.

​
Update branding

Set your brand name and colors in a single request:
Request
PUT /v1/settings/branding
X-API-Key: tl_live_...
Content-Type: application/json

{
  "brand_name": "Acme Corp",
  "primary_color": "#10b981",
  "accent_color": "#059669"
}
Colors must be valid hex values in #RRGGBB format. Omitted fields keep their current values. Logo uploads use a three-step presigned URL flow:
1

Request a presigned upload URL

Request
POST /v1/settings/branding/logo/presign
X-API-Key: tl_live_...
Content-Type: application/json

{
  "filename": "logo.png",
  "content_type": "image/png",
  "size_bytes": 48000
}
Response
{
  "upload_url": "https://s3.amazonaws.com/...",
  "s3_key": "branding/tn_abc123/logo/ast_xyz/logo.png",
  "asset_id": "ast_xyz",
  "expires_in": 600
}
The presigned URL expires after 10 minutes.
2

Upload the file to the presigned URL

Upload your logo directly to the returned upload_url using an HTTP PUT request with the file contents as the body.
3

Confirm the upload

Request
POST /v1/settings/branding/logo/confirm
X-API-Key: tl_live_...
Content-Type: application/json

{
  "asset_id": "ast_xyz",
  "s3_key": "branding/tn_abc123/logo/ast_xyz/logo.png"
}
After confirmation, the new logo appears on all branding surfaces.
Write endpoints (PUT /v1/settings/branding, logo presign, and logo confirm) return HTTP 402 if your plan does not include the White-Label entitlement. See billing for plan details.

​
Where branding appears

Your custom branding is applied across several surfaces:

Verification pages

Public proof pages display your logo and brand colors.

Transactional emails

Emails sent on your behalf (e.g., credential deliveries, team invites) include your logo.

Proof bundles

Downloaded proof bundles reference your brand name and issuer identity.

Credential cards

The credential card shown to recipients uses your primary color and logo.

​
Permissions

Updating branding settings requires the branding.write permission, which is granted to the Tenant Admin and Org Admin roles by default. Any authenticated user with settings.read can view branding settings.

Billing

Plan tiers and the White-Label add-on.

B2B2C delivery

How branded credentials are delivered to consumers.

Custom domains

Serve the verification portal and console from your own domain.