coss.comdocs

Cancel a signature request

POST
/v1/sign/requests/{id}/cancel

Cancels a draft or sent request: its signers can no longer sign. An already canceled request is returned as is.

Authorization

bearerAuth
headerAuthorizationBearer <token>

A secret API key from the dashboard: coss_live_… for production environments, coss_test_… for sandbox environments.

Path Parameters

id*string

The signature request's id.

Header Parameters

Coss-Version?"2026-10-10"

The API version (a date) to use for this request. Defaults to your organization's version, pinned to the latest one when it first used the API and upgraded from the dashboard. The SDK always sends the version it was built for.

Value in"2026-10-10"

Response Body

The canceled request.

application/json
  1. response
object*"sign_request"
Value in"sign_request"
id*string
status*string

draft until sent, sent while signers sign, then completed (everyone signed), declined (a signer declined), canceled or expired.

Value in"draft""sent""completed""declined""canceled""expired"
title*string
message*string|null
signing_order*string
Value in"parallel""sequential"
documents*array<>
signers*array<>
fields*array<>
metadata*
sandbox*boolean
reminder_interval_days*|

Days between automatic reminders to email signers; null: none.

expires_at*|
Formatdate-time
expired_at*|
Formatdate-time
sent_at*|
Formatdate-time
completed_at*|
Formatdate-time
canceled_at*|
Formatdate-time
declined_at*|
Formatdate-time
signed_document*|

The completed document, sealed by coss.com: every document with the signatures and values filled in, and a certificate of completion. null until it is ready (shortly after completed, announced by the sign_request.completed webhook); download it from GET /v1/sign/requests/{id}/signed_document.

created_at*string
Formatdate-time
import { Coss } from "coss";const coss = new Coss({  apiKey: process.env.COSS_API_KEY,  baseUrl: "https://api.coss.com",});const { data, error } = await coss.sign.requests.cancel("sreq_01k7c8m4q2f3e9v6t5r1n0p8yz");
{  "object": "sign_request",  "id": "sreq_01k7c8m4q2f3e9v6t5r1n0p8yz",  "status": "sent",  "title": "Services agreement",  "message": null,  "signing_order": "parallel",  "documents": [    {      "id": "sdoc_01k7c8m4q2f3e9v6t5r1n0p8yz",      "filename": "agreement.pdf",      "sha256": "9f2c6c0f0e1d4b7a8c5e3f2a1b0c9d8e7f6a5b4c3d2e1f0a9b8c7d6e5f4a3b2c",      "page_count": 2    }  ],  "signers": [    {      "object": "sign_signer",      "id": "ssgn_01k7c8m4q2f3e9v6t5r1n0p8yz",      "name": "Ada Lovelace",      "email": "ada@example.com",      "order": 1,      "delivery": "email",      "authentication": "email_link",      "status": "pending",      "client_ref": null,      "viewed_at": null,      "signed_at": null,      "declined_at": null,      "decline_reason": null    }  ],  "fields": [    {      "object": "sign_field",      "id": "sfld_01k7c8m4q2f3e9v6t5r1n0p8yz",      "signer_id": "ssgn_01k7c8m4q2f3e9v6t5r1n0p8yz",      "document_id": "sdoc_01k7c8m4q2f3e9v6t5r1n0p8yz",      "type": "signature",      "page": 2,      "x": 72,      "y": 640,      "width": 140,      "height": 12,      "required": true,      "label": null,      "anchor": "{{signature:signer_1}}"    }  ],  "metadata": {},  "sandbox": false,  "reminder_interval_days": 3,  "expires_at": null,  "expired_at": null,  "sent_at": "2026-10-26T15:04:05.000Z",  "completed_at": null,  "canceled_at": null,  "declined_at": null,  "signed_document": null,  "created_at": "2026-10-26T15:04:05.000Z"}