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 client rather than you.

object
enum<string>
required
Available options:
signing_context
status
enum<string>
required
Available options:
open,
completed,
canceled
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.

document_name
string
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.