Skip to main content
POST
/
v1
/
signatures
/
{id}
/
cancel
Cancel a signature request
curl --request POST \
  --url https://api.craftkit.dev/v1/signatures/{id}/cancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Superseded by a corrected document."
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "renderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "recipients": [
    {
      "id": "<string>",
      "firstName": "<string>",
      "email": "jsmith@example.com",
      "lastName": "<string>",
      "order": 123,
      "signedAt": "2023-11-07T05:31:56Z",
      "declinedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "expirationHours": 123,
  "signedDownloadUrl": "<string>",
  "certificateUrl": "<string>",
  "errorMessage": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Project API key (ck_live_… or ck_test_…) presented as a bearer token. For embed partner endpoints this is the partner secret key, which is the same credential type.

Path Parameters

​
id
string<uuid>
required

The signature request id.

Body

application/json
​
reason
string
Maximum string length: 500

Response

Signature request cancelled.

​
id
string<uuid>
required
​
renderId
string<uuid>
required
​
name
string
required
​
status
enum<string>
required
Available options:
sent,
viewed,
completed,
declined,
expired,
cancelled,
failed
​
recipients
object[]
required
​
expirationHours
integer | null
required
​
signedDownloadUrl
string<uri> | null
required

Authenticated download URL; null until the signed PDF is archived.

​
certificateUrl
string<uri> | null
required

Craftkit-owned authenticated URL (/v1/signatures/{id}/certificate) for the completion certificate; null until it is available. Not a provider URL.

​
errorMessage
string | null
required
​
createdAt
string<date-time>
required
​
completedAt
string<date-time> | null
required