Skip to main content
GET https://api.craftkit.dev/v1/signatures/:id
Poll a single signature request for its current status and, once available, the signed-document URL and completion certificate.

Authorization

Authorization
string
required
Bearer ck_live_… — a project API key.

Path parameters

id
string
required
The signature request id (UUID).

Response

id
string
renderId
string
name
string
status
string
See the status lifecycle below.
recipients
object[]
May include per-recipient signedAt / declinedAt once those events arrive.
expirationHours
number | null
signedDownloadUrl
string | null
Authenticated download URL; null until the document is archived.
certificateUrl
string | null
Authenticated completion-certificate / audit-trail URL (/v1/signatures/{id}/certificate); null until available.
errorMessage
string | null
createdAt
string
completedAt
string | null
Set when the request completes.

Status lifecycle

StatusMeaning
sentRequest created; the signature service emailed the recipients.
viewedA recipient opened the signing UI.
declinedA recipient declined to sign (terminal).
expiredThe request passed its expiration window (terminal).
cancelledThe request was cancelled (terminal).
completedAll recipients signed and the document is finalized (terminal).
failedProcessing failed (terminal).
Recipient-level signing arrives as a signature.signed webhook (and per-recipient signedAt timestamps) without moving the top-level status. On completed, Craftkit archives the signed PDF and populates signedDownloadUrl and certificateUrl.

Errors

StatuscodeMeaning
401unauthorizedMissing/invalid/revoked key.
404not_foundNo such signature request in this key’s project.
cURL
curl https://api.craftkit.dev/v1/signatures/$SIGNATURE_ID \
  -H "Authorization: Bearer $CRAFTKIT_API_KEY"
200
{
  "id": "0193c2c3-2222-7aaa-8bbb-000000000002",
  "renderId": "0193c2c3-1111-7aaa-8bbb-000000000001",
  "name": "Charter handover — BK-12345",
  "status": "completed",
  "recipients": [
    {
      "id": "rcp_8e10-12ab34cd56ef",
      "firstName": "Jane",
      "lastName": "Doe",
      "email": "jane@example.com",
      "designation": "Signer",
      "order": 1,
      "signedAt": "2026-06-05T11:40:00.000Z"
    }
  ],
  "expirationHours": 168,
  "signedDownloadUrl": "https://api.craftkit.dev/v1/signatures/0193c2c3-2222-7aaa-8bbb-000000000002/download",
  "certificateUrl": "https://api.craftkit.dev/v1/signatures/0193c2c3-2222-7aaa-8bbb-000000000002/certificate",
  "errorMessage": null,
  "createdAt": "2026-06-05T10:00:00.000Z",
  "completedAt": "2026-06-05T11:42:08.000Z"
}