OPENAPI / COMPONENTS / SCHEMAS

Signature Request Response Signatures

SignatureRequestResponseSignatures

An array of signature objects, 1 for each signer.

object19properties
signature_idstring

Signature identifier.

signer_group_guidstring

Signer Group GUID

signer_email_addressstring

The email address of the signer.

signer_namestring

The name of the signer.

signer_rolestring

The role of the signer.

orderinteger

If signer order is assigned this is the 0-based index for this signer.

status_codestring

The current status of the signature. eg: awaiting_signature, signed, declined.

decline_reasonstring

The reason provided by the signer for declining the request.

signed_atinteger

Time that the document was signed or null.

last_viewed_atinteger

The time that the document was last viewed by this signer or null.

last_reminded_atinteger

The time the last reminder email was sent to the signer or null.

has_pinboolean

Boolean to indicate whether this signature requires a PIN to access.

has_sms_authboolean

Boolean to indicate whether this signature has SMS authentication enabled.

has_sms_deliveryboolean

Boolean to indicate whether this signature has SMS delivery enabled.

sms_phone_numberstring

The SMS phone number used for authentication or signature request delivery.

reassigned_bystring

Email address of original signer who reassigned to this signer.

reassignment_reasonstring

Reason provided by original signer who reassigned to this signer.

reassigned_fromstring

Previous signature identifier.

errorstring

Error message pertaining to this signer, or null.