Get the Sign settings

GET
/v1/sign/settings

The API key's environment's settings: which sites may embed the signing page, how it looks, and the consent text signers accept.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Header Parameters

Coss-Version?"2026-10-10"

The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.

Value in"2026-10-10"

Response Body

The settings.

application/json
  1. response
object*"sign_settings"
Value in"sign_settings"
allowed_origins*array<string>

Origins that may embed the signing page in an iframe, like https://app.example.com (sandbox environments also http://localhost:<port>). Empty: it can only be opened on its own.

display_name*|

The requester's name signers see. null: the organization's name.

accent_color*string|null
theme*string
Value in"system""light""dark"
disclosure*|

Your own consent text signers accept before they see a document. null: coss.com's default, which covers ESIGN's consumer disclosure. Have your counsel review a replacement.

email_from*|

Signing emails (invitations, reminders, signed copies) come from this address, on a verified domain in live environments. null: from coss.com, as " via coss.com".

reminder_interval_days*|

The default days between reminders for new requests; null: none.

import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.sign.settings.get();
{  "object": "sign_settings",  "allowed_origins": [    "https://app.example.com"  ],  "display_name": "Acme",  "accent_color": "#2563eb",  "theme": "system",  "disclosure": null,  "email_from": "contracts@acme.com",  "reminder_interval_days": 3}