Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

field name

format /
presence

description /
value example

fullName

printable Unicode string

Full name of a signer.

required

“Richard Roe”

accessKind

"email" or "url"

How the signer will access the sign page ?

required

"email"

email

email

Email address on which the signer will receive an URL to the signing page. An OTP will also be sent here if "phone" is not set. Required for "accessKind" set to "email" and optional for "accessKind" set to "url".

conditional

"richard.roe@company.com"

phone

E.164

Mobile phone number in the international format on which OTP will be sent.

Note

SMS Shipper Config must be filled with valid credential for this to work.

optional

"+49 172-9973185"

appendSignatureMacro

boolean

Should signature macro for this signer be appended at the end of the contract ? Defaults to false.

optional

true

receivesCompletedContract

boolean

Should signer receive completed contract on her/his email ? Defaults to true.

optional

false

Watcher Object

field name

format /
presence

description /
value example

name

printable Unicode string

Watcher's name.

required

“Richard Roe”

email

email

An email address on which notifications will come.

required

"richard.roe@company.com"

notificationKinds

"created"
"opened"
"signed"
"rejected"
"completed"
”completed-contract”
"signed|rejected|completed"
or any other combination

Defines notification kinds to be send. Kinds may be combined with a vertical bar character |.

required

"created|signed|rejected|completed-contract"

Archive Contract Interface

...