Actions19
Overview
The "Remove Signatory" operation in the Autentique node allows users to remove a signatory from a specific document. This is useful when a signer should no longer be part of the signing process, for example, if they were added by mistake or if their participation is no longer required.
Typical use cases include:
- Correcting errors in the list of signatories before or during the signing workflow.
- Managing dynamic signing workflows where participants may change.
- Automating document management processes that require updating signatories programmatically.
Example: You have a contract document with multiple signatories and one person withdraws their consent. Using this operation, you can remove that person's signature request from the document.
Properties
| Name | Meaning |
|---|---|
| Document ID | The unique identifier of the document from which the signatory will be removed. |
| Signature ID | The public identifier of the signature (signatory) to be removed. This ID is obtained from the document creation response or the "Get Document" operation under signatures.public_id. |
Output
The output of this operation is a JSON boolean value indicating whether the removal was successful (true) or not (false). There is no binary data output.
Example output JSON:
true
This means the signatory was successfully removed from the document.
Dependencies
- Requires an API key credential for authenticating with the Autentique API.
- The node sends a GraphQL mutation request to the Autentique API endpoint at
https://api.autentique.com.br/v2/graphql. - Proper permissions on the API key are necessary to modify documents and manage signatories.
Troubleshooting
Common issues:
- Invalid or missing Document ID or Signature ID parameters will cause the operation to fail.
- Attempting to remove a signatory who does not exist on the specified document will likely result in an error or a false response.
- Network or authentication errors if the API key is invalid or expired.
Error messages:
- Errors related to authorization typically indicate problems with the API key credential; ensure it is correctly configured and has sufficient permissions.
- Validation errors usually mean required parameters are missing or malformed; double-check the Document ID and Signature ID inputs.
- If the API returns a failure response, verify that the signatory exists on the document and that the document ID is correct.
Links and References
- Autentique API Documentation (for detailed API usage and GraphQL schema)
- n8n Documentation (for general guidance on using credentials and nodes)
This summary covers the "Remove Signatory" operation for the "Document" resource based on the provided source code and input properties.