PenlyDoc API
Send documents for signature from your product, show the signing page inside it, and get the signed PDF back. Step-by-step guide: [/docs](/docs). Embedding…
Developer tools#documents--productivity
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Send documents for signature from your product, show the signing page inside it, and get the signed PDF back. Step-by-step guide: /docs. Embedding from A to Z: /docs/embed.
Authorize with your API key (Console → Developers). Keep it on your server.
Endpoints 35
Organisation
- GETWho am I (checks the API key)
/v1/me
Envelopes
- PUTReplace the boxes of a draft
/v1/envelopes/:id/fields - GETFind envelopes by externalRef or status
/v1/envelopes - POSTCreate an envelope from PDF/DOCX files
/v1/envelopes - POSTCancel an envelope that is out for signature
/v1/envelopes/:id/void - POSTSend a draft
/v1/envelopes/:id/send - POSTRemind everyone who has not signed yet
/v1/envelopes/:id/remind - POSTGet a signing link for embedding (valid 1 hour, ask on demand)
/v1/envelopes/:id/recipients/:recipientId/signing-url - POSTInvalidate all links of one person
/v1/envelopes/:id/recipients/:recipientId/revoke-links - POSTCopy an envelope into a new draft
/v1/envelopes/:id/duplicate - GETGet an envelope with its people and statuses
/v1/envelopes/:id - DELETEDelete an envelope and its files for good
/v1/envelopes/:id - GETDownload the signed PDF (once completed)
/v1/envelopes/:id/documents/signed - GETDownload the original PDF
/v1/envelopes/:id/documents/original - GETHash-chained history of the envelope
/v1/envelopes/:id/audit
Templates
- PUTReplace the boxes and data boxes of a template
/v1/templates/:id/fields - GETList templates
/v1/templates - POSTCreate a template from PDF/DOCX files
/v1/templates - POSTSend a document from a template (JSON only)
/v1/templates/:id/envelopes - POSTArchive a template
/v1/templates/:id/archive - GETGet a template with its roles and data keys
/v1/templates/:id - GETDownload the template PDF
/v1/templates/:id/document
Webhooks
- GETShow the webhook URL
/v1/webhook - PUTSet the webhook URL (returns a new signing secret)
/v1/webhook - POSTResend one delivery
/v1/webhook-deliveries/:id/retry - POSTSend a test event to your webhook
/v1/webhook-deliveries/test - GETRecent webhook deliveries
/v1/webhook-deliveries
Branding and embedding
- GETShow branding and embed origins
/v1/branding - PUTChange branding and embed origins
/v1/branding - GETDownload the logo
/v1/branding/logo - PUTUpload a logo (PNG or JPEG)
/v1/branding/logo - DELETERemove the logo
/v1/branding/logo
Settings
- GETDefault reminder interval
/v1/settings/reminders - PUTChange the default reminder interval
/v1/settings/reminders
Verification
- POSTCheck a signed PDF (no key needed)
/api/verify
API details
- Base URL
https://penlydoc.com- Authentication
- A bearer token in the Authorization header
- Operations
- 35 operations on 27 pathsGET 14POST 13PUT 6DELETE 2
- Main resources
- Envelopes 14Templates 7Branding and embedding 5Webhooks 5Settings 2Organisation 1Verification 1
- Response formats
*/*- Description format
- OpenAPI 3.1.0, API version
v1 - Links
- OpenAPI document
- Listed from
- Penlydoc's published OpenAPI description
How to test the PenlyDoc API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the PenlyDoc API collection, without the publisher's secrets.
- Add your credentialsThis API uses A bearer token in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Who am I (checks the API key)” (GET /v1/me), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the PenlyDoc API?
Send documents for signature from your product, show the signing page inside it, and get the signed PDF back. Step-by-step guide: [/docs](/docs). Embedding… It is listed under Developer tools and has 35 endpoints.
Who publishes the PenlyDoc API?
It is listed from Penlydoc's public API description (an OpenAPI document), not published by Penlydoc on Swastik Codes. Anyone who controls penlydoc.com can claim the profile by adding a DNS TXT record.
What is the base URL of the PenlyDoc API?
Requests go to https://penlydoc.com. Endpoint paths are added to this base URL.
How do I authenticate with the PenlyDoc API?
With A bearer token in the Authorization header.
How many endpoints does the PenlyDoc API have?
35 operations on 27 paths (14 GET, 13 POST, 6 PUT, 2 DELETE). The largest groups are Envelopes, Templates, Branding and embedding, Webhooks.
Is forking the PenlyDoc API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.