Skip to content
Quarters Developers
esc
  • Type an endpoint, an object or a word from a guide.

Object

SignerInput

One party, as you report it. Signers are matched by role and never removed, so you may send only the party that changed.

Fields

FieldTypeDescription
role requiredstringlessee, lessor, guarantor, witness or your own. Letters, digits, _ and -; matched case-insensitively.
name requiredstring
email requiredemail
status requiredenum "pending""completed""declined"
signingUrl url | nullWhere this party signs. Staff copy it from the booking. max 2000 charshttps only
viewedAt timestamp | null ISO 8601
completedAt timestamp | null ISO 8601
declinedAt timestamp | null ISO 8601
declineReason string | null max 2000 chars

Used by

Example

{
  "role": "lessee",
  "name": "Sofia Rossi",
  "email": "sofia@example.com",
  "status": "pending",
  "signingUrl": "https://docuseal.com/s/…"
}