SigPackageRequest · Sig API

Fields

title optional Type: string
Defaults to the first document's name, or for a draft with no signers, its heading.
message optional Type: string
Shown to every signer in the email and on the page.
reference optional Type: string
Your own id for the package.
signers optional Type: SigSignerRequest[]
Everyone on the package. Leave it out of a draft (send false) and we read the documents and add the people they name, for you to fill in before sending.
require_location optional Type: boolean
Each signer shares their device's location to sign. Without this, the rough area of their IP address is recorded.
require_camera optional Type: boolean
Take a short video of each signer as they sign, check it's a live person and keep a picture of their face beside their signature. Someone who can't use a camera signs with a code emailed to them instead.
file_to_folio optional Type: boolean
File the signed package in Folio; defaults to your Sig settings.
check_with_nib optional Type: boolean
Check each signature with Nib; defaults to your Sig settings.
folio_folder optional Type: string
The Folio folder to file it in, when your settings let senders choose; defaults to your Sig settings.
folio_class optional Type: string
The Folio retention class to file it under, when your settings let senders choose; defaults to your Sig settings.
expires_in_days optional Type: integer
return_url optional Type: string
Where signers go once they've signed or declined, with package_id, signer_id and outcome added. It must start with https:// and be on one of your verified domains or an origin in PUT /sig/settings/return. Defaults to your settings' default_url.
send optional Type: boolean
false keeps it as a draft.
sender optional Type: string
The email address of the person in your organisation it comes from. The signers' emails name them, and their replies go to them. Defaults to whoever made the API key.
fields optional Type: SigFieldRequest[]
Where each signer signs, initials and dates, if you'd rather say than have us find the places. Name the document and signer by their place in this request, from 0.