Docs
Dashboard Get an API key

Domains

List domains

Your custom signing domains and their verification status.

GET/v1/domains

A verified domain can be passed as domain_host when creating a pact, so signers see your domain and branding. Domains are added and verified on the dashboard (a DNS TXT record), not through the API. Pro includes one and Business three; more can be added on the Billing page.

Authorization

Authorizationstringheaderrequired
Bearer followed by your API key: Bearer sgk_…. The key also works in an X-Api-Key header. See Authentication.

Response

200 OKEvery domain on the account, by host name.
dataarray of objects
The domains.
ShowHide domain attributes
hoststring
The custom domain, such as sign.example.com.
statusstring
Only a verified domain can be used to send.
One of pending verified disabled
brand_namestring | null
The name shown on signer pages and emails sent under it.
date_verifiedstring (date-time) | null
When its DNS record was verified.
date_checkedstring (date-time) | null
When its DNS record was last checked.
totalinteger
How many there are.

Errors

StatusWhen
401 UnauthorizedThe API key is missing, wrong or revoked.
403 ForbiddenThe account's plan does not include API access (Pro and Business do).

Every error body is { "error": "message" }. See Errors.