delete https://secure.finch-app.com/api/public/v1/file//recipient/
Removes a given recipient from a file.
Permissions
The following permissions are required to call this API. Learn more.
| Permission type | Permissions |
|---|---|
| API key action permission | File |
| Folder access control list permission | Sender |
Remarks
Recipients may only be removed when the file is at status "pending" (i.e. out for completion).
Recipients may not be removed when:
- The recipient has already completed their form
- The recipient is a signatory, and they have already electronically signed any current or historic document in the file
- The recipient has already made a payment against a balance
- They are the last/only recipient in the file
- Removing the recipient would leave fewer than the required number of recipients in a group