Assinafy
Measured conclusion: Deep-tested. L2 outcome: tools_ok.
Send documents for legally valid e-signature in Brazil, track signers and download signed files.
| Author | io.github.assinafy |
|---|---|
| Access | remote |
| Publisher key required | No |
| Measured state | Deep-tested |
| L1 liveness | alive |
| L1 latency | 160 ms |
| Last measured | 2026-10-24 |
Add to your agent
Copy this into your MCP client config:
{
"mcpServers": {
"Assinafy": {
"url": "https://mcp.assinafy.com.br/mcp",
"transport": "streamable-http"
}
}
}
Measured tools (27)
assinafy_create_assignmentRequest signatures on a document. Use `method: virtual` to sign without input fields, or `method: collect` to place input fields on specific pages. DigitalCertificate signers require `method: virtual`; other methods fail with code `digital_certificate_requires_virtual`. For **virtual**, the document may be in `uploaded`, `metadata_processing` or `metadata_ready`; it is promoted to `pending_signature` automatically once metadata processing completes. For **collect**, the document must be in `metadata_ready` (fields reference specific pages). `step` controls signing order: signers sharing a step sign in parallel, and the next step is notified only after the previous step completes. If supplied, every signer must supply it and values must be contiguous starting at 1. Obtain signer IDs from assinafy_list_signers or assinafy_create_signer and page IDs from assinafy_get_document. This sends signing invitations. Check with assinafy_get_document that no assignment exists first; this can consume credits.
Parameters:
method(required) — stringsigners(required) — arraydocument_id(required) — string — Document ID.entries— array — Required for `collect`: field placements per page.message— string — Text included in the invitation email.expires_at— string — ISO 8601; default is no expiration. Must be at least one hour in the future.estimate_only— boolean — Preview cost and balances without creating an assignment or notifying anyone.copy_receivers— array — Signer IDs that only receive a copy.
Hints: read-only no · destructive no · idempotent no · open-world yes
assinafy_create_document_from_templateGenerate a document from a saved template and invite one signer per role, by signer ID or full name and email. Find roles with assinafy_list_templates and validate editor_fields values with assinafy_validate_fields first. DigitalCertificate signers require a virtual template without placed fields. This sends invitations and can consume credits.
Parameters:
template_id(required) — string — template IDsigners(required) — ['null', 'array'] — one signer per template role, each by ID or by name and emailname— string — custom document nametags— ['null', 'array'] — tag names, merged with the template's defaultsmessage— string — signing invitation messageaccount_id— string — account ID; uses request routing if omittedexpires_at— string — assignment expiry in RFC 3339 formateditor_fields— ['null', 'array'] — template editor field valuesestimate_only— boolean — preview cost and balances for the given roles without creating contacts, documents or invitations; roles alone are sufficient
Hints: read-only no · destructive no · idempotent no · open-world yes
assinafy_create_signerCreate a signer in the workspace. Search with assinafy_list_signers first to avoid duplicates. Sends no invitation.
Parameters:
full_name(required) — stringemail— stringaccount_id— string — Authorized workspace; discovered from OAuth when omitted.government_id— string — Signer's CPF (11 digits) or CNPJ (14 characters; may be alphanumeric). Formatting is accepted and the value is normalized on save. Required before the signer can use a verification method that identifies them by CPF.whatsapp_phone_number— string — E.164; normalized on save.
Hints: read-only no · destructive no · idempotent no · open-world no
assinafy_delete_documentdestructiveDelete a document only when the user's instruction explicitly authorizes deletion. Inspect its current state first; Assinafy enforces which documents may be deleted.
Parameters:
document_id(required) — string — unique document ID to delete
Hints: read-only no · destructive yes · idempotent no · open-world no
assinafy_download_documentread-onlyDownload a document artifact as base64: original (default), certificated, certificate-page, pades or bundle. Download the signed PDF only when the document is certificated and the artifact is listed.
Parameters:
document_id(required) — string — unique document IDartifact— string — original (default), certificated, certificate-page, pades, or bundle
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_download_document_pageread-onlyDownload the rendered image of a specific document page. Use a page_id returned by assinafy_get_document. Returns base64.
Parameters:
document_id(required) — string — Document ID.page_id(required) — string — The page ID.
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_get_documentread-onlyInspect one known document: status, assignment, signers with their progress, pages and available artifacts. Read it before retrying a send or following up. 100% signed does not mean certification is finished; the signed PDF is ready at status certificated.
Parameters:
document_id(required) — string — unique document ID
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_get_fieldread-onlyRetrieve a single field definition.
Parameters:
field_id(required) — string — The field ID.account_id— string — Authorized workspace; discovered from OAuth when omitted.
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_get_signerread-onlyRetrieve a signer's information.
Parameters:
signer_id(required) — string — The signer ID.account_id— string — Authorized workspace; discovered from OAuth when omitted.
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_get_templateread-onlyGet one saved template with its roles and field placements.
Parameters:
template_id(required) — string — unique template IDaccount_id— string — account ID; uses default if omitted
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_list_document_activitiesread-onlyList the activities recorded for a document. Each entry carries an event-specific `payload` snapshot (keys vary per event) and the request `origin` (`ip`, `user-agent`). Use it to explain what happened to a document and when.
Parameters:
document_id(required) — string — Document ID.
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_list_documentsread-onlySearch workspace documents by name or status, with pagination. Use it to find a document the user names before inspecting or following up on it.
Parameters:
page— integer — page number (1-based)sort— string — name or updated_at; prefix with - for descendingtags— string — comma-separated tag IDs; documents must have all listed tagsmethod— string — signature method filter: virtual or collectsearch— string — partial match on document name or signerstatus— string — document status filterper_page— integer — number of results per page (max 100)account_id— string — account ID; uses request routing if omitted
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_list_fieldsread-onlyList the field definitions of a workspace. When `include_standard` is enabled, records of type `signature`, `initial` and `signatureDate` are also returned. Match definitions to template placement field_id and ask about ambiguous names.
Parameters:
account_id— string — Authorized workspace; discovered from OAuth when omitted.include_inactive— boolean — Include inactive field definitions.include_standard— boolean — Include standard field types (signature, initial, signatureDate).
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_list_signersread-onlyList the signers of a workspace. Use it to resolve a recipient to a signer ID; ask the user about ambiguous matches before sending.
Parameters:
page— integer — Page number.search— string — Filter by full_name or email.per_page— integer — Records per page (max 100).account_id— string — Authorized workspace; discovered from OAuth when omitted.
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_list_templatesread-onlyList saved templates with their signer roles, pages and field placements (field_id). Template authoring is done in Assinafy.
Parameters:
page— integer — page number (1-based)search— string — filter templates by nameper_page— integer — results per pageaccount_id— string — account ID; uses default if omitted
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_list_whatsapp_notificationsread-onlyList all WhatsApp notification messages sent for an assignment. The response includes the rendered template text split into `header`, `body` and `buttons` — exactly what the signer would see. In sandbox/stage, WhatsApp messages are simulated (no real delivery) and button URLs include access/verification codes you can use to simulate the signing flow. Treat returned signing links and verification codes as sensitive; never use them to sign for another person. Use it to troubleshoot WhatsApp delivery for one assignment.
Parameters:
document_id(required) — string — Document ID.assignment_id(required) — string — The assignment ID.
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_place_fieldsread-onlyOpen a visual editor to place signature, initials, date and input fields on a metadata_ready document, then send it with method collect. Takes the assinafy_create_assignment arguments except method and entries. Sends nothing by itself: in apps-capable hosts the user places fields and presses Send; other clients get page sizes and field IDs as text to build entries.
Parameters:
signers(required) — arraydocument_id(required) — string — Document ID.message— string — Text included in the invitation email.expires_at— string — ISO 8601; default is no expiration. Must be at least one hour in the future.copy_receivers— array — Signer IDs that only receive a copy.
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_rename_documentdestructiveUpdate a document's name. Only allowed before any assignment is created (i.e. while the document is in `uploaded` or `metadata_ready` status and has no signers yet); once the signature process has started or the document is certificated, the name is locked. The name is normalized: diacritics are removed and unsupported characters are replaced with dashes.
Parameters:
name(required) — stringdocument_id(required) — string — Document ID.
Hints: read-only no · destructive yes · idempotent no · open-world no
assinafy_resend_notificationSend one reminder to a pending signer in the assignment's active step, after confirming with assinafy_get_document that they have not signed. May consume notification credits; never repeat a reminder only because progress is unchanged.
Parameters:
document_id(required) — string — unique document IDassignment_id(required) — string — unique assignment IDsigner_id(required) — string — unique signer ID to notifyestimate_only— boolean — preview the reminder cost and balances without notifying the signer
Hints: read-only no · destructive no · idempotent no · open-world yes
assinafy_review_signature_requestread-onlyPreview an assinafy_create_assignment call without sending anything: same arguments, checked against the document and signers. Use it when the user wants to review before sending. Apps-capable hosts render a card whose Send button performs the request; other clients get the summary as text, and the request is sent only after the user confirms.
Parameters:
method(required) — stringsigners(required) — arraydocument_id(required) — string — Document ID.entries— array — Required for `collect`: field placements per page.message— string — Text included in the invitation email.expires_at— string — ISO 8601; default is no expiration. Must be at least one hour in the future.copy_receivers— array — Signer IDs that only receive a copy.
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_send_pdf_for_signatureUpload a new PDF, wait for processing and invite signers by full name and email, using Email verification and notification. This sends invitations and uses plan allowance: use only recipients the user authorized. After a partial failure, inspect the retained document ID and continue with assinafy_create_assignment instead of uploading again.
Parameters:
file_name(required) — string — PDF filename including the .pdf extensionfile_base64(required) — string — base64-encoded PDF bytes (max 25 MB decoded)signers(required) — ['null', 'array'] — one or more signers to create or reuse and request signatures frommessage— string — invitation message shown to signerspoll_secs— integer — polling interval in seconds (default 2; cannot exceed max_wait_secs)account_id— string — account ID; uses the request or server default if omittedexpires_at— string — assignment expiry timestamp in RFC 3339 formatestimate_only— boolean — upload and prepare the PDF, then return cost and document ID without creating contacts or sending invitations; reuse that ID to sendmax_wait_secs— integer — maximum seconds to wait for PDF processing (default 30; max 600)
Hints: read-only no · destructive no · idempotent no · open-world yes
assinafy_set_assignment_expirationChange when an existing signature request expires, using an RFC 3339 timestamp. Assinafy may refuse for requests that already expired.
Parameters:
document_id(required) — string — unique document IDassignment_id(required) — string — unique assignment IDexpires_at(required) — string — new expiry timestamp in RFC 3339 format
Hints: read-only no · destructive no · idempotent no · open-world no
assinafy_show_documentread-onlyShow a status card for one known document: its status, who has signed, who is still pending and when it expires. Apps-capable hosts render it with a reminder button; other clients get the same summary as text. Resolve the document with assinafy_list_documents first.
Parameters:
document_id(required) — string — unique document ID
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_update_signerdestructiveUpdate a signer's information. **Verification integrity:** `email` / `whatsapp_phone_number` cannot be changed while the signer has verified that channel on an in-flight (not yet certificated) document — the response is `400` naming the offending document(s). Already-certificated documents do not block updates. Changing a channel that has *unverified* in-flight requests rotates their access/verification codes (invalidating previously sent links/OTPs); use the resend endpoint to redeliver. `full_name` can always be updated.
Parameters:
signer_id(required) — string — The signer ID.email— stringfull_name— stringaccount_id— string — Authorized workspace; discovered from OAuth when omitted.government_id— string — Signer's CPF (11 digits) or CNPJ (14 characters; may be alphanumeric). Formatting is accepted and the value is normalized on save. Required before the signer can use a verification method that identifies them by CPF.whatsapp_phone_number— string — E.164; normalized on save.
Hints: read-only no · destructive yes · idempotent no · open-world no
assinafy_upload_documentUpload a PDF without sending invitations and return its document ID. Use it when the user wants to prepare a document now and send it later with assinafy_create_assignment. Never upload again when a document ID is already known.
Parameters:
file_name(required) — string — PDF filename including .pdffile_base64(required) — string — base64 PDF bytes, at most 25 MiB decodedaccount_id— string — authorized workspace; discovered through OAuth when omitted
Hints: read-only no · destructive no · idempotent no · open-world no
assinafy_validate_fieldsread-onlyValidate one or more input values against existing field definitions without creating a document or requesting signatures. Supply field/value pairs in values; the server sends the documented JSON array. Check each result's success before requesting signatures.
Parameters:
values(required) — array — Field/value pairs to validate; sent to Assinafy as the JSON request array.account_id— string — Authorized workspace; discovered from OAuth when omitted.
Hints: read-only yes · destructive no · idempotent yes · open-world no
assinafy_verify_documentread-onlyVerify a signed document using its actual Assinafy SHA-1 signature hash. Public lookup; requires no workspace connection and sends no credential upstream.
Parameters:
hash(required) — string — SHA-1 signature hash of the signed document
Hints: read-only yes · destructive no · idempotent yes · open-world no
Measured by MCPYP probing. Untested fields are omitted, never estimated. Listing is always free; MCPYP never proxies calls or stores user tokens.