📖 Table of contents
What is an API key?
An API key allows your application to authenticate with the Yousign API.
It identifies your organization and enables secure exchanges of data, documents, and services through API requests.
Each API key is defined by:
An environment (Sandbox or Production)
A scope, which determines which resources the key can access
A permission level (Full-access or Read-only)
How to create an API key
Go to the Developers section in the left-hand menu.
Click API keys.
If this is your first API key, click Start integration (Sandbox environment).
Otherwise, click New API key at the top of the page.
Creating your first API key automatically starts your API trial period.
You will need to complete the following information:
1. Description
Enter a name for your API key.
This field is optional, but recommended if you plan to create multiple API keys. Use a short description to identify its purpose (for example: “CRM integration – Production”).
2. Environment
Choose where the API key will be used:
Sandbox: Test environment for API integration.
Select this if you are starting your integration or do not yet have a paid API plan.
Production: Live environment for your integration.
Available only if you have subscribed to an API plan.
3. Scope
Define the scope of your API key.
The scope determines the maximum set of resources the key can access.
You can choose between:
Organization scope
The API key can access resources across all workspaces in your organization.
This option allows the API key to access all data in the organization.
Suitable for global or platform-level integrations.
Workspace scope
The API key can access resources only within selected workspaces.
You must select one or more workspaces during creation.
Resources outside those workspaces are not accessible.
The key cannot manage users or workspaces.
Workspace scope allows you to isolate data between different teams, projects, or end-customers.
4. Permission level
Choose the level of access:
Full-access: Can create and update resources via API requests.
Read-only: Can only retrieve information via API requests.
Once all fields are completed, click Create API key.
Your new key will appear in the API key list, where you can view its:
Environment
Permission level
Scope
You can also use filters and navigation options on the API keys page to quickly find specific keys.
How many API keys can I create?
You can create up to 200 active API keys per organization.