Description

Cancels the given document (the document is then still available for the signee, but no longer marked as ready for signature). Remark: if using Json, a GUID must not contain dashes (-), unlike XML.

HTTP method: POST
URI: https://api.signere.no/api/Document/CancelDocument
Autorization model: Minimum secondary apikey is needed for this operation.
Subscription needed: "Sign document offline" or "Sign document online"
Parameters
  • request: Contains all necessary parameters to cancel a document (FromBody)
Name Type Description Example value Required Max length Min length Nullable Enum Regex
CanceledDate DateTime The date the document was canceled 2012-12-12T00:00:00.0000000 True 19 19 False False
DocumentID Guid The ID of the document that shall be canceled. EA522127D971420595EFA08A00D4D3AE True 36 36 False False ^(\{{0,1}([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}\}{0,1})$
Explanation String Explanation to the receiver why the document was canceled Receiver's address was wrong, sending new contract with the correct address. False 255   False False
Signature String Signature of the person that canceled the document Ola Nordmann True 150   False False
Name CanceledDate
Type DateTime
Description The date the document was canceled
Example value 2012-12-12T00:00:00.0000000
Required True
Max length 19
Min length 19
Nullable False
Enum False
Regex
Name DocumentID
Type Guid
Description The ID of the document that shall be canceled.
Example value EA522127D971420595EFA08A00D4D3AE
Required True
Max length 36
Min length 36
Nullable False
Enum False
Regex ^(\{{0,1}([0-9a-fA-F]){8}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){4}-?([0-9a-fA-F]){12}\}{0,1})$
Name Explanation
Type String
Description Explanation to the receiver why the document was canceled
Example value Receiver's address was wrong, sending new contract with the correct address.
Required False
Max length 255
Min length  
Nullable False
Enum False
Regex
Name Signature
Type String
Description Signature of the person that canceled the document
Example value Ola Nordmann
Required True
Max length 150
Min length  
Nullable False
Enum False
Regex
{
    "CanceledDate": "2012-12-12T00:00:00.0000000",
    "Explanation": "Receiver's address was wrong, sending new contract with the correct address.",
    "Signature": "Ola Nordmann",
    "DocumentID": "ea522127d971420595efa08a00d4d3ae"
}

XML elements must be in same order as in this example xml

<?xml version="1.0" encoding="utf-8"?>
<CancelDocumentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Unipluss.Sign.ExternalContract.Entities">
   <CanceledDate>2012-12-12T00:00:00</CanceledDate>
   <DocumentID>ea522127-d971-4205-95ef-a08a00d4d3ae</DocumentID>
   <Explanation>Receiver's address was wrong, sending new contract with the correct address.</Explanation>
   <Signature>Ola Nordmann</Signature>
</CancelDocumentRequest>