Device Signature

A Device Signature represents a signature and a device that are associated together.

Properties

Property	Type	Description	Example
id	Number(integer)	Read-only unique identifier.	1234567890
key	String	The unique key generated for a specific device signature request. This is the value you will use to cancel or check on the status of a particular request.	"1234567890"
status	String	"requested", "complete", "cancelled", "timedout"	"requested"
response_code	String	The response code from the POS Device. All responses that are OK will have a response code of "000000".	"000000"
agreement_title*	String	The title displayed above the agreement. Intended to briefly identify the document or agreement being presented to the signer.	"Service Agreement"
agreement_description*	String	The 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_acknowledgement	Boolean	Specify 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
timeout	Number(integer)	The number of seconds without any touch interactions by the signer after which the Signature Request will time out on the Device.	120
acknowledged	Boolean	If explicit acknowledgement was requested, this indicates whether the signer explicitly acknowledged or not. Otherwise, defaults to null.	null
signature	String	Base64-encoded PNG image containing the captured signature.	"ABC123"
device	Object(Device object)	The device that the request was sent to.	See Device Example

Requirements

*Required for all Device Signature Requests.

Example

JSON

{
  "id": 123,
  "key": "1234567890",
  "status": "complete",
  "response_code": "000000",
  "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,
  "acknowledged": null,
  "signature": "ABC123",
  "device": {
    "key": "1234567890",
    "name": "Test Terminal",
    "sn": "1234567890"
  }
}