Skip to main content
Prepare frozen signing preview

Authorizations

Authorization
string
header
required

Sandbox dks_test_ key, server-side only.

Headers

X-Dekasign-Environment
enum<string>
required
Available options:
sandbox

Body

application/json
template_id
string
required
expires_in_days
integer
required
Required range: 1 <= x <= 365
signers
object[]
required
Required array length: 1 - 20 elements
sender_values
object

Response

Operation result. Read fields vary by endpoint and deployment; see narrative guide.

preview_token
string

Secret frozen receipt; valid for 10 minutes. Do not log.

template_id
string
template_name
string
template_version
integer
expires_at
string<date-time>
preview_valid_until
string<date-time>
signers
object[]
fields
object[]
pdf_url
string
pdf_url_is_source
enum<boolean>
Available options:
true
prepared_pdf
object
notice
string