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 provided by a contract creator.

always

"Janie Doe"

accessKind

"email" or "url"

The way a signer may access to a signing page.

always

"email"

otpMethod

“email” or “sms” or “none”

The way a signer may obtain one time password required for signing the contract.

always

“sms”

email

email address

Email address of a signer provided by a contract creator. Required when "accessKind" is "email". Optional otherwise.

conditional

"janie.doe@hotmail.com"

phone

E.164

International mobile phone number of a signer provided by a contract creator.

optional

"+33639987654"

accessUrl

URL

Personal URL (with a secret) to the page on which the signer may sign/reject this contract. Present only when a web API key owner is the same as the contractor creator and "accessKind" is set to "url".

conditional

"https://contract-signatures.com/sign/6a39cfb4-0cf8-4adf-a0fd-8a20052562eb/NDA?s=YouXiRodTgCZKHgJ5H3DkfkL6akHcDH3wnHEH9ZHR46C&no-otp&mode=sign&active=Person%20A "

decision

"signed" or "rejected"

Is present only when a signer already signed/rejected this contract.

conditional

"signed"

decisionTimestamp

ISO 8601

Is present only when a signer already signed/rejected this contract.

conditional

"2022-09-16T13:36:34.971644Z"

decisionIp

IP address

IPv4 or IPv6 address from which signing/rejecting request has come.

conditional

"198.51.100.123"

...