API v2

API v2 is live at /api/v2. It checks every request strictly and says exactly what's wrong, returns one error format everywhere, and makes every resource consistent. API v1 keeps working, with the e-signature changes in Safer E-Signatures.

• Strict requests. An unknown property or query parameter, a value of the wrong type or a value outside a list is a 422 that points at the value and says how to fix it. Submission data is checked when you create the submission, including barcode values, email addresses and field overrides, instead of failing later when the PDF is generated.
• One error format, {"error": {"code", "message", "details", "request_id"}}, for every error.
• Consistent resources. Responses are the resource itself, every list is cursor-paginated, creates return 201, and every name is snake_case.
• Signature requests. Data requests are now called signature requests, and a signer's role replaces v1's skipped placeholders.
• Webhooks created with v2 send each event's resource as v2 returns it.

Version 4.0.0 of our SDKs uses API v2. Each SDK checks a request against the API's own rules before sending it, so most mistakes show up in your code before they reach DocSpring.

Migrating to API v2 lists every difference from v1.