Assinafy

Send documents for legally valid e-signature in Brazil, track signers and download signed files.

Should I use this

Quality & Safety

A
Description quality
99%
Schema completeness
97%
Naming quality
75%
Poisoning risk
100%
Permission match
90%
Protocol compliance
100%

Findings (8)

  • LOWTool 'assinafy_create_document_from_template' name length outside 3-30 rangein assinafy_create_document_from_template
  • LOWTool 'assinafy_download_document_page' name length outside 3-30 rangein assinafy_download_document_page
  • LOWTool 'assinafy_list_document_activities' name length outside 3-30 rangein assinafy_list_document_activities
  • LOWTool 'assinafy_list_whatsapp_notifications' name length outside 3-30 rangein assinafy_list_whatsapp_notifications
  • LOWTool 'assinafy_review_signature_request' name length outside 3-30 rangein assinafy_review_signature_request
  • LOWTool 'assinafy_send_pdf_for_signature' name length outside 3-30 rangein assinafy_send_pdf_for_signature
  • LOWTool 'assinafy_set_assignment_expiration' name length outside 3-30 rangein assinafy_set_assignment_expiration
  • LOWTool 'assinafy_browse_contracts' suggests web access but openWorldHint=falsein assinafy_browse_contracts

Based on automated analysis of tool definitions and protocol compliance.

Context Cost

~12,556Tokens (tool definitions)
~4.3 KBTypical response size
Significant attention impact (9.81% of 128k context)

This is the approximate number of tokens consumed each time the server's tools are loaded into a model's context. Higher counts reduce the attention available for other tasks.

Install

One-Click Install

Add this to your `claude_desktop_config.json` file:

{
  "mcpServers": {
    "mcp-server": {
      "url": "https://mcp.assinafy.com.br/mcp"
    }
  }
}

Remote endpoints

https://mcp.assinafy.com.br/mcpstreamable-http

What it can do

Tool inventory

Tools (29)

🟒 Read-only🟑 WriteπŸ”΄ Deleteβšͺ Unknown
🟒assinafy_browse_contracts(account_id, action, counterparty, document_id, end_date_from, ...)

Find contracts with action list and filters, read terms or an amendment with get, or read the root and its amendments with related. Resolve names before writes. Apps-capable hosts show a contract browser; other clients receive the same JSON. Contract lifecycle dates are separate from signing deadlines. Reads remain available when the tracking plan lapses.

Input Schema

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "minLength": 1
    },
    "action": {
      "type": "string",
      "enum": [
        "list",
        "get",
        "related"
      ]
    },
    "counterparty": {
      "type": "string",
      "description": "Part of the counterparty name."
    },
    "document_id": {
      "type": "string",
      "minLength": 1
    },
    "end_date_from": {
      "type": "string",
      "description": "Contracts ending on or after this date.",
      "format": "date"
    },
    "end_date_to": {
      "type": "string",
      "description": "Contracts ending on or before this date.",
      "format": "date"
    },
    "ending_within_days": {
      "type": "integer",
      "description": "Contracts ending from today (the API's calendar day, BrasΓ­lia time) to that many days later, both included; `0` is today. Any status: add `status=active` for the ones still in force.",
      "minimum": 0,
      "maximum": 3650
    },
    "expand": {
      "type": "string",
      "description": "`document` embeds each contract's document.",
      "enum": [
        "document"
      ]
    },
    "external_id": {
      "type": "string",
      "description": "ID of an external reference in that system."
    },
    "external_system": {
      "type": "string",
      "description": "System of an external reference, e.g. `hubspot`."
    },
    "page": {
      "type": "integer",
      "description": "Page number.",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "description": "Records per page (API caps at 50).",
      "minimum": 1,
      "maximum": 100
    },
    "search": {
      "type": "string",
      "description": "Part of the document's name."
    },
    "sort": {
      "type": "string",
      "description": "`end_date` or `updated_at`; prefix with `-` for descending (`-updated_at`, the default). Contracts without an end date come last either way.",
      "enum": [
        "end_date",
        "-end_date",
        "updated_at",
        "-updated_at"
      ]
    },
    "status": {
      "type": "string",
      "description": "Contract status; several, comma-separated, match any of them.",
      "pattern": "^(draft|active|expired|terminated)(,(draft|active|expired|terminated))*$"
    }
  },
  "required": [
    "action"
  ],
  "additionalProperties": false,
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "account_id": {
          "type": "string",
          "minLength": 1
        },
        "action": {
          "type": "string",
          "const": "list"
        },
        "counterparty": {
          "type": "string",
          "description": "Part of the counterparty name."
        },
        "end_date_from": {
          "type": "string",
          "description": "Contracts ending on or after this date.",
          "format": "date"
        },
        "end_date_to": {
          "type": "string",
          "description": "Contracts ending on or before this date.",
          "format": "date"
        },
        "ending_within_days": {
          "type": "integer",
          "description": "Contracts ending from today (the API's calendar day, BrasΓ­lia time) to that many days later, both included; `0` is today. Any status: add `status=active` for the ones still in force.",
          "minimum": 0,
          "maximum": 3650
        },
        "expand": {
          "type": "string",
          "description": "`document` embeds each contract's document.",
          "enum": [
            "document"
          ]
        },
        "external_id": {
          "type": "string",
          "description": "ID of an external reference in that system."
        },
        "external_system": {
          "type": "string",
          "description": "System of an external reference, e.g. `hubspot`."
        },
        "page": {
          "type": "integer",
          "description": "Page number.",
          "minimum": 1
        },
        "per_page": {
          "type": "integer",
          "description": "Records per page (API caps at 50).",
          "minimum": 1,
          "maximum": 100
        },
        "search": {
          "type": "string",
          "description": "Part of the document's name."
        },
        "sort": {
          "type": "string",
          "description": "`end_date` or `updated_at`; prefix with `-` for descending (`-updated_at`, the default). Contracts without an end date come last either way.",
          "enum": [
            "end_date",
            "-end_date",
            "updated_at",
            "-updated_at"
          ]
        },
        "status": {
          "type": "string",
          "description": "Contract status; several, comma-separated, match any of them.",
          "pattern": "^(draft|active|expired|terminated)(,(draft|active|expired|terminated))*$"
        }
      },
      "required": [
        "action"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "account_id": {
          "type": "string",
          "minLength": 1
        },
        "action": {
          "type": "string",
          "const": "get"
        },
        "document_id": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "action",
        "document_id"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "account_id": {
          "type": "string",
          "minLength": 1
        },
        "action": {
          "type": "string",
          "const": "related"
        },
        "document_id": {
          "type": "string",
          "minLength": 1
        }
      },
      "required": [
        "action",
        "document_id"
      ],
      "additionalProperties": false
    }
  ]
}
🟑assinafy_create_assignment(copy_receivers, document_id, entries, estimate_only, expires_at, ...)

Request 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.

Input Schema

{
  "type": "object",
  "properties": {
    "copy_receivers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Signer IDs that only receive a copy."
    },
    "document_id": {
      "type": "string",
      "description": "Document ID.",
      "minLength": 1
    },
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "display_settings": {
                  "type": "object",
                  "properties": {
                    "backgroundColor": {
                      "type": "string",
                      "description": "CSS-compatible background-color presentation metadata."
                    },
                    "fontFamily": {
                      "type": "string",
                      "description": "Font-family presentation metadata."
                    },
                    "fontSize": {
                      "type": "number",
                      "description": "Font size in the 150-DPI page-image coordinate system.",
                      "exclusiveMinimum": 0,
                      "format": "float"
                    },
                    "height": {
                      "type": "number",
                      "description": "Height of the placement rectangle, in page-image pixels.",
                      "exclusiveMinimum": 0,
                      "format": "float"
                    },
                    "left": {
                      "type": "number",
                      "description": "Horizontal distance from the page's left edge, in page-image pixels.",
                      "minimum": 0,
                      "format": "float"
                    },
                    "top": {
                      "type": "number",
                      "description": "Vertical distance from the page's top edge, in page-image pixels.",
                      "minimum": 0,
                      "format": "float"
                    },
                    "width": {
                      "type": "number",
                      "description": "Width of the placement rectangle, in page-image pixels.",
                      "exclusiveMinimum": 0,
                      "format": "float"
                    }
                  },
                  "description": "A field placement rectangle on a document page. Geometry values are pixels in Assinafy's 150-DPI page image, measured from the upper-left corner. Clients must keep the rectangle within the selected page's width and height; the API does not clamp out-of-bounds values.",
                  "required": [
                    "left",
                    "top",
                    "width",
                    "height",
                    "fontSize"
                  ],
                  "additionalProperties": false
                },
                "field_id": {
                  "type": "string"
                },
                "signer_id": {
                  "type": "string"
                }
              },
              "required": [
                "signer_id",
                "field_id",
                "display_settings"
              ],
              "additionalProperties": false
            },
            "minItems": 1
          },
          "page_id": {
            "type": "string"
          }
        },
        "required": [
          "page_id",
          "fields"
        ],
        "additionalProperties": false
      },
      "description": "Required for `collect`: field placements per page."
    },
    "estimate_only": {
      "type": "boolean",
      "description": "Preview cost and balances without creating an assignment or notifying anyone."
    },
    "expires_at": {
      "type": "string",
      "description": "ISO 8601; default is no expiration. Must be at least one hour in the future."
    },
    "max_total_credits": {
      "type": "number",
      "description": "Maximum credits allowed for sending; use total_credits from the latest estimate. A higher cost returns CreditCeilingExceeded without charging.",
      "minimum": 0
    },
    "message": {
      "type": "string",
      "description": "Text included in the invitation email."
    },
    "method": {
      "type": "string",
      "default": "virtual",
      "enum": [
        "virtual",
        "collect"
      ]
    },
    "signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "notification_methods": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "Email",
                "Whatsapp"
              ]
            },
            "description": "How the signer is told a signature is being requested. **Exactly one method per signer** β€” the array shape is historical, and sending two returns `400`. The method must also be compatible with `verification_method`: `Email` verification takes `Email`, `Whatsapp` verification takes `Whatsapp`, and `DigitalCertificate` and `IdDocumentFaceMatchBasic` take either. WhatsApp incurs an additional cost and is available only on paid subscriptions. Omit it to have it inferred from `verification_method`, or `{\"Email\"}` when neither is sent. See **Verification & Notification Methods** for the full pairing table.",
            "maxItems": 1,
            "example": [
              "Email"
            ]
          },
          "step": {
            "type": "integer",
            "minimum": 1
          },
          "verification_method": {
            "type": "string",
            "description": "How the signer's identity is verified before signing. `Email` (default) sends a one-time code to the signer's email; `Whatsapp` sends the code over WhatsApp β€” the verification itself is not billed, but it requires the WhatsApp notification channel, so the signer costs 0.45 credits (available only on paid subscriptions); `DigitalCertificate` has the signer sign with their own ICP-Brasil certificate (A1/A3) β€” it requires `method: virtual`, the Digital Certificate feature, a CPF or CNPJ that the account saved on the contact in Assinafy (this server does not accept one), must be alone in its signing step, and is charged 0.5 credits per signer. A CPF requires that person's certificate (an e-CPF, or an e-CNPJ naming them as legal representative); a CNPJ requires an e-CNPJ for that company, from any of its representatives. `IdDocumentFaceMatchBasic` has Assinafy verify the signer on its own signing page, where the signer consents, photographs their ID, takes a photo holding it and passes a liveness check; this tool only selects the method and never receives those images or face data. It requires the ID Document + Face Match feature and a valid CPF that the account saved on the contact in Assinafy, and is charged a per-signer fee. Omit to default to `Email`.",
            "enum": [
              "Email",
              "Whatsapp",
              "DigitalCertificate",
              "IdDocumentFaceMatchBasic"
            ],
            "example": "Email"
          }
        },
        "additionalProperties": false
      },
      "minItems": 1
    }
  },
  "required": [
    "method",
    "signers",
    "document_id"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "method": {
            "const": "collect"
          }
        },
        "required": [
          "method"
        ]
      },
      "then": {
        "properties": {
          "entries": {
            "minItems": 1
          }
        },
        "required": [
          "entries"
        ]
      }
    },
    {
      "if": {
        "properties": {
          "estimate_only": {
            "const": true
          }
        },
        "required": [
          "estimate_only"
        ]
      },
      "else": {
        "properties": {
          "signers": {
            "items": {
              "required": [
                "id"
              ]
            }
          }
        }
      }
    }
  ]
}
🟑assinafy_create_document_from_template(template_id, signers, name, message, expires_at, ...)

Generate a document from a saved template and invite each Signer role, with optional CopyReceiver roles, by signer ID or full name and email. Editor roles use only editor_fields. Find roles with assinafy_list_templates and validate editor_fields values with assinafy_validate_fields first. DigitalCertificate signers require a template without placed signer fields. This sends invitations and can consume credits.

Input Schema

{
  "type": "object",
  "properties": {
    "template_id": {
      "type": "string",
      "description": "template ID"
    },
    "signers": {
      "type": [
        "null",
        "array"
      ],
      "items": {
        "type": "object",
        "properties": {
          "role_id": {
            "type": "string",
            "description": "template role ID"
          },
          "id": {
            "type": "string",
            "description": "existing signer ID; use instead of full_name and email"
          },
          "full_name": {
            "type": "string",
            "description": "signer's full name; required when id is omitted"
          },
          "email": {
            "type": "string",
            "description": "signer's email address, required when id is omitted; existing exact matches are reused"
          },
          "verification_method": {
            "type": "string",
            "description": "Email (default), Whatsapp, DigitalCertificate (A1/A3, templates without placed signer fields only), or IdDocumentFaceMatchBasic (the signer completes ID photo and liveness checks on Assinafy's signing page; this tool never receives those images or face data)"
          },
          "notification_methods": {
            "type": [
              "null",
              "array"
            ],
            "items": {
              "type": "string"
            },
            "description": "at most one channel: Email or Whatsapp; inferred from verification_method when omitted"
          },
          "step": {
            "type": [
              "null",
              "integer"
            ],
            "description": "signing order, contiguous from 1; all Signer roles must set it if any does; CopyReceiver roles ignore it"
          }
        },
        "required": [
          "role_id"
        ],
        "additionalProperties": false
      },
      "description": "one entry per Signer role and optional CopyReceiver roles; Editor roles use editor_fields"
    },
    "name": {
      "type": "string",
      "description": "custom document name"
    },
    "message": {
      "type": "string",
      "description": "signing invitation message"
    },
    "expires_at": {
      "type": "string",
      "description": "assignment expiry as an ISO 8601 date or date-time"
    },
    "editor_fields": {
      "type": [
        "null",
        "array"
      ],
      "items": {
        "type": "object",
        "properties": {
          "field_id": {
            "type": "string",
            "description": "template editor field ID"
          },
          "value": {
            "type": "string",
            "description": "value to bake into the generated document"
          }
        },
        "required": [
          "field_id",
          "value"
        ],
        "additionalProperties": false
      },
      "description": "template editor field values"
    },
    "tags": {
      "type": [
        "null",
        "array"
      ],
      "items": {
        "type": "string"
      },
      "description": "tag names, merged with the template's defaults"
    },
    "account_id": {
      "type": "string",
      "description": "account ID; uses request routing if omitted"
    },
    "max_total_credits": {
      "type": "number",
      "description": "maximum credits allowed for sending; use total_credits from the latest estimate",
      "minimum": 0
    },
    "estimate_only": {
      "type": "boolean",
      "description": "preview cost and balances for the given roles without creating contacts, documents or invitations; roles alone are sufficient"
    }
  },
  "required": [
    "template_id",
    "signers"
  ],
  "additionalProperties": false
}
🟑assinafy_create_signer(account_id, email, full_name, whatsapp_phone_number)

Create a signer in the workspace. Search with assinafy_list_signers first to avoid duplicates. Sends no invitation.

Input Schema

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "Authorized workspace; discovered from OAuth when omitted.",
      "minLength": 1
    },
    "email": {
      "type": "string",
      "format": "email"
    },
    "full_name": {
      "type": "string",
      "minLength": 1
    },
    "whatsapp_phone_number": {
      "type": "string",
      "description": "E.164; normalized on save."
    }
  },
  "required": [
    "full_name"
  ],
  "additionalProperties": false
}
πŸ”΄assinafy_delete_document(document_id)

Delete a document only when the user's instruction explicitly authorizes deletion. Inspect its current state first; Assinafy enforces which documents may be deleted.

Input Schema

{
  "type": "object",
  "properties": {
    "document_id": {
      "type": "string",
      "description": "unique document ID to delete"
    }
  },
  "required": [
    "document_id"
  ],
  "additionalProperties": false
}
🟒assinafy_download_document(document_id, artifact)

Download 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.

Input Schema

{
  "type": "object",
  "properties": {
    "document_id": {
      "type": "string",
      "description": "unique document ID"
    },
    "artifact": {
      "type": "string",
      "description": "original (default), certificated, certificate-page, pades, or bundle"
    }
  },
  "required": [
    "document_id"
  ],
  "additionalProperties": false
}
🟒assinafy_download_document_page(document_id, page_id)

Download the rendered image of a specific document page. Use a page_id returned by assinafy_get_document. Returns base64.

Input Schema

{
  "type": "object",
  "properties": {
    "document_id": {
      "type": "string",
      "description": "Document ID.",
      "minLength": 1
    },
    "page_id": {
      "type": "string",
      "description": "The page ID.",
      "minLength": 1
    }
  },
  "required": [
    "document_id",
    "page_id"
  ],
  "additionalProperties": false
}
🟒assinafy_get_document(document_id)

Inspect 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.

Input Schema

{
  "type": "object",
  "properties": {
    "document_id": {
      "type": "string",
      "description": "unique document ID"
    }
  },
  "required": [
    "document_id"
  ],
  "additionalProperties": false
}
🟒assinafy_get_field(account_id, field_id)

Retrieve a single field definition.

Input Schema

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "Authorized workspace; discovered from OAuth when omitted.",
      "minLength": 1
    },
    "field_id": {
      "type": "string",
      "description": "The field ID.",
      "minLength": 1
    }
  },
  "required": [
    "field_id"
  ],
  "additionalProperties": false
}
🟒assinafy_get_signer(account_id, signer_id)

Retrieve a signer's information.

Input Schema

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "Authorized workspace; discovered from OAuth when omitted.",
      "minLength": 1
    },
    "signer_id": {
      "type": "string",
      "description": "The signer ID.",
      "minLength": 1
    }
  },
  "required": [
    "signer_id"
  ],
  "additionalProperties": false
}
🟒assinafy_get_template(template_id, account_id)

Get one saved template with its roles and field placements.

Input Schema

{
  "type": "object",
  "properties": {
    "template_id": {
      "type": "string",
      "description": "unique template ID"
    },
    "account_id": {
      "type": "string",
      "description": "account ID; uses default if omitted"
    }
  },
  "required": [
    "template_id"
  ],
  "additionalProperties": false
}
🟒assinafy_list_document_activities(document_id, page, per_page, sort)

List 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.

Input Schema

{
  "type": "object",
  "properties": {
    "document_id": {
      "type": "string",
      "description": "Document ID.",
      "minLength": 1
    },
    "page": {
      "type": "integer",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "sort": {
      "type": "string",
      "description": "Activity order: -id for newest first, or id for oldest first.",
      "default": "-id",
      "enum": [
        "-id",
        "id"
      ]
    }
  },
  "required": [
    "document_id"
  ],
  "additionalProperties": false
}
🟒assinafy_list_documents(page, per_page, search, sort, status, ...)

Search workspace documents by name or status, with pagination. Use it to find a document the user names before inspecting or following up on it.

Input Schema

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "page number (1-based)"
    },
    "per_page": {
      "type": "integer",
      "description": "number of results per page (API caps at 50)"
    },
    "search": {
      "type": "string",
      "description": "partial match on document name or signer"
    },
    "sort": {
      "type": "string",
      "description": "name or updated_at; prefix with - for descending"
    },
    "status": {
      "type": "string",
      "description": "document status filter"
    },
    "method": {
      "type": "string",
      "description": "signature method filter: virtual or collect"
    },
    "tags": {
      "type": "string",
      "description": "comma-separated tag IDs; documents must have all listed tags"
    },
    "account_id": {
      "type": "string",
      "description": "account ID; uses request routing if omitted"
    }
  },
  "additionalProperties": false
}
🟒assinafy_list_fields(account_id, include_inactive, include_standard)

List 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.

Input Schema

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "Authorized workspace; discovered from OAuth when omitted.",
      "minLength": 1
    },
    "include_inactive": {
      "type": "boolean",
      "description": "Include inactive field definitions."
    },
    "include_standard": {
      "type": "boolean",
      "description": "Include standard field types (signature, initial, signatureDate)."
    }
  },
  "additionalProperties": false
}
🟒assinafy_list_signers(account_id, page, per_page, search)

List the signers of a workspace. Use it to resolve a recipient to a signer ID; ask the user about ambiguous matches before sending.

Input Schema

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "Authorized workspace; discovered from OAuth when omitted.",
      "minLength": 1
    },
    "page": {
      "type": "integer",
      "description": "Page number.",
      "minimum": 1
    },
    "per_page": {
      "type": "integer",
      "description": "Records per page (API caps at 50).",
      "minimum": 1,
      "maximum": 100
    },
    "search": {
      "type": "string",
      "description": "Filter by full_name or email."
    }
  },
  "additionalProperties": false
}
🟒assinafy_list_templates(page, per_page, search, account_id)

List saved templates with their signer roles, pages and field placements (field_id). Template authoring is done in Assinafy.

Input Schema

{
  "type": "object",
  "properties": {
    "page": {
      "type": "integer",
      "description": "page number (1-based)"
    },
    "per_page": {
      "type": "integer",
      "description": "results per page"
    },
    "search": {
      "type": "string",
      "description": "filter templates by name"
    },
    "account_id": {
      "type": "string",
      "description": "account ID; uses default if omitted"
    }
  },
  "additionalProperties": false
}
🟒assinafy_list_whatsapp_notifications(assignment_id, document_id)

List 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.

Input Schema

{
  "type": "object",
  "properties": {
    "assignment_id": {
      "type": "string",
      "description": "The assignment ID.",
      "minLength": 1
    },
    "document_id": {
      "type": "string",
      "description": "Document ID.",
      "minLength": 1
    }
  },
  "required": [
    "document_id",
    "assignment_id"
  ],
  "additionalProperties": false
}
🟒assinafy_place_fields(copy_receivers, document_id, expires_at, max_total_credits, message, ...)

Open 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.

Input Schema

{
  "type": "object",
  "properties": {
    "copy_receivers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Signer IDs that only receive a copy."
    },
    "document_id": {
      "type": "string",
      "description": "Document ID.",
      "minLength": 1
    },
    "expires_at": {
      "type": "string",
      "description": "ISO 8601; default is no expiration. Must be at least one hour in the future."
    },
    "max_total_credits": {
      "type": "number",
      "description": "Maximum credits allowed for sending; use total_credits from the latest estimate. A higher cost returns CreditCeilingExceeded without charging.",
      "minimum": 0
    },
    "message": {
      "type": "string",
      "description": "Text included in the invitation email."
    },
    "signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "notification_methods": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "Email",
                "Whatsapp"
              ]
            },
            "description": "How the signer is told a signature is being requested. **Exactly one method per signer** β€” the array shape is historical, and sending two returns `400`. The method must also be compatible with `verification_method`: `Email` verification takes `Email`, `Whatsapp` verification takes `Whatsapp`, and `DigitalCertificate` and `IdDocumentFaceMatchBasic` take either. WhatsApp incurs an additional cost and is available only on paid subscriptions. Omit it to have it inferred from `verification_method`, or `{\"Email\"}` when neither is sent. See **Verification & Notification Methods** for the full pairing table.",
            "maxItems": 1,
            "example": [
              "Email"
            ]
          },
          "step": {
            "type": "integer",
            "minimum": 1
          },
          "verification_method": {
            "type": "string",
            "description": "How the signer's identity is verified before signing. `Email` (default) sends a one-time code to the signer's email; `Whatsapp` sends the code over WhatsApp β€” the verification itself is not billed, but it requires the WhatsApp notification channel, so the signer costs 0.45 credits (available only on paid subscriptions); `DigitalCertificate` has the signer sign with their own ICP-Brasil certificate (A1/A3) β€” it requires `method: virtual`, the Digital Certificate feature, a CPF or CNPJ that the account saved on the contact in Assinafy (this server does not accept one), must be alone in its signing step, and is charged 0.5 credits per signer. A CPF requires that person's certificate (an e-CPF, or an e-CNPJ naming them as legal representative); a CNPJ requires an e-CNPJ for that company, from any of its representatives. `IdDocumentFaceMatchBasic` has Assinafy verify the signer on its own signing page, where the signer consents, photographs their ID, takes a photo holding it and passes a liveness check; this tool only selects the method and never receives those images or face data. It requires the ID Document + Face Match feature and a valid CPF that the account saved on the contact in Assinafy, and is charged a per-signer fee. Omit to default to `Email`.",
            "enum": [
              "Email",
              "Whatsapp",
              "DigitalCertificate",
              "IdDocumentFaceMatchBasic"
            ],
            "example": "Email"
          }
        },
        "additionalProperties": false
      },
      "minItems": 1
    }
  },
  "required": [
    "signers",
    "document_id"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "method": {
            "const": "collect"
          }
        },
        "required": [
          "method"
        ]
      },
      "then": {
        "properties": {
          "entries": {
            "minItems": 1
          }
        },
        "required": [
          "entries"
        ]
      }
    },
    {
      "if": {
        "properties": {
          "estimate_only": {
            "const": true
          }
        },
        "required": [
          "estimate_only"
        ]
      },
      "else": {
        "properties": {
          "signers": {
            "items": {
              "required": [
                "id"
              ]
            }
          }
        }
      }
    }
  ]
}
πŸ”΄assinafy_rename_document(document_id, name)

Update 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.

Input Schema

{
  "type": "object",
  "properties": {
    "document_id": {
      "type": "string",
      "description": "Document ID.",
      "minLength": 1
    },
    "name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 255
    }
  },
  "required": [
    "name",
    "document_id"
  ],
  "additionalProperties": false
}
🟑assinafy_resend_notification(document_id, assignment_id, signer_id, estimate_only)

Send 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.

Input Schema

{
  "type": "object",
  "properties": {
    "document_id": {
      "type": "string",
      "description": "unique document ID"
    },
    "assignment_id": {
      "type": "string",
      "description": "unique assignment ID"
    },
    "signer_id": {
      "type": "string",
      "description": "unique signer ID to notify"
    },
    "estimate_only": {
      "type": "boolean",
      "description": "preview the reminder cost and balances without notifying the signer"
    }
  },
  "required": [
    "document_id",
    "assignment_id",
    "signer_id"
  ],
  "additionalProperties": false
}
🟒assinafy_review_signature_request(copy_receivers, document_id, entries, expires_at, max_total_credits, ...)

Preview 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.

Input Schema

{
  "type": "object",
  "properties": {
    "copy_receivers": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Signer IDs that only receive a copy."
    },
    "document_id": {
      "type": "string",
      "description": "Document ID.",
      "minLength": 1
    },
    "entries": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "fields": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "display_settings": {
                  "type": "object",
                  "properties": {
                    "backgroundColor": {
                      "type": "string",
                      "description": "CSS-compatible background-color presentation metadata."
                    },
                    "fontFamily": {
                      "type": "string",
                      "description": "Font-family presentation metadata."
                    },
                    "fontSize": {
                      "type": "number",
                      "description": "Font size in the 150-DPI page-image coordinate system.",
                      "exclusiveMinimum": 0,
                      "format": "float"
                    },
                    "height": {
                      "type": "number",
                      "description": "Height of the placement rectangle, in page-image pixels.",
                      "exclusiveMinimum": 0,
                      "format": "float"
                    },
                    "left": {
                      "type": "number",
                      "description": "Horizontal distance from the page's left edge, in page-image pixels.",
                      "minimum": 0,
                      "format": "float"
                    },
                    "top": {
                      "type": "number",
                      "description": "Vertical distance from the page's top edge, in page-image pixels.",
                      "minimum": 0,
                      "format": "float"
                    },
                    "width": {
                      "type": "number",
                      "description": "Width of the placement rectangle, in page-image pixels.",
                      "exclusiveMinimum": 0,
                      "format": "float"
                    }
                  },
                  "description": "A field placement rectangle on a document page. Geometry values are pixels in Assinafy's 150-DPI page image, measured from the upper-left corner. Clients must keep the rectangle within the selected page's width and height; the API does not clamp out-of-bounds values.",
                  "required": [
                    "left",
                    "top",
                    "width",
                    "height",
                    "fontSize"
                  ],
                  "additionalProperties": false
                },
                "field_id": {
                  "type": "string"
                },
                "signer_id": {
                  "type": "string"
                }
              },
              "required": [
                "signer_id",
                "field_id",
                "display_settings"
              ],
              "additionalProperties": false
            },
            "minItems": 1
          },
          "page_id": {
            "type": "string"
          }
        },
        "required": [
          "page_id",
          "fields"
        ],
        "additionalProperties": false
      },
      "description": "Required for `collect`: field placements per page."
    },
    "expires_at": {
      "type": "string",
      "description": "ISO 8601; default is no expiration. Must be at least one hour in the future."
    },
    "max_total_credits": {
      "type": "number",
      "description": "Maximum credits allowed for sending; use total_credits from the latest estimate. A higher cost returns CreditCeilingExceeded without charging.",
      "minimum": 0
    },
    "message": {
      "type": "string",
      "description": "Text included in the invitation email."
    },
    "method": {
      "type": "string",
      "default": "virtual",
      "enum": [
        "virtual",
        "collect"
      ]
    },
    "signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string"
          },
          "notification_methods": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "Email",
                "Whatsapp"
              ]
            },
            "description": "How the signer is told a signature is being requested. **Exactly one method per signer** β€” the array shape is historical, and sending two returns `400`. The method must also be compatible with `verification_method`: `Email` verification takes `Email`, `Whatsapp` verification takes `Whatsapp`, and `DigitalCertificate` and `IdDocumentFaceMatchBasic` take either. WhatsApp incurs an additional cost and is available only on paid subscriptions. Omit it to have it inferred from `verification_method`, or `{\"Email\"}` when neither is sent. See **Verification & Notification Methods** for the full pairing table.",
            "maxItems": 1,
            "example": [
              "Email"
            ]
          },
          "step": {
            "type": "integer",
            "minimum": 1
          },
          "verification_method": {
            "type": "string",
            "description": "How the signer's identity is verified before signing. `Email` (default) sends a one-time code to the signer's email; `Whatsapp` sends the code over WhatsApp β€” the verification itself is not billed, but it requires the WhatsApp notification channel, so the signer costs 0.45 credits (available only on paid subscriptions); `DigitalCertificate` has the signer sign with their own ICP-Brasil certificate (A1/A3) β€” it requires `method: virtual`, the Digital Certificate feature, a CPF or CNPJ that the account saved on the contact in Assinafy (this server does not accept one), must be alone in its signing step, and is charged 0.5 credits per signer. A CPF requires that person's certificate (an e-CPF, or an e-CNPJ naming them as legal representative); a CNPJ requires an e-CNPJ for that company, from any of its representatives. `IdDocumentFaceMatchBasic` has Assinafy verify the signer on its own signing page, where the signer consents, photographs their ID, takes a photo holding it and passes a liveness check; this tool only selects the method and never receives those images or face data. It requires the ID Document + Face Match feature and a valid CPF that the account saved on the contact in Assinafy, and is charged a per-signer fee. Omit to default to `Email`.",
            "enum": [
              "Email",
              "Whatsapp",
              "DigitalCertificate",
              "IdDocumentFaceMatchBasic"
            ],
            "example": "Email"
          }
        },
        "additionalProperties": false
      },
      "minItems": 1
    }
  },
  "required": [
    "method",
    "signers",
    "document_id"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "method": {
            "const": "collect"
          }
        },
        "required": [
          "method"
        ]
      },
      "then": {
        "properties": {
          "entries": {
            "minItems": 1
          }
        },
        "required": [
          "entries"
        ]
      }
    },
    {
      "if": {
        "properties": {
          "estimate_only": {
            "const": true
          }
        },
        "required": [
          "estimate_only"
        ]
      },
      "else": {
        "properties": {
          "signers": {
            "items": {
              "required": [
                "id"
              ]
            }
          }
        }
      }
    }
  ]
}
🟑assinafy_send_pdf_for_signature(account_id, file_name, file_base64, signers, message, ...)

Upload 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.

Input Schema

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "account ID; uses the request or server default if omitted"
    },
    "file_name": {
      "type": "string",
      "description": "PDF filename including the .pdf extension"
    },
    "file_base64": {
      "type": "string",
      "description": "base64-encoded PDF bytes (max 25 MB decoded)"
    },
    "signers": {
      "type": [
        "null",
        "array"
      ],
      "items": {
        "type": "object",
        "properties": {
          "full_name": {
            "type": "string",
            "description": "signer's full name"
          },
          "email": {
            "type": "string",
            "description": "signer's email address; existing exact matches are reused"
          }
        },
        "required": [
          "full_name",
          "email"
        ],
        "additionalProperties": false
      },
      "description": "one or more signers to create or reuse and request signatures from"
    },
    "message": {
      "type": "string",
      "description": "invitation message shown to signers"
    },
    "expires_at": {
      "type": "string",
      "description": "assignment expiry as an ISO 8601 date or date-time"
    },
    "max_wait_secs": {
      "type": "integer",
      "description": "maximum seconds to wait for PDF processing (default 30; max 600)"
    },
    "poll_secs": {
      "type": "integer",
      "description": "polling interval in seconds (default 2; cannot exceed max_wait_secs)"
    },
    "max_total_credits": {
      "type": "number",
      "description": "maximum credits allowed for sending; use total_credits from the latest estimate",
      "minimum": 0
    },
    "estimate_only": {
      "type": "boolean",
      "description": "upload and prepare the PDF, then return cost and document ID without creating contacts or sending invitations; reuse that ID to send"
    }
  },
  "required": [
    "file_name",
    "file_base64",
    "signers"
  ],
  "additionalProperties": false
}
πŸ”΄assinafy_set_assignment_expiration(document_id, assignment_id, expires_at)

Set an existing signature request deadline with an ISO 8601 date or date-time at least one hour in the future, or remove it with expires_at: null. A shorter deadline ends signing when it passes; Assinafy refuses expired or closed requests.

Input Schema

{
  "type": "object",
  "properties": {
    "document_id": {
      "type": "string",
      "description": "unique document ID"
    },
    "assignment_id": {
      "type": "string",
      "description": "unique assignment ID"
    },
    "expires_at": {
      "type": [
        "null",
        "string"
      ],
      "description": "new ISO 8601 expiry, or null to remove the expiration"
    }
  },
  "required": [
    "document_id",
    "assignment_id",
    "expires_at"
  ],
  "additionalProperties": false
}
🟒assinafy_show_document(document_id)

Show 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.

Input Schema

{
  "type": "object",
  "properties": {
    "document_id": {
      "type": "string",
      "description": "unique document ID"
    }
  },
  "required": [
    "document_id"
  ],
  "additionalProperties": false
}
πŸ”΄assinafy_update_contract(account_id, action, document_id, end_date, reason, ...)

Manage an existing document’s CLM record: set creates/patches terms or links a signed amendment; renew starts the next term; terminate closes tracking. Requires a tracking plan. Read first: include terms.updated_at for existing terms or links; renew requires the current term and updated_at, terminate requires updated_at. A conflict needs a fresh read and user review, never blind retries. Only supplied terms change; external_references replaces the list; null can clear values or unlink a pending amendment. Assinafy owns auto-renewal and owner reminders; changes can trigger lifecycle emails/webhooks. These actions do not sign, send or cancel the document itself. Use only for changes the user authorized.

Input Schema

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "minLength": 1
    },
    "action": {
      "type": "string",
      "enum": [
        "set",
        "renew",
        "terminate"
      ]
    },
    "document_id": {
      "type": "string",
      "minLength": 1
    },
    "end_date": {
      "type": [
        "string",
        "null"
      ],
      "description": "The new end date, after the current one. Absent, empty or `null`: the current end date plus the renewal term, stepped until it is in the future; `term` is then required.",
      "format": "date"
    },
    "reason": {
      "type": [
        "string",
        "null"
      ],
      "description": "Kept in the `document_contract_terminated` event; HTML is stripped.",
      "maxLength": 500
    },
    "term": {
      "type": "integer",
      "description": "The term this renewal starts from, the contract's current `term`. Required unless `end_date` is sent; for a contract in another term the renewal is refused, so a repeated request never renews twice.",
      "minimum": 1
    },
    "terms": {
      "type": "object",
      "properties": {
        "auto_renew": {
          "type": "boolean",
          "description": "Whether the hourly run starts the next term the day after `end_date`, by `renewal_term_months`, instead of expiring the contract."
        },
        "counterparty_name": {
          "type": [
            "string",
            "null"
          ],
          "description": "Emoji are kept; other characters outside the 3-byte range are dropped.",
          "maxLength": 255
        },
        "currency": {
          "type": [
            "string",
            "null"
          ],
          "description": "Three letters, such as `BRL` or `USD`, stored in capitals; `BRL` when a `value` is set without one."
        },
        "end_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "`YYYY-MM-DD`, on or after `start_date`.",
          "format": "date"
        },
        "external_references": {
          "type": [
            "array",
            "null"
          ],
          "items": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string",
                "description": "Kept as sent; must not contain emoji or other 4-byte characters.",
                "maxLength": 255,
                "example": "98765"
              },
              "system": {
                "type": "string",
                "description": "Letters, digits, `_`, `-` and `.`; stored in lower case.",
                "maxLength": 64,
                "example": "hubspot"
              }
            },
            "required": [
              "system",
              "id"
            ]
          },
          "description": "Replaces the whole list; `[]` or `null` clears it. Two items whose `system` and `id` compare equal case aside are one reference (the first sent is kept); a pair the database takes for one beyond that (accents, `ß` and `ss`) answers `400`.",
          "maxItems": 20
        },
        "metadata": {
          "type": [
            "object",
            "null"
          ],
          "description": "Your own fields: up to 50 keys of 1 to 40 letters, digits, `_`, `-` or `.`, each holding plain text of at most 500 characters; no number under a key ending in `_at`, or `stuck_since`.",
          "maxProperties": 50,
          "additionalProperties": {
            "type": "string",
            "maxLength": 500
          }
        },
        "notice_period_days": {
          "type": [
            "integer",
            "null"
          ],
          "description": "Days before `end_date` the notice period starts (`document_contract_renewal_notice`); none when unset.",
          "minimum": 0,
          "maximum": 3650
        },
        "owner_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "An active member of this workspace."
        },
        "parent_document_id": {
          "type": [
            "string",
            "null"
          ],
          "description": "Links the document as an amendment of this contract document, or of any document in its family (resolved to the root); `null` unlinks a pending amendment. With it, the other attributes are the terms the instrument changes, not terms of its own; on a pending amendment a `null` value drops that term from the delta rather than clearing it on the parent."
        },
        "relation_type": {
          "type": "string",
          "description": "Required on the first link. `amendment` may change `value`, `currency`, `start_date` (effective from, display only), `end_date`, `auto_renew`, `renewal_term_months`, `notice_period_days`, `counterparty_name` and `metadata`; `renewal` only `end_date` and `value`; `termination` only `end_date` (the effective date).",
          "enum": [
            "amendment",
            "renewal",
            "termination"
          ]
        },
        "renewal_term_months": {
          "type": [
            "integer",
            "null"
          ],
          "description": "How far a renewal by the term moves `end_date`; 12 when unset.",
          "minimum": 1,
          "maximum": 600
        },
        "start_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "`YYYY-MM-DD`, from the year 1000.",
          "format": "date"
        },
        "status": {
          "type": "string",
          "description": "On creation any status, so a contract that ended before it was tracked is registered as it ended: `expired` needs an `end_date` in the past, `terminated` its `end_date`; neither is walked by the lifecycle. Afterwards only `draft` or `active` (a contract in force never goes back to `draft`): `expired` and `terminated` are set by the lifecycle and the terminate endpoint; a closed contract is reopened by renewing it.",
          "enum": [
            "draft",
            "active",
            "expired",
            "terminated"
          ]
        },
        "updated_at": {
          "type": "string",
          "description": "Optional precondition: the `updated_at` the client read the contract (or this document's amendment link) with, as the API returned it. If the contract or link changed since, nothing is written and the answer is `409` with `code: ContractChanged`. Not sent, or `null`: the write applies whatever changed meanwhile (last write wins). Compared to the second; a fraction of a second, as a JavaScript date prints it, is read and ignored. New terms and a first link have nothing to have read, so sending one answers `409`; on a pending amendment, send the link's own `updated_at` (the GET on that document).",
          "format": "date-time"
        },
        "value": {
          "type": [
            "number",
            "null"
          ],
          "description": "Two decimal places at most.",
          "minimum": 0,
          "maximum": 9999999999999.99
        }
      },
      "description": "Every attribute is optional and only the ones sent change. `null` clears an attribute, except `auto_renew` (back to `false`) and `currency` (back to `BRL` while a `value` is set); `status` does not accept `null`. A changed `end_date` starts a new `term`.",
      "minProperties": 1,
      "additionalProperties": false,
      "anyOf": [
        {
          "required": [
            "status"
          ]
        },
        {
          "required": [
            "counterparty_name"
          ]
        },
        {
          "required": [
            "value"
          ]
        },
        {
          "required": [
            "currency"
          ]
        },
        {
          "required": [
            "start_date"
          ]
        },
        {
          "required": [
            "end_date"
          ]
        },
        {
          "required": [
            "auto_renew"
          ]
        },
        {
          "required": [
            "renewal_term_months"
          ]
        },
        {
          "required": [
            "notice_period_days"
          ]
        },
        {
          "required": [
            "owner_id"
          ]
        },
        {
          "required": [
            "metadata"
          ]
        },
        {
          "required": [
            "external_references"
          ]
        },
        {
          "required": [
            "parent_document_id"
          ]
        },
        {
          "required": [
            "relation_type"
          ]
        }
      ]
    },
    "updated_at": {
      "type": "string",
      "description": "Optional precondition: the contract's `updated_at` as read. Changed since: `409`, nothing terminated.",
      "format": "date-time"
    },
    "value": {
      "type": [
        "number",
        "null"
      ],
      "description": "The new value; unchanged when not sent, cleared by `null`."
    }
  },
  "required": [
    "action"
  ],
  "additionalProperties": false,
  "oneOf": [
    {
      "type": "object",
      "properties": {
        "account_id": {
          "type": "string",
          "minLength": 1
        },
        "action": {
          "type": "string",
          "const": "set"
        },
        "document_id": {
          "type": "string",
          "minLength": 1
        },
        "terms": {
          "type": "object",
          "properties": {
            "auto_renew": {
              "type": "boolean",
              "description": "Whether the hourly run starts the next term the day after `end_date`, by `renewal_term_months`, instead of expiring the contract."
            },
            "counterparty_name": {
              "type": [
                "string",
                "null"
              ],
              "description": "Emoji are kept; other characters outside the 3-byte range are dropped.",
              "maxLength": 255
            },
            "currency": {
              "type": [
                "string",
                "null"
              ],
              "description": "Three letters, such as `BRL` or `USD`, stored in capitals; `BRL` when a `value` is set without one."
            },
            "end_date": {
              "type": [
                "string",
                "null"
              ],
              "description": "`YYYY-MM-DD`, on or after `start_date`.",
              "format": "date"
            },
            "external_references": {
              "type": [
                "array",
                "null"
              ],
              "items": {
                "type": "object",
                "properties": {
                  "id": {
                    "type": "string",
                    "description": "Kept as sent; must not contain emoji or other 4-byte characters.",
                    "maxLength": 255,
                    "example": "98765"
                  },
                  "system": {
                    "type": "string",
                    "description": "Letters, digits, `_`, `-` and `.`; stored in lower case.",
                    "maxLength": 64,
                    "example": "hubspot"
                  }
                },
                "required": [
                  "system",
                  "id"
                ]
              },
              "description": "Replaces the whole list; `[]` or `null` clears it. Two items whose `system` and `id` compare equal case aside are one reference (the first sent is kept); a pair the database takes for one beyond that (accents, `ß` and `ss`) answers `400`.",
              "maxItems": 20
            },
            "metadata": {
              "type": [
                "object",
                "null"
              ],
              "description": "Your own fields: up to 50 keys of 1 to 40 letters, digits, `_`, `-` or `.`, each holding plain text of at most 500 characters; no number under a key ending in `_at`, or `stuck_since`.",
              "maxProperties": 50,
              "additionalProperties": {
                "type": "string",
                "maxLength": 500
              }
            },
            "notice_period_days": {
              "type": [
                "integer",
                "null"
              ],
              "description": "Days before `end_date` the notice period starts (`document_contract_renewal_notice`); none when unset.",
              "minimum": 0,
              "maximum": 3650
            },
            "owner_id": {
              "type": [
                "string",
                "null"
              ],
              "description": "An active member of this workspace."
            },
            "parent_document_id": {
              "type": [
                "string",
                "null"
              ],
              "description": "Links the document as an amendment of this contract document, or of any document in its family (resolved to the root); `null` unlinks a pending amendment. With it, the other attributes are the terms the instrument changes, not terms of its own; on a pending amendment a `null` value drops that term from the delta rather than clearing it on the parent."
            },
            "relation_type": {
              "type": "string",
              "description": "Required on the first link. `amendment` may change `value`, `currency`, `start_date` (effective from, display only), `end_date`, `auto_renew`, `renewal_term_months`, `notice_period_days`, `counterparty_name` and `metadata`; `renewal` only `end_date` and `value`; `termination` only `end_date` (the effective date).",
              "enum": [
                "amendment",
                "renewal",
                "termination"
              ]
            },
            "renewal_term_months": {
              "type": [
                "integer",
                "null"
              ],
              "description": "How far a renewal by the term moves `end_date`; 12 when unset.",
              "minimum": 1,
              "maximum": 600
            },
            "start_date": {
              "type": [
                "string",
                "null"
              ],
              "description": "`YYYY-MM-DD`, from the year 1000.",
              "format": "date"
            },
            "status": {
              "type": "string",
              "description": "On creation any status, so a contract that ended before it was tracked is registered as it ended: `expired` needs an `end_date` in the past, `terminated` its `end_date`; neither is walked by the lifecycle. Afterwards only `draft` or `active` (a contract in force never goes back to `draft`): `expired` and `terminated` are set by the lifecycle and the terminate endpoint; a closed contract is reopened by renewing it.",
              "enum": [
                "draft",
                "active",
                "expired",
                "terminated"
              ]
            },
            "updated_at": {
              "type": "string",
              "description": "Optional precondition: the `updated_at` the client read the contract (or this document's amendment link) with, as the API returned it. If the contract or link changed since, nothing is written and the answer is `409` with `code: ContractChanged`. Not sent, or `null`: the write applies whatever changed meanwhile (last write wins). Compared to the second; a fraction of a second, as a JavaScript date prints it, is read and ignored. New terms and a first link have nothing to have read, so sending one answers `409`; on a pending amendment, send the link's own `updated_at` (the GET on that document).",
              "format": "date-time"
            },
            "value": {
              "type": [
                "number",
                "null"
              ],
              "description": "Two decimal places at most.",
              "minimum": 0,
              "maximum": 9999999999999.99
            }
          },
          "description": "Every attribute is optional and only the ones sent change. `null` clears an attribute, except `auto_renew` (back to `false`) and `currency` (back to `BRL` while a `value` is set); `status` does not accept `null`. A changed `end_date` starts a new `term`.",
          "minProperties": 1,
          "additionalProperties": false,
          "anyOf": [
            {
              "required": [
                "status"
              ]
            },
            {
              "required": [
                "counterparty_name"
              ]
            },
            {
              "required": [
                "value"
              ]
            },
            {
              "required": [
                "currency"
              ]
            },
            {
              "required": [
                "start_date"
              ]
            },
            {
              "required": [
                "end_date"
              ]
            },
            {
              "required": [
                "auto_renew"
              ]
            },
            {
              "required": [
                "renewal_term_months"
              ]
            },
            {
              "required": [
                "notice_period_days"
              ]
            },
            {
              "required": [
                "owner_id"
              ]
            },
            {
              "required": [
                "metadata"
              ]
            },
            {
              "required": [
                "external_references"
              ]
            },
            {
              "required": [
                "parent_document_id"
              ]
            },
            {
              "required": [
                "relation_type"
              ]
            }
          ]
        }
      },
      "required": [
        "action",
        "document_id",
        "terms"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "account_id": {
          "type": "string",
          "minLength": 1
        },
        "action": {
          "type": "string",
          "const": "renew"
        },
        "document_id": {
          "type": "string",
          "minLength": 1
        },
        "end_date": {
          "type": [
            "string",
            "null"
          ],
          "description": "The new end date, after the current one. Absent, empty or `null`: the current end date plus the renewal term, stepped until it is in the future; `term` is then required.",
          "format": "date"
        },
        "term": {
          "type": "integer",
          "description": "The term this renewal starts from, the contract's current `term`. Required unless `end_date` is sent; for a contract in another term the renewal is refused, so a repeated request never renews twice.",
          "minimum": 1
        },
        "updated_at": {
          "type": "string",
          "description": "Optional precondition: the contract's `updated_at` as read. Changed since: `409`, nothing renewed.",
          "format": "date-time"
        },
        "value": {
          "type": [
            "number",
            "null"
          ],
          "description": "The new value; unchanged when not sent, cleared by `null`."
        }
      },
      "required": [
        "action",
        "document_id",
        "updated_at",
        "term"
      ],
      "additionalProperties": false
    },
    {
      "type": "object",
      "properties": {
        "account_id": {
          "type": "string",
          "minLength": 1
        },
        "action": {
          "type": "string",
          "const": "terminate"
        },
        "document_id": {
          "type": "string",
          "minLength": 1
        },
        "reason": {
          "type": [
            "string",
            "null"
          ],
          "description": "Kept in the `document_contract_terminated` event; HTML is stripped.",
          "maxLength": 500
        },
        "updated_at": {
          "type": "string",
          "description": "Optional precondition: the contract's `updated_at` as read. Changed since: `409`, nothing terminated.",
          "format": "date-time"
        }
      },
      "required": [
        "action",
        "document_id",
        "updated_at"
      ],
      "additionalProperties": false
    }
  ]
}
πŸ”΄assinafy_update_signer(account_id, email, full_name, signer_id, whatsapp_phone_number)

Update a signer's information. Only supplied fields change; send `null` or an empty string to clear `email` or `whatsapp_phone_number`. **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.

Input Schema

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "Authorized workspace; discovered from OAuth when omitted.",
      "minLength": 1
    },
    "email": {
      "description": "A valid email address, or null/empty to clear it.",
      "anyOf": [
        {
          "type": "string",
          "format": "email"
        },
        {
          "type": "string",
          "maxLength": 0
        },
        {
          "type": "null"
        }
      ]
    },
    "full_name": {
      "type": "string",
      "minLength": 1
    },
    "signer_id": {
      "type": "string",
      "description": "The signer ID.",
      "minLength": 1
    },
    "whatsapp_phone_number": {
      "type": [
        "string",
        "null"
      ],
      "description": "E.164 and normalized on save; null/empty clears it."
    }
  },
  "required": [
    "signer_id"
  ],
  "additionalProperties": false,
  "anyOf": [
    {
      "required": [
        "full_name"
      ]
    },
    {
      "required": [
        "email"
      ]
    },
    {
      "required": [
        "whatsapp_phone_number"
      ]
    }
  ]
}
🟑assinafy_upload_document(file_name, file_base64, account_id)

Upload 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.

Input Schema

{
  "type": "object",
  "properties": {
    "file_name": {
      "type": "string",
      "description": "PDF filename including .pdf"
    },
    "file_base64": {
      "type": "string",
      "description": "base64 PDF bytes, at most 25 MiB decoded"
    },
    "account_id": {
      "type": "string",
      "description": "authorized workspace; discovered through OAuth when omitted"
    }
  },
  "required": [
    "file_name",
    "file_base64"
  ],
  "additionalProperties": false
}
🟒assinafy_validate_fields(account_id, values)

Validate 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.

Input Schema

{
  "type": "object",
  "properties": {
    "account_id": {
      "type": "string",
      "description": "Authorized workspace; discovered from OAuth when omitted.",
      "minLength": 1
    },
    "values": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "field_id": {
            "type": "string",
            "description": "The field definition ID."
          },
          "value": {
            "description": "The input value to validate."
          }
        },
        "required": [
          "field_id",
          "value"
        ],
        "additionalProperties": false
      },
      "description": "Field/value pairs to validate; sent to Assinafy as the JSON request array."
    }
  },
  "required": [
    "values"
  ],
  "additionalProperties": false
}
🟒assinafy_verify_document(hash)

Verify a signed document using its verification_code from assinafy_get_document or the signature hash printed on the signed document. Public lookup; requires no workspace connection and sends no credential upstream.

Input Schema

{
  "type": "object",
  "properties": {
    "hash": {
      "type": "string",
      "description": "Assinafy verification_code from the certificated document, or its signature hash"
    }
  },
  "required": [
    "hash"
  ],
  "additionalProperties": false
}

Community

Rate this Server

Evidence

Recent observations

verifiedversion not recorded29 tools
verifiedversion not recorded29 tools
verifiedversion not recorded27 tools
verifiedversion not recorded14 tools
verifiedversion not recorded11 tools
verifiedversion not recorded11 tools