API reference
Documents and e-signature
Send documents for signature from your own systems. The usual flow is to prepare a template once in the app, then create and send documents from it through the API.
A template holds the PDF, the signer roles and where each field sits on the page. Build it in Documents → Templates, then copy its id from the address bar.
Create a document from a template
POST
/envelopes/{id}/useCreates a document from a template and fills in the people who sign. Set send to send it straight away.
Path parameters
iduuidrequiredThe template id.
Body
titlestringTitle of the new document. Defaults to the template's title.
recordIduuidA CRM record to link the document to. It then shows on that record.
recipientsobject[]One entry per signer role in the template, in order:
{"name":"…","email":"…","phone":"…"}.sendbooleantrue to send now. Otherwise the document is saved as a draft.Request
curl -X POST "https://api.spartivo.com/api/v1/envelopes/ab5de29a-051a-4e1e-86db-acf0c18a9b09/use" \
-H "Authorization: Bearer wk_your_key" \
-H "Content-Type: application/json" \
-d '{"title":"Service agreement, Northwind Trading","recordId":"a0d3bf2c-688d-42da-83e1-d5e57d3e990d","recipients":[{"name":"Aisha Khan","email":"aisha@example.com"}],"send":true}'Response
{
"id": "8a1fc245-12cf-4617-ac1e-0bc0a23b9d92",
"title": "Service agreement, Northwind Trading",
"status": "sent",
"recordId": "a0d3bf2c-688d-42da-83e1-d5e57d3e990d",
"expiresAt": "2026-12-02T08:47:48.111Z"
}List documents
GET
/envelopesDocuments sent for signature, newest first.
Query parameters
statusstringdraft, sent, viewed, partially_signed, completed, declined, expired or voided.qstringSearch by title.
templatestring1 to list templates instead.Request
curl "https://api.spartivo.com/api/v1/envelopes?status=completed" \
-H "Authorization: Bearer wk_your_key"Response
[
{
"id": "8a1fc245-12cf-4617-ac1e-0bc0a23b9d92",
"recordId": null,
"title": "agreement",
"status": "completed",
"sourceFileId": "dacced18-8a22-4702-819f-abf6390f57ff",
"finalFileId": "1c82ca55-bc02-4873-9d3b-f07e1691877e",
"documentHash": "c3a909f6d61c30bdc7e37975713c3a112e8d3a6efe2715b088e03af3c621f656",
"expiresAt": "2026-12-01T08:47:48.111Z"
}
]Get a document
GET
/envelopes/{id}One document with its recipients, fields and audit trail. When the status is completed, finalFileId is the signed PDF; fetch it with Download a file.
Path parameters
iduuidrequiredThe document id.
- Each recipient also carries a
token, which is their private signing link key. Do not log it or pass it to anyone but that recipient.
Request
curl "https://api.spartivo.com/api/v1/envelopes/8a1fc245-12cf-4617-ac1e-0bc0a23b9d92" \
-H "Authorization: Bearer wk_your_key"Response
{
"id": "8a1fc245-12cf-4617-ac1e-0bc0a23b9d92",
"title": "agreement",
"status": "completed",
"finalFileId": "1c82ca55-bc02-4873-9d3b-f07e1691877e",
"sentAt": "2026-11-17T08:47:48.111Z",
"completedAt": "2026-11-17T08:52:11.000Z",
"recipients": [
{
"id": "47e23f56-f34c-42c7-bfbf-5b6846c94d49",
"name": "Aisha Khan",
"email": "aisha@example.com",
"role": "signer",
"order": 1,
"status": "signed",
"viewedAt": "2026-11-17T08:47:52.932Z",
"signedAt": "2026-11-17T08:52:10.000Z"
}
],
"events": [
{
"type": "sent",
"recipientId": null,
"createdAt": "2026-11-17T08:47:48.111Z"
},
{
"type": "signed",
"recipientId": "47e23f56-f34c-42c7-bfbf-5b6846c94d49",
"ip": "203.0.113.24",
"createdAt": "2026-11-17T08:52:10.000Z"
}
]
}Send a draft
POST
/envelopes/{id}/sendSends a draft to its recipients.
Path parameters
iduuidrequiredThe document id.
Request
curl -X POST "https://api.spartivo.com/api/v1/envelopes/8a1fc245-12cf-4617-ac1e-0bc0a23b9d92/send" \
-H "Authorization: Bearer wk_your_key" \
-H "Content-Type: application/json" \
-d '{}'Response
{
"id": "8a1fc245-12cf-4617-ac1e-0bc0a23b9d92",
"title": "agreement",
"status": "sent",
"sentAt": "2026-11-17T08:47:48.111Z",
"recipients": [
"…"
]
}Send a reminder
POST
/envelopes/{id}/remindReminds everyone who has not signed yet, or one recipient.
Path parameters
iduuidrequiredThe document id.
Body
recipientIduuidRemind only this recipient.
Request
curl -X POST "https://api.spartivo.com/api/v1/envelopes/8a1fc245-12cf-4617-ac1e-0bc0a23b9d92/remind" \
-H "Authorization: Bearer wk_your_key" \
-H "Content-Type: application/json" \
-d '{}'Response
{
"reminded": [
{
"name": "Aisha Khan",
"via": "email",
"ok": true
}
]
}Void a document
POST
/envelopes/{id}/voidCancels a document that has been sent. Signing links stop working.
Path parameters
iduuidrequiredThe document id.
Body
reasonstringShown to recipients and kept in the audit trail.
Request
curl -X POST "https://api.spartivo.com/api/v1/envelopes/8a1fc245-12cf-4617-ac1e-0bc0a23b9d92/void" \
-H "Authorization: Bearer wk_your_key" \
-H "Content-Type: application/json" \
-d '{"reason":"Pricing changed"}'Response
{
"id": "8a1fc245-12cf-4617-ac1e-0bc0a23b9d92",
"title": "agreement",
"status": "voided",
"voidReason": "Pricing changed",
"recipients": [
"…"
]
}