Welcome to signature API V3
The V3 API lets you create a signature request (a submission) from one or more PDF files in a single call, without pre-creating a template. You upload the PDF(s), declare the signers and where their signature fields go, and the API returns a per-signer signature link that you distribute yourself — or that Digit emails for you when sendEmail is enabled.
Core concepts
- Submission — one signature request, created from uploaded documents.
- Signer (a.k.a. submitter) — a person who must sign. Has identity fields and a list of signature fields positioned on the documents.
- Field — a placement on a document where the signer signs. V3 uses signature fields (type
"signature"). - Signature link — the URL a signer opens to review and sign (
/sign/{uuid}). - API token — the bearer credential scoping all calls to one user / organization and one environment (
testorproduction). - Webhooks — optional callbacks fired on
sent/signed/refusedevents.
Base URL & conventions
- Base path:
https://api.signature.nc/api/v3 - Auth: every endpoint requires a Bearer API token.
- Encoding:
POST /signatures→multipart/form-data(file upload).- All other endpoints →
application/json.
- Responses: JSON.
- Dates: ISO 8601 strings.
Authentication
All V3 routes are protected and resolve a Strapi API token to its owning user, organization, and environment.
Authorization: Bearer {apiKey}- The token is issued via
POST /tokens(see Create a token). - On success the request is bound to the token's
user,organization, andenvironment(test|production). - On failure:
401 Unauthorized—"User not founded for this API Token".
A token is either test or production. Submissions inherit the token's environment. Only production submissions count against the plan's API envelope quota — test submissions are unlimited and do not increment usage. The two environments are fully isolated.
Signatures
The primary endpoint. Uploads documents, creates the submission, signers and fields in a single call, and returns the submission with per-signer signature links.
Submissions
Signature requests created with the API can be listed and retrieved per the current token's environment.
API tokens
Create, revoke and inspect the API tokens used to authenticate every call.
Webhooks
Register up to three callback URLs per token, fired on signature lifecycle events.