The Cancel operation allows removal of a document from active status. When this operation is called, the document will no longer be available for signing.
The Cancel operation requires knowledge of the following:
- the Document ID of the document to cancel (this is returned as an element in the returned response from a document submission operation)
- the AssureSign account ContextIdentifier (this is exposed in the AssureSign administrative application account settings and serves to provide some security to the transaction)
- the AuthToken of the document to cancel (this is returned as an element in the returned XML from a document submission operation)
- Additionally, an optional Remarks attribute may be passed that will be included in the document status history record that will be created when this cancellation request is processed.
<?xml version="1.0" encoding="utf-8"?> <Cancel xmlns="https://www.assuresign.net/Services/DocumentNOW/Cancel"> <DocumentCancellations> <DocumentCancellation ContextIdentifier="06C4A84A-693C-46CB-8DF2-40A8215AA056" Id="2CE11EF1-8938-DD11-8735-00065B8CE99B" AuthToken="8CC9A84B-693C-46CC-4342-40A8215AD76A" Remarks="" /> </DocumentCancellations> </Cancel>
The SOAP Action header is
A simple response is returned echoing the document information which will contain an Exceptions node only if some issue has occurred:
<?xml version="1.0" encoding="utf-8"?> <CancelResponse xmlns="https://www.assuresign.net/Services/DocumentNOW/Cancel"> <DocumentCancellationResults> <DocumentCancellationResult Id="2CE11EF1-8938-DD11-8735-00065B8CE99B" /> </DocumentCancellationResults> </CancelResponse>
The DocumentCancellationResult should be checked for the presence of an Exceptions element, which may contain multiple CancellationException items.