These docs are for v1.5.1. Click to read the latest docs for v1.15.1.

Update a signature request.

Use this operation to update a signature request.

Only the properties name, suspended, deadline, maxSignatures and authorizedSignees can be modified.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Identifier of signature request to update.

Body Params

SignatureRequest object to update.

string
required

Name of the signature request (doesn't need to be unique).

boolean

true if the signature request is suspended, or false (or unset) if not.

When suspended, no more signature can be registered before the request is resumed.

string
required

SHA256 hash (ie. the fingerprint) of the original data to sign.

anchors
array of objects

List of signature anchors created for this signature request.

This property is only available to the owner of the signature request.

anchors
int64

Deadline of the signature request (in milliseconds since Unix epoch).

When not set, null or 0, no deadline is applied.

If set, signatures registered after the deadline are refused.

int32

Maximum number of signatures to accept for this signature request.

When not set, null or 0, no maximum is applied.

If set, signatures coming from signees not in this list are refused.

This property and the authorizedSignees property are mutually exclusive.

This property is only available to the owner of the signature request.

authorizedSignees
array of objects

List of public keys of all signees authorized to register their signature for this signature request (no duplicate is authorized).

Currently only Bitcoin addresses are supported.

When not set or null, anybody can sign the signature request.

If set, signatures from public keys not in this list are rejected.

This property and the maxSignatures property are mutually exclusive.

This property is only available to the owner of the signature request.

authorizedSignees
Responses

400

Invalid signature request object. More details are returned in the response body as a JSON object.

404

No signature request matching the given identifier.

Language
Credentials
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json