API Reference
Build on vScrawl¶
Everything you can do from the vScrawl app, you can do over the API — upload documents, route them to signers, run bulk send-outs, and embed signing inside your own product. This reference is organized to match the app itself, one section per screen.
Explore by section¶
-
The home screen's stats, folder overview, and recent-document feed in a single call.
-
Upload, list, filter by status, download signed copies, rename, and delete.
-
Personal folders for organizing your own documents.
-
Reusable templates with placeholder recipients, folders, and per-template analytics.
-
Org details, members, business apps, branding, billing, roles, and email routing.
-
Account, signatures, notifications, security, assistant, and auto delegation.
Core flows¶
-
The full sequence: upload → add recipients → place fields → send → sign. Covers ordered vs. parallel signing, approvals, declines, and completion.
-
Bulk-send one document to hundreds of recipients, each getting their own copy, with live progress and CSV export.
-
How a recipient without an account gets access, verifies identity, captures consent, and signs.
-
What differs on iOS/Android — bearer-token auth, deep-link guest signing, runtime server config, and camera capture.
-
Register a business app, dispatch workflows server-side, and embed the signing UI inside your own product.
Before your first call¶
-
Workflows vs. documents vs. recipients, the status lifecycle, and how the app's wording maps to API values.
-
Four mechanisms depending on who's calling — a logged-in user, a recipient on a signing link, or a partner integration.
-
One shared error shape, status-code conventions, and how validation failures are reported.
Calling the API¶
Every request goes to your environment's host plus the path shown on each page:
Replace {host} with your environment's hostname. There's no shared public host — each deployment is its own environment.