Move document to signing stage
move-document-to-signing-stageMoves a document to the signing stage and invites signatories to sign.
Use this tool when:
The document's current stage is one of: draft, approved_draft, review, approved_review
You want to start the signing process
This stage transition may be blocked by checkpoints on the document, or by unresolved preconditions (missing signature blocks, unresolved proposals, mandatory dynamic fields without values, active editor sessions or working copies, etc.). A refusal here reports just the first problem it runs into; call get-document-info first and read workflow_state.stage_transitions.signing.blockers to see everything that is in the way at once.
If the document has a signature_type set, the signature_type argument - if provided - must match it; otherwise the document's signature_type will be used. If the document has no signature_type, the one provided here (or the account default) will be used.
A qes or aes_eid signature_type requires sequential_signing=true. aes_eid is only available when the account has enabled AES (eID) in its settings.
Tool call template
Replace each placeholder with a value matching the input schema. Only required parameters are included; add optional parameters as needed.
{
"id": 1,
"jsonrpc": "2.0",
"method": "tools/call",
"params": {
"arguments": {
"document_uuid": "<document_uuid>"
},
"name": "move-document-to-signing-stage"
}
}Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| message | No | Custom message included in the signatory invitation email. If not sent, falls back to the document's external_signatory_invitation_message. | |
| document_uuid | Yes | UUID of the document to move to signing. If you don't already have the document's UUID, use the list-documents tool to find it. | |
| signature_type | No | Signature security level to use. If not sent, either the document's assigned signature_type or the account default will be used. | |
| sequential_signing | No | If true, signatories sign in the order defined by their signing_order. Cannot be false when signature_type is qes or aes_eid. If not sent, the document's current setting is used. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
| url | No | URL to open the document in fynk | |
| name | No | Name of the document | |
| uuid | No | Unique identifier for the document. Do not show to the user unless they ask for it | |
| stage | No | What stage the document is in currently | |
| _entity_type | No | Only relevant for tooling. Do not show to the user | |
| document_type | No | If present, indicates what kind of document this is. Absent when the document has no type assigned | |
| workflow_state | No | Gives an indication of which stage transitions, etc are possible to perform on this document. This object is technical state, not display content: when relaying it to the user, always render it as natural-language prose and never echo raw field names or snake_case values (e.g. say 'signing cannot be started yet because not every signature block has been assigned to a signatory' instead of mentioning 'can_start_signing' or 'signature_block_signatory'). |