Skip to main content
GET
Read a signing link

Path Parameters

token
string
required

The hosted token from a document link.

Pattern: ^rql_[0-9a-f]{48}$

Response

The context.

What the hosted signing page renders, read through the link's own token: the ask, your hosted-page branding, and the embedded signing session. Names only, no identifiers - the holder is your customer rather than you.

object
enum<string>
required
Available options:
signing_context
status
enum<string>
required
Available options:
open,
completed,
canceled
livemode
boolean

Whether the signature behind this link is live. A test-mode (sandbox) signature has no real document to embed, so embed_url is absent and the hosted page shows a test completion control instead of a signing frame. A live session carries an embed_url and completes inside it.

partner_name
string
company_name
string
signer_name
string
redirect_url
string

The after-completion destination minted with the session. The page offers it once the flow completes.

message
string

A note to the signer, shown above the document on the hosted page - the operator's message when opening the signature. Absent when none was set.

document_name
string
cancel_reason
string

Why a canceled document was voided (a signer's decline reason), to show on the canceled screen. Present only when the status is canceled.

page
object

The partner's hosted-page configuration - brand and legal footer.

embed_url
string

The embedded signing session the page renders, minted fresh for this page load. Present only while the ask is open.

embed_origin
string

The one origin allowed to frame this page, when the session was minted for embedding. The hosted page treats this as the authority and refuses to run framed anywhere else. Absent on ordinary sessions.

others_pending
boolean

True when this signer has completed their part but the document is not fully executed yet - other signers still have to sign. The page can then say the signature is recorded rather than that the whole document is done. It never names or counts the other signers.

waiting_for_others
boolean

True when the document signs in order and it is not this signer's turn yet - someone earlier in the order has still to sign. There is no embed to render, so the page shows a wait state until the earlier signer completes. It never names or counts the other signers.