Create an API key

API keys let another system drive AssinaJá — your ERP creating documents, or an AI assistant working through the MCP interface.

Access keys for the AssinaJá public API and MCP. Create one per external system or AI assistant, with access limited to what that integration needs.

One key per integration

Create one key per external system that integrates with the public API (X-Api-Key header). Each key can be suspended or deleted on its own, without affecting the other integrations.

That is the reason for the rule: a shared key cannot be revoked without breaking everything that uses it. A key per system means you can cut off one integration and leave the rest running.

Create one

Choose New API Key.

1. Name — name it after the system that will use it, e.g. ERP Primavera.
2. Expiry date — “The key is valid through this date, inclusive (it stops authenticating at the end of that day).”
3. Access — tick only what this integration needs. At least one is required: “Select at least one access — the key can only do what is checked.”
4. Create key.

The key is shown once

Copy this key and store it somewhere safe. It will not be shown again.

There is no way to retrieve it afterwards. If you lose it, you delete the key and create another.

Scopes

Scope	What it allows
Templates — read	List and inspect templates, including signers and merge fields.
Documents — read	List documents, follow signature progress, and download files and reports.
Documents — create	Create documents from templates, from DOCX (MailMerge) or from your own PDF.
Documents — publish	Publish drafts — sends emails to the signers and is irreversible.
Documents — archive/delete	Archive and delete documents.
Organization — read	See the organization’s details, active plan and available features.
Catálogo de modelos	Enterprise only — see below.

Publish is the dangerous one

Documents — publish envia emails aos signatários e é irreversível. Create and publish are deliberately separate scopes so an integration can prepare drafts for a human to review, without ever being able to send them. Grant it only when the system really should be sending on its own.

The template catalogue scope

Template catalog — serve other organizations is different in kind from the others:

Lets other organizations generate documents from this organization’s template catalog (X-Api-Key-TemplateCatalog header). Grants no other access.

It uses its own header and grants nothing else. It is Available on the Enterprise plan only.

Managing keys

The list shows Name, Key, Access, Expiration, Status, Created and Last used — the last reading Never for a key that has never authenticated. That column is the quickest way to spot a key nobody uses.

Action	Effect
Edit	Change the name, expiry or scopes
Suspend	“While suspended, the key no longer authenticates until it is reactivated.”
Activate	Re-enable a suspended key
Delete	Permanent

A key’s Status is Active, Suspended or Expired.

Suspend before you delete

Suspending is reversible; deleting is not — “is irreversible — the integration using it immediately stops being able to authenticate.” If you suspect a key is compromised or unused, suspend it and see what breaks. You can always reactivate.

Related

• Roles and permissions — managing integrations is Owner and Admin only
• Plans, credits and extras