API access is managed inside the workspace settings.
From the Account Dashboard, open the workspace menu and choose API access, or open the workspace and go to Settings > Integrations > API access.
When creating a new API client, Worthic shows a form with several fields. These fields decide what the integration can do.
Client name
This is the label for the integration.
Use a clear name that tells you what the token is for, such as:
- Receipt scanner
- Accountant import tool
- Custom dashboard
- AI document assistant
This name helps you recognise the client later in the Existing clients list.
Client type
Client type identifies what kind of external collaborator this API client represents: an API, an agent, or an integration. Worthic uses this to label the connection clearly, apply the right audit context, and make it easier to understand who or what created documents, transactions, or proposals in the workspace.
Purpose
Purpose describes what this API client is meant to do in the workspace, such as uploading documents, syncing transactions, submitting entries for review, or supporting an external workflow. Worthic uses the selected purpose to suggest sensible permissions. Permissions can still be edited, in which case the permissions field will display as Custom.
Role
The role controls the general level of access.
Viewer means the client can only read information that you explicitly allow. It cannot submit transactions unless you create a more powerful client.
Editor means the client can be granted write-style permissions, such as uploading documents or submitting transactions.
Choose Viewer unless the integration genuinely needs to send information into Worthic.
Reporting-line access
This controls which reporting lines the API client can access.
A reporting line is the person, business, property, trust, or other financial area inside your workspace. If you only give access to one reporting line, the client will not be able to see records belonging only to another reporting line.
For example, you may allow a property integration to access only a real estate reporting line, not your personal financial records.
Document upload
This allows the client to upload documents into Worthic.
Use this for tools that send invoices, receipts, statements, contracts, or other records into the workspace.
If this is not enabled, the client will not be able to upload documents.
Document download
This allows the client to download documents it has permission to access.
Be careful with this permission. Downloading documents means copies may leave Worthic and be stored in another system.
Only enable this for integrations that truly need the original files.
Write transactions as pending review
This controls how API-submitted transactions are handled.
When this option is enabled, transactions submitted by the API are created for review before they are treated as final. This is safer for most integrations because you can check the result inside Worthic first.
When this option is not enabled, an Editor API client may submit transactions more directly, depending on the integration rules.
You will still be able to edit transactions inside Worthic, regardless of whether they are sent as confirmed or pending review.
Token
After you create API access, Worthic shows the token once.
The token is the actual secret key the external system uses to connect. The prefix or visible client label is not enough. The full token is needed.
Copy it and paste it into the trusted external tool. Store it carefully. Worthic does not show the full token again after this point.
If you lose the token, create a new one and revoke the old client.