Skip to content

SigningRequests Object

Relationships

Schema relationships 
graph LR
    SigningRequests -->|"status"| SigningRequestStatuses
    SigningRequests -->|"collections"| Collections
    SigningRequests -->|"groups"| Groups

Properties

cancellation_reasonstring

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

collectionsobject[]

The collections of the signing request.

References: Collections → id
idstring

The unique identifier of the collection.

namestring

The name of the collection.

created_atstring · date-time

The date and time when the signing request was created.

descriptionstring

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

expires_atstring · date-time

The date and time when the signing request expires.

groupsobject[]

The groups of the signing request.

References: Groups → id
idstring

The unique identifier of the group.

typestring

The type of the group.

idstring

The unique identifier of the signing request.

last_activity_atstring · date-time

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

namestring

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

participantsobject[]

The participants of the signing request.

emailsobject[]

The emails of the participant.

1 property
emailstring

The email address of the participant.

idstring

The unique identifier of the participant.

is_signerboolean

Specifies whether the participant is a signer of the document.

namestring

The name of the participant.

routing_ordernumber

The routing order of the participant.

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusobject

The status of the signing request.

References: SigningRequestStatuses → id
idstring
namestring
typestring

The type of the signing request.

updated_atstring · date-time

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

urlsobject[]

The urls of the signing_request

typestring

The type of the url

Possible values:
vieweditpublic_view
urlstring

The url of the signing_request