Documentation | CodeSign Secure

How the documentation is organized

Section	What you’ll find
Overview	About CodeSign Secure, a step-by-step getting-started walkthrough, this guide, a tour of the portal, troubleshooting, the FAQ, and the glossary.
Reference Guide	Every area of the CodeSign Secure portal, from the header bar and dashboard to System Setup.
Setup & Architecture	How sign-in and access control work, the architecture and its components, installing CodeSign Secure on Windows, and security guidance.
Release Notes	What changed in each release, grouped by year.
API Reference	Getting a token, request and response conventions, and every endpoint by area.
Integration Guides	Signing each file type with its native tools, and signing from CI/CD pipelines.

Page Layout at a Glance

Every page of the documentation shares the same layout. The screenshot below shows a typical page with its main navigation features numbered. Each number is described in the table that follows the screenshot.

Tip: Hover over a numbered marker or an area of the screenshot to see the name of that feature, and click it to jump to its description.

No.	Feature	Description
1	CodeSign Secure Logo	Takes you back to the Overview page, the starting point of the documentation, from any page.
2	Section List	The sidebar lists every section of the documentation: Overview, Reference Guide, Setup & Architecture, Release Notes, API Reference, and Integration Guides. Click a section name to open it.
3	Section Arrow	An arrow next to a section or page means that it contains further pages. When you open that section or page, it expands in the sidebar to list the pages it contains.
4	Current Section	The section that contains the page you are reading is highlighted and expanded, so you can always see which part of the documentation you are in and move to another page in the same section.
5	Current Page	The page you are reading is highlighted within its section. When you reload a page or open another one, the sidebar keeps this page in view.
6	Breadcrumb	Shows where the current page sits in the documentation, for example API Reference > Securing API Access. Click the first item to go to the parent page.
7	Search Box	Searches all sections of the documentation as you type. Use the arrow keys and Enter to open a result. For details, see Finding information.
8	Help and Support	Opens the Encryption Consulting contact page, where you can reach the support team if you cannot find what you need in the documentation.
9	Page Title	The name of the page you are reading. It matches the page name in the sidebar and the last item of the breadcrumb.
10	On this Page	Lists the headings of the current page. Click a heading to jump to that part of the page. As you scroll, the heading you are currently reading is highlighted.
11	Previous and Next	Move to the previous or next page in reading order. Reading order follows the sidebar from top to bottom, so you can read a whole section page by page.
12	Page Counter	Shows the position of the current page within the documentation, for example 64 OF 116.
13	Back to Top	Appears in the lower-right corner once you scroll down a page. Click it to return to the top of the page.
14	Social Links	Links to the Encryption Consulting pages on X, Facebook, LinkedIn, and YouTube.
15	Support and Legal Links	Links to Encryption Consulting support, the privacy policy, and the terms of service.

Note: The documentation is designed for desktop browsers. On screens below 767px, the sidebar is hidden; open it with the menu button at the top of the page.

Menu button at the top of the page on a small screen

Finding information

Sidebar: expand a section to see its pages. The page you are on is highlighted.
Search: type in the search box at the top of every page to search all pages, including the API Reference. Use the arrow keys and Enter to open a result.
On this Page: the list on the right links to each part of the current page.
Breadcrumb: the path at the top shows the section the page belongs to.
Previous and Next: the arrows at the bottom of each page move through the documentation in sidebar order.

Conventions

Convention	Meaning	Example
Bold text	A button, field, menu, or page in the portal	System Setup > User > Register User
Code style	A command, file name, path, variable, or value you type	signtool verify /pa setup.exe
Angle brackets	A placeholder to replace with your own value	https://<your domain>/api/
Note	Additional information, a tip, or something important to check before you continue

Screenshots show example data. Names, dates, and values in your portal will differ.

Versions

This documentation covers CodeSign Secure 3.02.01. To see the version you run, hover over the version in the profile menu of the header bar; the portal footer shows the frontend and backend versions. For what changed in each release, see Release Notes.

Getting help

For common problems and their fixes, see Troubleshooting and the FAQ.
For the meaning of a term, see the Glossary.
To contact Encryption Consulting, select Support in the footer of any page. Include the product version, what you were doing, and the full error text. A support package from Profile > Maintenance helps the support team diagnose server issues.