Update Signature Request - Lumin Developer Docs

Authorizations

X-API-Key

string

header

required

Provide your API key in the X-API-Key header, e.g., X-API-Key: YOUR_API_KEY.

Path Parameters

signature_request_id

string

required

ID of the signature request.

Body

application/json

expires_at

integer<unix-epoch>

required

The expiration time of the signature request, expressed as a Unix epoch timestamp in milliseconds. This value must represent a future point in time.

Response

Returns the updated signature request.

signature_request

object

Signature request details with the updated data.

Hide child attributes

signature_request.signature_request_id

string

required

The unique identifier for the signature request.

signature_request.title

string

required

The title of the signature request.

signature_request.created_at

string

required

The time the signature request was created.

signature_request.expires_at

string

required

The time the signature request will expire.

signature_request.details_url

string

required

The url to view the signature request in the browser.

signature_request.status

enum<string>

required

The status of the signature request.

Available options:

NEED_TO_SIGN,

WAITING_FOR_OTHERS,

APPROVED,

REJECTED,

WAITING_FOR_PROCESSING,

FAILED,

CANCELLED

signature_request.signing_type

enum<string>

required

Recipient signing flow.

Available options:

SAME_TIME,

ORDER

signature_request.signers

object[]

required

The signers of the signature request.

Hide child attributes

signature_request.signers.email_address

string

Email address of the signer.

signature_request.signers.name

string

Name of the signer.

signature_request.signers.group

number

The signing order of signer for the signature request with signing_type is ORDER. Required if signing_type is ORDER.

Only signers in 1st Signers group will receive email/notification, signers in subsequent groups will receive email/notification when all signers in previous group has signed.

Group starts incrementing at 1.

The default value for group always is 1 if signing_type is SAME_TIME.

signature_request.signers.is_approved

boolean

Whether the signer has approved the signature request.

signature_request.signers.status

enum<string>

The status of the Signer.

Available options:

NEED_TO_SIGN,

APPROVED,

WAITING_FOR_OTHERS,

REJECTED,

FAILED,

WAITING_FOR_PROCESSING

signature_request.updated_at

string

The time the signature request was last updated.

signature_request.reason

string

The reason for the status FAILED or REJECTED of the signature request.