Validation

The documented schema requirements for request bodies, and how to validate before you send.

Documented schema requirements

SignatureRequestCreate

Required fields (everything else is optional, see Create Signature Request):

Optional fields include mode (defaults to email), message (defaults to empty), sequential_signing, field_visibility, external_id, metadata, webhook and the legacy webhook_url.

TemplateRequest

Required fields (plus optional prefill array of {id, name, value} objects):

Signer

Required fields:

Webhook

Required fields:

Validate before you send

Check the following on the client before submitting a request:

• Every required field is present with a non-empty value.
• Each template_id exists for your account (retrieve them via List Templates).
• Every signer has both name and email.
• The JSON body is valid and matches the documented field names.
• Headers are correct: Authorization and Content-Type, plus Idempotency-Key for create operations.

Related