This document is generated by Apidog. Apidog: All-in-one workspace for API design, document, debug, test, mock
MCP tools
Conventions
pageNumber (from 1) and pageSize (up to 100) and come back in the route's default order.fromDate and toDate as YYYY-MM-DD, counted in timeZone (an IANA name such as America/Sao_Paulo, UTC when omitted), up to 366 days.Account
| Tool | What it does | REST route | Who |
|---|---|---|---|
get_account | The account behind the token: tenant, account, user, plan, envelope balance, seats, subscription, and whether the token works on the sandbox. | GET /v1/account | Everyone |
Vaults
| Tool | What it does | REST route | Who |
|---|---|---|---|
list_vaults | The vaults you can reach, with their members. Filters by name and favorites. | GET /v1/ecm/vaults/user-accounts | Everyone |
list_vault_items | The envelopes and templates of a vault, with their status. Filters by name, kind and envelope status. | GET /v1/ecm/vaults/{vaultId}/list | Everyone |
Envelopes
| Tool | What it does | REST route | Who |
|---|---|---|---|
list_envelopes | Envelopes with their status, vault, owner and signers. Filters by status, vaults, owner, text, creator, trash, period and expiry. | GET /v1/ecm/envelopes | Everyone; administrators with scope Account |
get_envelope | An envelope with its documents, signers, progress and settings. | GET /v1/ecm/envelopes/{envelopeId} | Everyone |
create_envelope | Creates a draft envelope with its signers, documents, seal and settings, and answers it as get_envelope does. | POST /v1/ecm/envelopes | Everyone |
update_envelope | Changes a draft envelope: name, descriptions, message, dates, signers, documents, seal and settings. | PUT /v1/ecm/envelopes/{envelopeId} | Everyone |
publish_envelope | Invites the signers and starts collecting signatures. Debits one envelope from the balance. | POST /v1/ecm/envelopes/{envelopeId}/publish | Everyone |
hold_envelope | Pauses a published envelope until it is published again. | POST /v1/ecm/envelopes/{envelopeId}/hold | Everyone |
cancel_envelope | Cancels an envelope still collecting signatures. | POST /v1/ecm/envelopes/{envelopeId}/cancel | Everyone |
get_envelope_certificate_link | A short-lived link to the audit certificate. | GET /v1/ecm/envelopes/{envelopeId}/certificate | Everyone |
list_envelope_accesses | Who opened one envelope, and how. | GET /v1/ecm/envelopes/{envelopeId}/accesses | Everyone |
list_pending_envelopes | Published envelopes still waiting for signatures, with the signer each one waits on, idle days and urgency. | GET /v1/ecm/envelopes/pending | Administrators |
list_account_accesses | Who opened the account's envelopes. Filters by vault, grant, link policy and period. | GET /v1/ecm/envelopes/accesses | Administrators |
Signers
| Tool | What it does | REST route | Who |
|---|---|---|---|
get_signer_signature_link | A signing link for one signer of a published envelope, to deliver through your own channel. | POST /v1/ecm/envelopes/{envelopeId}/signers/{signerId}/signature-links | Everyone |
get_signer_evidence_links | Five-minute links to the selfies and identity document images a signer sent. | GET /v1/ecm/envelopes/{envelopeId}/signers/{signerId}/evidence-images | Everyone |
list_signer_actions | What signers did across the account, with IP and place. | GET /v1/ecm/signers/actions | Administrators |
get_signer_actions_summary | The signer actions of a period, summarized. | GET /v1/ecm/signers/actions/summary | Administrators |
Templates and documents
| Tool | What it does | REST route | Who |
|---|---|---|---|
list_templates | The templates you can reach. Filters by text and vaults. | GET /v1/ecm/templates | Everyone; administrators with scope Account |
get_template | A template and the fields it expects. | GET /v1/ecm/templates/{templateId} | Everyone |
get_template_versions | The versions of a template and how many envelopes each one produced. | GET /v1/ecm/templates/{templateId}/versions | Everyone |
list_template_envelopes | The envelopes created from a template. | GET /v1/ecm/templates/{templateId}/envelopes | Everyone |
create_document_from_template | Generates a document from a template with its fields filled, ready to attach to an envelope. | POST /v1/ecm/documents/templates | Everyone |
get_document | A document's metadata and the size of each page. | GET /v1/ecm/documents/{documentId} | Everyone |
get_document_links | Short-lived links to the original and the signed file. The signed link is null until the envelope is signed and sealed. | GET /v1/ecm/documents/{documentId}/original and /signed | Everyone |
list_seals | The seals available to the account. | GET /v1/ecm/seals | Everyone |
Contacts
| Tool | What it does | REST route | Who |
|---|---|---|---|
list_contacts | The account's contacts. Filters by text and favorites. | GET /v1/ecm/contacts | Everyone |
create_contact | A contact to reuse as a signer. | POST /v1/ecm/contacts | Everyone |
Members and invites
| Tool | What it does | REST route | Who |
|---|---|---|---|
list_users | Members, active or inactive, with their e-mail and role. | GET /v1/administration/user-accounts | Administrators |
get_user | One member. | GET /v1/administration/user-accounts/{userAccountId} | Administrators |
list_invites | Invites still waiting for an answer. | GET /v1/administration/invites | Administrators |
Usage
| Tool | What it does | REST route | Who |
|---|---|---|---|
get_usage_balance | The envelope balance, its lots and its projection. | GET /v1/account/usage/balance | Administrators |
get_usage_statement | Credits, debits and expirations of the balance. | GET /v1/account/usage/statement | Administrators |
get_usage_allocation | Who consumed the balance, per vault, member or both. | GET /v1/account/usage/allocation | Administrators |
get_usage_storage | Storage per vault. | GET /v1/account/usage/storage | Administrators |
Webhooks
| Tool | What it does | REST route | Who |
|---|---|---|---|
list_webhooks | Webhook receivers, active or inactive. | GET /v1/core/webhooks | Administrators |
get_webhook | One receiver. Credentials come only as flags saying whether each one is set. | GET /v1/core/webhooks/{webhookId} | Administrators |
list_webhook_deliveries | Deliveries with their state and, when one was not sent, why. | GET /v1/reports/webhooks | Administrators |
Reports
| Tool | What it does | REST route | Who |
|---|---|---|---|
get_dashboard | The home dashboard of a period: envelope counts by state, activity, top signers, authentication methods and signatures by place. The whole account for administrators, the vaults in reach for members. | GET /v1/reports/dashboard | Everyone |
get_envelope_summary_report | Envelopes of a period: status, activity, the signing funnel, outcomes and completion times. | GET /v1/reports/envelopes/summary | Administrators |
get_signers_identity_report | How signers proved who they are, and the failed attempts per factor. | GET /v1/reports/signers/identity | Administrators |
get_signers_notifications_report | Notifications sent to signers, per channel, kind and vault. | GET /v1/reports/signers/notifications | Administrators |
get_team_productivity_report | The work of each member, the open portfolio and completion time. | GET /v1/reports/team/productivity | Administrators |
get_templates_performance_report | How templates performed: usage, time to complete and outcomes. | GET /v1/reports/templates/performance | Administrators |
get_envelope_sealing_report | Sealing, timestamps and long-term validation, per seal and per vault. | GET /v1/reports/envelopes/sealing | Administrators |
get_envelope_blockchain_report | Blockchain anchoring: activity over time and events per type. | GET /v1/reports/envelopes/blockchain | Administrators |
Not available through MCP
create_envelope takes documents uploaded through the REST API or generated with create_document_from_template.Modified at 2026-11-01 23:57:05