System Settings - SigningHub-APIGuide

Business applications can use this service API to get the system settings of a logged in enterprise user.

https://api.signinghub.com/v3/system/configurations/global
HTTP Verb		GET
Authorization		Bearer {access_token}
Accept		application/json
Request Body
Status Code	Message	Response Body
200	OK	`{` `"installation_name":` `"SigningHub",` `"company_name":` `"Acertia Ltd.",` `"web_address":` `"https://web.signinghub.com",` `"api_address":` `"https://api.signinghub.com",` `"create_account_webpage":` `"https://www.server.com/plans",` `"privacy_policy_webpage":` `"https://www.server.com/term-use",` `"term_of_services_webpage":` `"https://www.server.com/term-use",` `"default_country":` `"United Kingdom",` `"allow_changing_country":` `true,` `"default_timezone":` `"(UTC) Dublin, Eddinburg, Lisbon, London",` `"allow_changing_timezone":` `true,` `"default_language":` `"en-US",` `"allow_changing_language":` `true,` `"password_policy": {` `"minimum_length": 8,` `"include_numbers":` `true,` `"include_uppercase":` `true,` `"include_special_characters":` `true` `},` `"session_timeout": 15,` `"support_email":` `"support@ascertia.com",` `"system_error_email":` `"support@ascertia.com",` `"google_play_store_url":` `"http://www.apple.com",` `"apple_app_store_url":` `"http://www.google.com",` `"allow_national_id":` `true,` `"google_analytics_mobile_web":` `"e8b32994-68ea-496c-b9bb-d765d9a14526",` `"bing_analytics_mobile_web":` `"b9bb-d765d9a14526",` `"error_notification_timeout": 15,` `"allow_marketing_emails":` `true` `}`
403	Forbidden	`{` `"Message":` `"Account is disabled"` `}`
500	Internal Server Error	`{` `"Message":` `"An internal server error occurred while processing the request"` `}`

The detail of each item provided in the request and response is provided below:

Item Details
Names	Description
Response Parameters
access_token	OAuth access token obtained as a result of successful authentication via "client_credentials" grant type.
installation_name	Name of the installation.
company_name	Name of the company
web_address	Address of the web module for SigningHub solution.
api_address	Address of the API module for SigningHub solution.
create_account_webpage	Link to create account page. If there is no register page value can be "none".
privacy_policy_webpage	Link to the privacy policy page.
term_of_services_webpage	Link to terms of services.
default_country	Default country for the application.
allow_changing_country	True if users are allowed to change the country.
default_timezone	Default time zone of the application.
allow_changing_timezone	True if users are allowed to change their time zones later.
default_language	Default language of the application.
allow_changing_language	True if language change is allowed by the end user.
password_policy	Password policy object applied to the whole application.
password_policy > minimum_length	Minimum length of the password policy.
password_policy > include_numbers	True, if numbers must be added in a password.
password_policy > include_uppercase	True, if upper case letters must be added in a password.
password_policy > include_special_characters	True, if special characters must be added in a password.
session_timeout	Allowed session timeout value for which user can remain inactive.
support_email	Email address where support emails are sent.
system_error_email	Email address where error emails are sent.
google_play_store_url	Link to google android application.
apple_app_store_url	Link to apple IOS application.
allow_national_id	True, if users are allowed to add National ID. This helps to identify users in the workflow.
google_analytics_mobile_web	Returns the Google analytics code.
bing_analytics_mobile_web	Returns the Bing analytics code.
error_notification_timeout	Time to display an error notification message on the screen across the application.
allow_marketing_emails	True, if promotional emails opt-in consent for user on registration is configured in application.
Message	The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.