Device Signature Request

Represents the set of required and optional fields when sending a Device Signature Request to a Device.

Properties

PropertyTypeDescriptionExample
agreement_title*StringThe title displayed above the agreement. Intended to briefly identify the document or agreement being presented to the signer."Service Agreement"
agreement_description*StringThe full agreement text presented to the signer in a scrollable area. This content represents the document or terms being agreed to. If require_end_user_acknowledgement was specified as true, the acknowledgement checkbox is displayed below this text."I have reviewed and agree to the terms presented above. By signing, I confirm my acceptance of this agreement."
require_end_user_acknowledgementBooleanSpecify whether an acknowledgement checkbox should appear below the agreement description for capturing an explicit ackowledgement from the signer. Defaults to false, meaning a checkbox won't appear. If true, the signer must both check the box and sign to proceed with agreement acceptance.false
timeoutNumber(integer)The number of seconds without any touch interactions by the signer after which the Signature Request will time out on the Device.120

Requirements

*Required for all Device Signature Requests.

Example

{
  "agreement_title": "Service Agreement",
  "agreement_description": "I acknowledge that I have reviewed the terms of this agreement and understand the information presented to me. I understand the nature of the agreement, including any responsibilities, conditions, disclosures, or limitations described within it. By providing my signature, I confirm that I have had an opportunity to review the agreement, ask any necessary questions, and voluntarily accept the terms as presented. I understand that my signature may be retained as evidence of my acknowledgement and acceptance of this agreement.",
  "require_end_user_acknowledgement": false,
  "timeout": 120,
}