GET api/Configuration/SigningRoomSettings

Allows a SAFEAdmin to get the default SigningRoom settings, and allows a client admin to get the client's SigningRoom settings.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

The SigningRoom settings.

ESignSystems.SmartSAFE.Models.SigningRoomManager.SigningRoomSettingsModel

Name	Description	Type	Additional information
SigningRoomSettingsId	Gets or sets the SigningRoom settings identifier.	integer	None.
SigningRoomUrl	Gets or sets the SigningRoom settings' SigningRoom URL.	string	Required Max length: 255
OrganizationId	Gets or sets the SigningRoom settings' organization identifier.	integer	None.
ClientId	Gets or sets the SigningRoom settings' client identifier.	integer	None.
EnableSelfRegistration	Gets or sets a value indicating whether self registration is enabled.	boolean	Required
AcknowledgeSignerConsent	Gets or sets a value indicating whether to acknowledge signer consent.	boolean	Required
SignatureFontRequired	Gets or sets a value indicating whether font selection is required.	boolean	Required
EsignConsentRequired	Gets or sets a value indicating whether the esign consent is required.	boolean	Required
ESignConsentText	Gets or sets the SigningRoom settings' esign consent text.	string	Required
ESignConsentDeclineConfirmation	Gets or sets a value indicating whether to confirm the decline esign consent.	boolean	Required
ESignConsentDeclineConfirmationText	Gets or sets the esign consent decline confirmation text.	string	Required
ESignConsentDeclinedText	Gets or sets the esign consent declined text.	string	Required
SigningRoomExpirationReminderInDays	Gets or sets the signing room expiration reminder in days.	integer	Required
DefaultSignatureFont	Gets or sets the Default Signature Font.	string	Required Max length: 256
AllowSignersToUploadDocuments	Gets or sets the value indicating whether [Allow Signers To Upload Documents].	boolean	Required
EnableContinuousSigning	Gets or sets a value indicating whether continuous signing is enabled.	boolean	Required
RequireParticipantLogin	Gets or sets a value indicating whether to require participant login.	boolean	Required
EnableAutoScrolling	Gets or sets the value indicating whether auto-scrolling is enabled.	boolean	Required
ApplyToAll	Gets or sets a value indicating whether the saved settings should be applied to all potential subordinate organization or client settings depending on the hierarchy.	boolean	None.
UpdatedBy	Gets or sets the name of the user that updated the model.	string	None.
UpdatedDate	Gets or sets the date an time that the model was updated.	date	None.

Response Formats

application/json, text/json

Sample:

{
  "SigningRoomSettingsId": 1,
  "SigningRoomUrl": "sample string 1",
  "OrganizationId": 1,
  "ClientId": 1,
  "EnableSelfRegistration": true,
  "AcknowledgeSignerConsent": true,
  "SignatureFontRequired": true,
  "EsignConsentRequired": true,
  "ESignConsentText": "sample string 6",
  "ESignConsentDeclineConfirmation": true,
  "ESignConsentDeclineConfirmationText": "sample string 8",
  "ESignConsentDeclinedText": "sample string 9",
  "SigningRoomExpirationReminderInDays": 10,
  "DefaultSignatureFont": "sample string 11",
  "AllowSignersToUploadDocuments": true,
  "EnableContinuousSigning": true,
  "RequireParticipantLogin": true,
  "EnableAutoScrolling": true,
  "ApplyToAll": true,
  "UpdatedBy": "sample string 17",
  "UpdatedDate": "2026-01-01T17:28:18.8939473-05:00"
}

application/xml, text/xml

Sample:

<SigningRoomSettingsModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models.SigningRoomManager">
  <UpdatedBy xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">sample string 17</UpdatedBy>
  <UpdatedDate xmlns="http://schemas.datacontract.org/2004/07/ESignSystems.SmartSAFE.Models">2026-01-01T17:28:18.8939473-05:00</UpdatedDate>
  <AcknowledgeSignerConsent>true</AcknowledgeSignerConsent>
  <AllowSignersToUploadDocuments>true</AllowSignersToUploadDocuments>
  <ApplyToAll>true</ApplyToAll>
  <ClientId>1</ClientId>
  <DefaultSignatureFont>sample string 11</DefaultSignatureFont>
  <ESignConsentDeclineConfirmation>true</ESignConsentDeclineConfirmation>
  <ESignConsentDeclineConfirmationText>sample string 8</ESignConsentDeclineConfirmationText>
  <ESignConsentDeclinedText>sample string 9</ESignConsentDeclinedText>
  <ESignConsentText>sample string 6</ESignConsentText>
  <EnableAutoScrolling>true</EnableAutoScrolling>
  <EnableContinuousSigning>true</EnableContinuousSigning>
  <EnableSelfRegistration>true</EnableSelfRegistration>
  <EsignConsentRequired>true</EsignConsentRequired>
  <OrganizationId>1</OrganizationId>
  <RequireParticipantLogin>true</RequireParticipantLogin>
  <SignatureFontRequired>true</SignatureFontRequired>
  <SigningRoomExpirationReminderInDays>10</SigningRoomExpirationReminderInDays>
  <SigningRoomSettingsId>1</SigningRoomSettingsId>
  <SigningRoomUrl>sample string 1</SigningRoomUrl>
</SigningRoomSettingsModel>