SigningRequests Object

---

id

string

The unique identifier of the signing request.

name

string

The name of the signing request. This is usually the email subject that goes as part of the signing request.

description

string

Human readable description of the signing request. This is usually the email body that goes as part of the signing request.

type

string

The type of the signing request.

status

object

The status of the signing request.

References: SigningRequestStatuses → id

id

string

name

string

cancellation_reason

string

If the signing request is voided or cancelled, the reason is specified here.

collections

object[]

The collections of the signing request.

References: Collections → id

id

string

The unique identifier of the collection.

name

string

The name of the collection.

groups

object[]

The groups of the signing request.

References: Groups → id

id

string

The unique identifier of the group.

type

string

The type of the group.

participants

object[]

The participants of the signing request.

id

string

The unique identifier of the participant.

name

string

The name of the participant.

emails

object[]

The emails of the participant.

email

string

The email address of the participant.

is_signer

boolean

Specifies whether the participant is a signer of the document.

urls

object[]

The urls of the signing_request

url

string

The url of the signing_request

type

string

The type of the url

All possible enum values:

• view
• edit
• public_view

created_at

string · date-time

The date and time when the signing request was created.

updated_at

string · date-time

The date and time when the signing request was last updated.

last_activity_at

string · date-time

The date and time when the signing request was last updated.

expires_at

string · date-time

The date and time when the signing request expires.

remote_data

object

Raw data returned from the remote API call.