Skip to main content
PUT
Upload the document set through a hosted link

Path Parameters

token
string
required

The hosted token from a document link.

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

Query Parameters

filename
string

The filename, when the body is raw bytes rather than multipart.

Maximum string length: 256

Body

files
file[]

Response

The context afterwards - resolved when the set completes the ask.

What a hosted page shows, read through the link's own token - names only, no identifiers, since the holder is your client rather than you.

object
enum<string>
required

Entity name.

Available options:
requirement_context
type
enum<string>
required
Available options:
document,
form,
name_change,
information,
signature
status
enum<string>
required
Available options:
open,
resolved,
canceled
partner_name
string

The partner name a hosted page brands itself with, resolved from the link token.

company_name
string
owner_name
string
page
object

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

message
string
form
object

The form the order's current fulfilment step is waiting on.

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.