Send a Device Signature request

post

https://{environment}.{server}.com/v3/device/{devicekey}/signature

Sends a signature request to the device associated to the provided devicekey. The signature will be performed on the Device.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

devicekey

string

required

The Serial Number used to search for the associated Device.

Body Params

Represents a Signature Request sent to a Device.

agreement_title

string

required

The title displayed above the agreement. Intended to briefly identify the document or agreement being presented to the signer.

agreement_description

string

required

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.

require_end_user_acknowledgement

boolean

Defaults to false

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.

timeout

number

Defaults to 30

The number of seconds without any touch interactions by the signer after which the Signature Request will time out on the Device.

Responses

200PaidYET API Response containing the payload and any messages. The payload's items array contains ONE Device Signature.

400Authentication Token error

401Authentication required