Get SigningHub Admin Branding - SigningHub-APIGuide

Retrieve the default branding of SigningHub Application as set by the SigningHub administrator via the administration console. This includes the logo, favicon and colours that comprise the branding options. Note this is not to be confused with the Enterprise level branding. For these settings click here.

https://api.signinghub.com/v3/system/configurations/branding
HTTP Verb		GET
Authorization		Bearer {access_token}
x-base64		true
Accept		application/json
Request Body
Status Code	Message	Response Body
200	OK	`{` `"logo":` `"base64",` `"logo_url":` `"https://api_link_to_resource",` `"favicon":` `"base64",` `"favicon_url":` `"https://api_link_to_resource",` `"colors": {` `"level_1":` `"#fff",` `"level_2":` `"#fff",` `"level_3":` `"#fff",` `"level_4":` `"#fff",` `"level_5":` `"#fff",` `"level_6":` `"#fff",` `"level_7":` `"#fff",` `"level_8":` `"#fff",` `"level_9":` `"#fff",` `"level_10":` `"#fff",` `"level_11":` `"#fff",` `"level_12":` `"#fff",` `"level_13":` `"#fff"` `}` `}`
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
Request Parameters
access_token	OAtuh access token obtained as a result of successful authentication via "client_credentials" grant type.
logo	Base64 logo as set in SigningHub Administration application.
logo_url	API endpoint to access the resource
favicon	Base64 encoded string of the favicon image.
favicon_url	API endpoint to access the resource
level_1	Headings, top bar buttonns, toaster messages, tooltips, and icons excluding those menetioned under Level 2.
level_2	Call to action buttons, dialog top border, document list top border, settings bottom border, toaster message border, recipients list border, selected heading text and icons, heading text in success dialogs, document counts on dashboard, checkbox selection, and back, and progress icons.
level_3	Toaster message border for errors, validation errors text, form field border for validation errors, and asterisks used to represent mandatory fields.
level_4	Navigation tab border.
level_5	Text in buttons, and toaster messages, cross icon in toaster messages, and headings in top bar.
level_6	Separator lines in dashboard, menus and header.
level_7	Active form fields and, notifications count borders.
level_8	Active form fields, hand signature border on signing dialog, and notifications count.
level_9	Disabled form fields.
level_10	Dashboard and main menu backgrounds.
level_11	Remind icon, notification banner, placeholder labels, and highlighted rows.
level_12	List rows selection, selected document filter, recipient selection in document viewer, and settings menu selection.
level_13	Field icons on document viewer.
Response Parameters
Message	The service specific error message returned by the API. This message provides useful information about why the service has returned an error response.