Skip to main content

Get Signature Request

Get Signature Request by id.

Path Parameters
signature_request_id string REQUIRED

ID of the Signature Request to get

Responses
200

Expected response to a valid request

Schema OPTIONAL
signature_request object
signature_request_id string

The unique identifier for the Signature Request.

title string

The title of the Signature Request.

created_at string

The time the Signature Request was created.

updated_at string OPTIONAL

The time the Signature Request was last updated.

expires_at string

The time the Signature Request will expire.

details_url string

The url to view the Signature Request in the browser.

status string

Possible values: [NEED_TO_SIGN, WAITING_FOR_OTHERS, APPROVED, REJECTED, WAITING_FOR_PROCESSING, FAILED, CANCELLED]

The status of the Signature Request.

reason string OPTIONAL

The reason for the status FAILED or REJECTED of the Signature Request.

signing_type string

Possible values: [SAME_TIME, ORDER]

The type of signing for the Signature Request.

signers object[]

The Signers of the Signature Request.

email_address string
name string
group number OPTIONAL

The signing order of signer for the Signature Request with signing_type is ORDER.

is_approved boolean

Whether the Signer has approved the Signature Request.

status string

Possible values: [NEED_TO_SIGN, APPROVED, REJECTED, WAITING_FOR_OTHERS]

The status of the Signer.

4xx

Unexpected error

Schema OPTIONAL
error_code string
error_message string