Signature requests

Create and send a signature request

Locks the current version of the document and emails recipients (in order for sequential routing). Pass full fields (with assignee = recipient key) or useDocumentFields: true with assignees by field name. send: false creates a draft. Uses one signature request from your plan when sent.

post/v1/signature-requests/

Request

  • Base URL: https://api.pdfbetter.com
  • URL: https://api.pdfbetter.com/v1/signature-requests/
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Any unique string (≤ 255 chars). The first successful response is replayed for 24 hours for the same key and request.

Request body

documentIdstring required
titlestring

Default: the document title

messagestring
routing'sequential' | 'parallel'
useDocumentFieldsboolean

Use the fields already placed on the document

assigneesobject

With useDocumentFields: field name → recipient key. Unlisted fields go to the only signer when there is exactly one.

reminderEveryDaysinteger nullable
expiresInDaysinteger nullable
sendboolean

false = create a draft

locale'en' | 'es' | 'ja' | 'fr' | 'de'

Language of the recipients' emails, signing page and certificate: en, es, ja, fr or de. Default: your account language, else en.

Response

Create and send a signature request

object'signature_request' required
idstring required
documentIdstring required
titlestring required
messagestring nullable required
status'draft' | 'sent' | 'completed' | 'declined' | 'canceled' | 'expired' required
routing'sequential' | 'parallel' required
reminderEveryDaysinteger nullable required
expiresAtstring nullable required

ISO 8601 timestamp (UTC)

sentAtstring nullable required

ISO 8601 timestamp (UTC)

completedAtstring nullable required

ISO 8601 timestamp (UTC)

createdAtstring required

ISO 8601 timestamp (UTC)

fieldCountinteger required
hasCompletedFileboolean required
hasCertificateboolean required

Changes

No recorded changes to this operation across all 1 revision of this API.