Documentation
Documents
documents.signature
REST
ShippingPOST /api/v1/documents/signatureMCP tool
Livedocuments.signatureExposed on: REST API · Shop MCP server · Claude connector · Dash (in-app copilot) · Zapier. Part of the Documents domain.
Operating contract
THE EVIDENCE ON A SIGNED DOCUMENT: who signed it, when, how, and whether the file sitting in storage is still byte-for-byte the one they put their name to.
integrity HAS THREE VALUES AND THE THIRD IS NOT A FAILURE. match means the stored file still hashes to what was signed. mismatch means it does NOT, and that is a finding to escalate rather than to report casually. unknown means there is nothing to compare against — no hash was stored, the record came from outside, or the file is past the size the product hashes — and absence of evidence must never be read out as evidence of tampering.
SAY unknown PLAINLY when it comes back. An unverifiable signature is still a signature; a machine that reports it as suspect has accused a customer of something over a missing column.
method is how it was signed. signer_email may be null — the shop can take a signature in person from somebody it already knows.
NO IP ADDRESS IS RETURNED, here or anywhere. The record stores a keyed digest of it and never the address itself, which is why the field is absent rather than redacted.
signed: false means this document carries no signature at all. That is the common case for most of a shop's library and is not a problem.
One document's signature, entirely returned, so nothing is truncated.
Who may call it
- Permission
customers.accessThe caller must hold Customers at the ACT level. A read-only dashboard grant on the same section is refused.- Plan
- Every planNo plan gate. Available on every Service VIN plan.
- Retries
naturalNaturally idempotent — running it twice leaves the same world as running it once. A retrying integration needs no key.- Rate class
readCounted against the read budget — the widest of the four.
Input
| Field | Type | Description |
|---|---|---|
| document_idrequired | stringuuid | The document to check, as returned by documents.list or documents.signature_requests. |
Output
| Field | Type | Description |
|---|---|---|
| document_id | string | — |
| signed | boolean | — |
| signer_name | string | null | — |
| signer_email | string | null | — |
| method | string | null | — |
| signed_at | string | null | — |
| customer_id | string | null | — |
| integrity | string | — |
Examples
Built from this capability's own schema — required fields and the ones carrying a default, and nothing invented. Paste one and it validates.
export SERVICEVIN_API_KEY=svk_live_…
curl -X POST https://www.servicevin.com/api/v1/documents/signature \
-H "Authorization: Bearer $SERVICEVIN_API_KEY" \
-H "Content-Type: application/json" \
-d '{"document_id":"9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"}'const res = await fetch("https://www.servicevin.com/api/v1/documents/signature", {
method: "POST",
headers: {
Authorization: `Bearer ${process.env.SERVICEVIN_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"document_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
}),
});
// Success and failure are both envelopes. Switch on error.code, never
// on error.message — the codes are stable, the messages are for people.
const payload = await res.json();
if (!res.ok) throw new Error(payload.error.code);
const data = payload.data;import os, requests
res = requests.post(
"https://www.servicevin.com/api/v1/documents/signature",
headers={"Authorization": f"Bearer {os.environ['SERVICEVIN_API_KEY']}"},
json={
"document_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
},
timeout=30,
)
payload = res.json()
if not res.ok:
raise RuntimeError(payload["error"]["code"])
data = payload["data"]{
"jsonrpc": "2.0",
"id": 1,
"method": "tools/call",
"params": {
"name": "documents.signature",
"arguments": {
"document_id": "9b2f1c6e-4a77-4d2b-9f31-0f1c9a8e5d20"
}
}
}Refusals
The four gates run in this order on every surface, and the order is not arbitrary — see Authentication.
| Status | Code | When |
|---|---|---|
| 404 | not_found | The id is unknown, or the feature is not enabled for this account. Deliberately the same answer for both. |
| 403 | forbidden | This login does not hold customers.access. |
| 422 | validation_error | An argument was wrong. The message names the field. |
| 429 | rate_limited | Too many read calls. Back off and retry. |
| 500 | internal_error | Something failed on our side. Nothing was changed. |