SignatureHub API Test Console

Test all API endpoints in your browser. Configure your API key below to get started.

Not tested

Saved Context

Last Request ID: -
Last Token: -
Last Reference: -
Last Package ID: -
Last Package Code: -
Signature Requests
Multi-Party Packages
Templates
Signing Flow
Full Test

POST Create Request

/api/requests

Create a single-signer signature request. Requires documentName, signerName, and at least one contact method (email or phone). Also requires at least one document source (content, URL, or template).

Auto-detects: email if provided, SMS if phone provided, both if both

External URL to display instead of inline content

Use a pre-defined template instead of inline content

Default: 7 days from now

GET List Requests

/api/requests

GET Get Request by ID

/api/requests/:id

GET Get Request by Reference

/api/requests/ref/:referenceCode

GET Get Signature

/api/requests/:id/signature

DELETE Cancel Request

/api/requests/:id

POST Create Multi-Party Package

/api/packages

Create a signing package for multiple signers with role consolidation

Use a pre-defined template. Leave empty for custom content.

Used for age validation (trainer/coach must be 18+ at event date)

Leave as auto-detect - uses email if provided, SMS if phone provided, both if both provided.

Default: 7 days from now

Roles: participant, guardian, trainer, coach, witness. Set isPackageAdmin: true on one signer to designate them as the decision maker who can replace signers. If not specified, the first signer becomes admin.

GET Get Package Status

/api/packages/:id

POST Batch Get Package Status

/api/packages/batch

Retrieve status for multiple packages at once (max 50)

Each line can be a package UUID or package code (e.g., PKG-ABC12345)

GET List Packages

/api/packages

GET List Jurisdictions

/api/jurisdictions

View available jurisdiction addendums

GET Role Age Requirements

/api/roles/requirements

View minimum age requirements for each role

POST Create/Update Jurisdiction

/api/jurisdictions

Create or update a jurisdiction addendum with legal text

PUT Replace Signer

/api/packages/:id/roles/:roleId

Replace a signer who hasn't signed yet. Use this when someone refuses to sign and needs to be replaced.

Use "Get Package Status" to find the role ID

Required if role has minimum age requirement (trainer, coach, guardian)

Auto-detects based on provided contact info

POST Create Template

/api/templates

GET List Templates

/api/templates

GET Get Template

/api/templates/:templateCode

PUT Update Template

/api/templates/:templateCode

DELETE Delete Template

/api/templates/:templateCode

GET Get Signing Page Data

/sign/:token/data

No API key required - public endpoint

POST Send Verification Code

/sign/:token/verify

Sends email or SMS with verification code

POST Confirm Verification Code

/sign/:token/confirm

POST Submit Signature

/sign/:token/submit

GET Open Signing Page

/sign/:token

Opens the actual signing page in a new tab

Complete End-to-End Test

Run a full test of the signature flow: Create request, send verification, confirm code, and submit signature.