Skip to content

Authentication

The inSigner API uses API keys with Bearer token authentication. Every request must include a valid API key in the Authorization header.

  1. Go to Dashboard → Developers → API Keys in the inSigner web app.
  2. Click Create API Key.
  3. Give your key a name (e.g. “Production Backend”) and select the scopes you need.
  4. Click Create. Your key is displayed once — copy it immediately.

Include your API key in the Authorization header as a Bearer token:

Terminal window
curl -X GET https://app.insigner.co/api/v1/documents \
-H "Authorization: Bearer isk_YOUR_API_KEY"

All inSigner API keys start with the prefix isk_ followed by 44 characters of URL-safe random data:

isk_A1b2C3d4E5f6G7h8I9j0K1l2M3n4O5p6Q7r8S9t0U1v2

Keys that don’t start with isk_ are rejected immediately.

Scopes control what resources an API key can access. You can assign granular scopes or use the wildcard * for full access.

ScopeDescription
*Full access to all resources
documents.*Full access to documents
documents.readList and retrieve documents
documents.createCreate new documents
documents.writeUpdate documents, add fields/signers, upload files
documents.sendSend documents and reminders
documents.deleteDelete documents
templates.readList and retrieve templates
campaigns.*Full access to campaigns
campaigns.readList and retrieve campaigns
campaigns.createCreate campaigns
campaigns.updateUpdate campaigns
campaigns.deleteDelete campaigns
bulk_sends.*Full access to bulk sends
bulk_sends.readList and retrieve bulk sends
bulk_sends.createCreate bulk sends
bulk_sends.deleteDelete bulk sends
webhooks.*Full access to webhooks
webhooks.readList and retrieve webhooks
webhooks.createCreate webhooks
webhooks.updateUpdate webhooks
webhooks.deleteDelete webhooks
org.readRead organization info and members

Wildcard scopes like documents.* match all sub-scopes (e.g. documents.read, documents.create, etc.).

  • Never commit keys to version control. Use environment variables or a secrets manager.
  • Use the minimum scopes needed. A key that only reads documents should not have documents.delete.
  • Rotate keys regularly. Revoke old keys from the dashboard and create new ones.
  • Use separate keys per environment. Don’t share keys between production and development.
  • Monitor usage. Check the API Logs page in the dashboard for unusual activity.
StatusError CodeDescription
401MISSING_KEYNo Authorization header or not using Bearer scheme
401INVALID_FORMATKey doesn’t start with isk_
401INVALID_KEYKey not found or doesn’t match
401KEY_REVOKEDKey has been revoked from the dashboard
401KEY_EXPIREDKey has passed its expiration date
403INSUFFICIENT_SCOPEKey lacks the required scope for this endpoint

Example error response:

{
"type": "https://docs.insigner.com/errors/unauthorized",
"title": "Unauthorized",
"status": 401,
"detail": "Invalid or missing API key"
}