Resources

Documents

Upload PDFs, track status, void, download the signed result, and clean up drafts. Documents are the core object in the SigPen API.

Available on Developer+Quota: plan-basedWebhooks: document.*
GET/api/v1/documents#

List documents

ParameterTypeDescription
statusoptionalstring
pageoptionalinteger
per_pageoptionalinteger
searchoptionalstring
sortoptionalenum: created_at · updated_at
orderoptionalenum: asc · desc
GET /api/v1/documents
curl -X GET \
  https://www.sigpen.com/api/v1/documents \
  -H "Authorization: Bearer sp_test_your_key"
200 · RESPONSE
{
  "data": [
    {
      "id": "doc_123",
      "external_id": "crm-7841",
      "title": "Mutual NDA",
      "file_name": "nda.pdf",
      "status": "draft",
      "metadata": {
        "key": "value"
      },
      "created_at": "2026-06-11T18:02:11Z",
      "updated_at": "2026-06-11T18:02:11Z"
    }
  ],
  "pagination": {
    "page": 1,
    "per_page": 0,
    "total": 0,
    "total_pages": 0
  }
}
POST/api/v1/documents#

Upload a document

Upload a base64-encoded PDF for signing. Counts toward monthly document limit.

ParameterTypeDescription
filerequiredstringBase64-encoded PDF
file_namerequiredstring
titleoptionalstring
external_idoptionalstringYour own record ID, stored on the document and returned in every webhook.
metadataoptionalobject
POST /api/v1/documents
curl -X POST \
  https://www.sigpen.com/api/v1/documents \
  -H "Authorization: Bearer sp_test_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "file": "JVBERi0xLjcK… (base64 PDF)",
    "file_name": "nda.pdf",
    "title": "Mutual NDA",
    "external_id": "crm-7841"
  }'
201 · RESPONSE
{
  "id": "doc_123",
  "external_id": "crm-7841",
  "title": "Mutual NDA",
  "file_name": "nda.pdf",
  "status": "draft",
  "metadata": {
    "key": "value"
  },
  "created_at": "2026-06-11T18:02:11Z",
  "updated_at": "2026-06-11T18:02:11Z"
}
GET/api/v1/documents/{id}#

Get a document

ParameterTypeDescription
idrequiredpathstring
GET /api/v1/documents/{id}
curl -X GET \
  https://www.sigpen.com/api/v1/documents/doc_123 \
  -H "Authorization: Bearer sp_test_your_key"
DELETE/api/v1/documents/{id}#

Delete a document (trash)

Moves a draft document to trash (30-day soft delete).

ParameterTypeDescription
idrequiredpathstring
DELETE /api/v1/documents/{id}
curl -X DELETE \
  https://www.sigpen.com/api/v1/documents/doc_123 \
  -H "Authorization: Bearer sp_test_your_key"
POST/api/v1/documents/{id}/void#

Void a document

ParameterTypeDescription
idrequiredpathstring
reasonrequiredstring
POST /api/v1/documents/{id}/void
curl -X POST \
  https://www.sigpen.com/api/v1/documents/doc_123/void \
  -H "Authorization: Bearer sp_test_your_key" \
  -H "Content-Type: application/json" \
  -d '{
    "reason": "string"
  }'
GET/api/v1/documents/{id}/download#

Download signed PDF

ParameterTypeDescription
idrequiredpathstring
GET /api/v1/documents/{id}/download
curl -X GET \
  https://www.sigpen.com/api/v1/documents/doc_123/download \
  -H "Authorization: Bearer sp_test_your_key"