Skip to main content
POST
Cancel a signature request

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