Skip to content

Get signature settings

Request

Returns the signature configuration for the specified organization.

Security
Bearer or PersonalAccessToken
Path
organizationIdstring, (uuid)required

Unique identifier of the organization

GET
/api/v1/organizations/{organizationId}/settings/signature
curl -i -X GET \
  '/api/v1/organizations/{organizationId}/settings/signature' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

OK

Bodyapplication/json
defaultSignatureTypestring(DefaultSignatureType)required

The default signature types supported by the settings/signature endpoint.

Enum:"ClickToSign""DrawToSign""TypeToSign""RemoteCertificate""Biometric""LocalCertificate""DisposableCertificate""OneTimePassword"
auditTrailModestring(AuditTrailMode)required

The audit trail generation modes supported by the settings/signature endpoint.

Enum:"Standard""PDF/A-2b"
timestampobject(SignatureSettingsTimestamp)required

The organization's timestamp server configuration, excluding the password.

disposableCertificateobject(SignatureSettingsDisposableCertificate)

The organization's disposable certificate configuration, excluding the password.

defaultSignatureLayoutIdstring or null, (uuid)

The identifier of the organization's default signature layout, readable with GET /api/v1/organizations/{organizationId}/settings/signature/layouts/{layoutId}. Read-only. Null until the organization's signature layouts have been read for the first time.

Response
{ "defaultSignatureType": "ClickToSign", "auditTrailMode": "Standard", "timestamp": { "url": "https://timestamp.example.com", "username": "tsa-user", "hashAlgorithm": "SHA-256" }, "disposableCertificate": { "showDisclaimerBeforeCertificateRequest": true, "sendDisposableDisclaimerDocumentNotifications": true, "lraId": "LRA-001", "user": "lra-user", "disposableType": "Disposable" }, "defaultSignatureLayoutId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" }