Skip to main content
GET
Get a signing request

Authorizations

x-api-key
string
header
required

Path Parameters

id
string
required
Example:

"vrf_1A2b3C4d5E6f7G8h9I0jKl"

Response

id
string
required

Signing request id (equals the pending verification id).

Pattern: ^vrf_[0-9A-Za-z]{22}$
transactionId
string
required

Payout this request authorizes. Each id has the form txn_ followed by 22 alphanumeric characters.

Pattern: ^txn_[0-9A-Za-z]{22}$
customerId
string
required

Customer whose signers must approve. Each id has the form cus_ followed by 22 alphanumeric characters.

Pattern: ^cus_[0-9A-Za-z]{22}$
status
enum<string>
required

awaiting_signature: still collecting stamps, so submit yours. quorum_met: enough stamps arrived and the payout proceeds on its own. declined: a signer rejected it and the payout will not send. expired: the signing window closed before quorum. Only awaiting_signature accepts a new stamp; the other three are final for this request.

Available options:
awaiting_signature,
quorum_met,
declined,
expired
requiredApprovals
integer
required

How many signer stamps this payout needs. Fixed when the request was created, so it does not move while you collect.

Required range: -9007199254740991 <= x <= 9007199254740991
approvedCount
integer
required

How many stamps have been accepted so far. Signing proceeds as soon as it reaches requiredApprovals, at which point status becomes quorum_met.

Required range: -9007199254740991 <= x <= 9007199254740991
expiresAt
string<date-time> | null
required

ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"

createdAt
string<date-time>
required

ISO 8601 timestamp

Example:

"2026-01-15T09:30:00.000Z"

approvalMaterial
object
required