Skip to content

DEVELOPER GUIDE

Signing that fits your workflow.

A REST API for PDF templates, AI-assisted field preparation, and signing requests. API access is included in every paid plan.

1. Create an account and key

Create your SigningPath account, verify your email, and choose a plan. In API keys, create a key with the scopes your integration needs. Keys are shown once and can be revoked at any time. Keep them on your server.

2. Authenticate requests

curl https://signingpath.com/api/v1/templates \
  -H "Authorization: Bearer $SIGNINGPATH_API_KEY"

Use documents:read for status and downloads, documents:write for templates, documents:send for invitations, and ai:use for AI classification. Never place a live key in client-side JavaScript.

3. Prepare a template

  1. Request a private PDF upload URL with POST /api/v1/templates/sign-upload.
  2. Upload the PDF to the returned URL. Keep the returned path unchanged.
  3. Create the template with POST /api/v1/templates using that path.
  4. Review and place fields in the web editor, or save field definitions through PUT /api/v1/templates/:id.

The AI endpoint classifies text-and-geometry candidates extracted from a PDF. The web editor handles extraction for you. It does not accept an arbitrary PDF URL or promise to OCR every scanned document. Review and confirm suggestions before sending.

4. Send an invitation

curl https://signingpath.com/api/v1/documents \
  -H "Authorization: Bearer $SIGNINGPATH_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: your-unique-request-id" \
  -d '{"templateId":"YOUR_TEMPLATE_UUID","signers":[{"role":"recipient","name":"Alex Example","email":"alex@example.com","delivery":"email","order":1}],"fieldValues":{}}'

Reuse the same idempotency key and identical request body when retrying a send after a connection problem. A different document needs a different key. Web and API sends share your billing-period allowance.

5. Track completion

Use GET /api/v1/documents/:id to poll status. When completed, request GET /api/v1/documents/:id/download for the PDF. Private signer-access tokens are not returned in document lists.

Text invitations

Connect an owned Telnyx sender in Settings. Supply the recipient’s phone number and record consent when using SMS. Existing opt-outs stay in effect. The provider bills messaging separately.

Limits and errors

Unauthenticated requests return 401, missing scopes return 403, and rate or plan limits prevent new paid operations. Validate the response body before assuming a signing invitation was delivered. A created document and a delivered notification are distinct outcomes.

Read the OpenAPI specification for request schemas and endpoints. For integration help, contact david@setmate.ai.