5.10 Skip Signers
5.10.1 Description
A package that has been signed by at least one party, but still has some unsigned fields, that must be signed by others can now be finished by doing a Skip Signers call. This call skips all signers that haven’t signed yet and sets their status to “Skipped”, which results in the complete package being marked as “Finished”.
This way, the package becomes available for download and it is no longer necessary to wait for all parties to sign before everyone can download the document.
If the package was created with the SendNotifications parameter set to true, then all signers will get a notification that they can download the ended package.
Attention: when you skip signers through the API, no info is added to the Audit proofs about who skipped them. This info can be added by means of the Add Proof from External Source call. See section 7.3 for more information.
5.10.2 URL
https://[servername]:[port]/webportalapi/v3/packages/{packageId}/skipsigners
5.10.3 HTTP Method
POST
5.10.4 Template parameter
Parameter | Content/Description | Type |
---|---|---|
packageId | Unique Identifier of the Package | String |
5.10.5 Response parameters
Parameter | Content/Description |
---|---|
None | Empty object |
5.10.6 Example response
{}
5.10.7 Response codes
Response status code | Description |
---|---|
200 OK | All signers that hadn’t signed yet were successfully skipped. |
5.10.8 Error codes
HTTP Code | Code |
---|---|
404 | Package.NotFound:{packageId} |
409 | Package.ContainsNoDocuments:{packageId} |
409 | Package.InvalidStatus:{packageStatus} |
409 | Package.NotSigned:{packageId} |