Prepare frozen signing preview
curl --request POST \
--url https://{workspace}.dekasign.com/api/v1/signature-packages/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Dekasign-Environment: <x-dekasign-environment>' \
--data '
{
"template_id": "<string>",
"expires_in_days": 183,
"signers": [
{
"slot_id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}
],
"sender_values": {}
}
'import requests
url = "https://{workspace}.dekasign.com/api/v1/signature-packages/preview"
payload = {
"template_id": "<string>",
"expires_in_days": 183,
"signers": [
{
"slot_id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}
],
"sender_values": {}
}
headers = {
"X-Dekasign-Environment": "<x-dekasign-environment>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Dekasign-Environment': '<x-dekasign-environment>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
template_id: '<string>',
expires_in_days: 183,
signers: [
{
slot_id: '<string>',
name: '<string>',
email: 'jsmith@example.com',
phone: '<string>'
}
],
sender_values: {}
})
};
fetch('https://{workspace}.dekasign.com/api/v1/signature-packages/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{workspace}.dekasign.com/api/v1/signature-packages/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'template_id' => '<string>',
'expires_in_days' => 183,
'signers' => [
[
'slot_id' => '<string>',
'name' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>'
]
],
'sender_values' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Dekasign-Environment: <x-dekasign-environment>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{workspace}.dekasign.com/api/v1/signature-packages/preview"
payload := strings.NewReader("{\n \"template_id\": \"<string>\",\n \"expires_in_days\": 183,\n \"signers\": [\n {\n \"slot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n ],\n \"sender_values\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Dekasign-Environment", "<x-dekasign-environment>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{workspace}.dekasign.com/api/v1/signature-packages/preview")
.header("X-Dekasign-Environment", "<x-dekasign-environment>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"template_id\": \"<string>\",\n \"expires_in_days\": 183,\n \"signers\": [\n {\n \"slot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n ],\n \"sender_values\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.dekasign.com/api/v1/signature-packages/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Dekasign-Environment"] = '<x-dekasign-environment>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"template_id\": \"<string>\",\n \"expires_in_days\": 183,\n \"signers\": [\n {\n \"slot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n ],\n \"sender_values\": {}\n}"
response = http.request(request)
puts response.read_body{
"preview_token": "<string>",
"template_id": "<string>",
"template_name": "<string>",
"template_version": 123,
"expires_at": "2023-11-07T05:31:56Z",
"preview_valid_until": "2023-11-07T05:31:56Z",
"signers": [
{}
],
"fields": [
{}
],
"pdf_url": "<string>",
"pdf_url_is_source": true,
"prepared_pdf": {
"url": "<string>",
"method": "POST",
"body": {
"template_id": "<string>",
"preview_token": "<string>"
}
},
"notice": "<string>"
}signature-packages
Prepare frozen signing preview
Required scope: packages:create. Sandbox only; app allowlists and requester authority also apply.
Prepare frozen signing preview
curl --request POST \
--url https://{workspace}.dekasign.com/api/v1/signature-packages/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Dekasign-Environment: <x-dekasign-environment>' \
--data '
{
"template_id": "<string>",
"expires_in_days": 183,
"signers": [
{
"slot_id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}
],
"sender_values": {}
}
'import requests
url = "https://{workspace}.dekasign.com/api/v1/signature-packages/preview"
payload = {
"template_id": "<string>",
"expires_in_days": 183,
"signers": [
{
"slot_id": "<string>",
"name": "<string>",
"email": "jsmith@example.com",
"phone": "<string>"
}
],
"sender_values": {}
}
headers = {
"X-Dekasign-Environment": "<x-dekasign-environment>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'X-Dekasign-Environment': '<x-dekasign-environment>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
template_id: '<string>',
expires_in_days: 183,
signers: [
{
slot_id: '<string>',
name: '<string>',
email: 'jsmith@example.com',
phone: '<string>'
}
],
sender_values: {}
})
};
fetch('https://{workspace}.dekasign.com/api/v1/signature-packages/preview', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{workspace}.dekasign.com/api/v1/signature-packages/preview",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'template_id' => '<string>',
'expires_in_days' => 183,
'signers' => [
[
'slot_id' => '<string>',
'name' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>'
]
],
'sender_values' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"X-Dekasign-Environment: <x-dekasign-environment>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://{workspace}.dekasign.com/api/v1/signature-packages/preview"
payload := strings.NewReader("{\n \"template_id\": \"<string>\",\n \"expires_in_days\": 183,\n \"signers\": [\n {\n \"slot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n ],\n \"sender_values\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Dekasign-Environment", "<x-dekasign-environment>")
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://{workspace}.dekasign.com/api/v1/signature-packages/preview")
.header("X-Dekasign-Environment", "<x-dekasign-environment>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"template_id\": \"<string>\",\n \"expires_in_days\": 183,\n \"signers\": [\n {\n \"slot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n ],\n \"sender_values\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.dekasign.com/api/v1/signature-packages/preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Dekasign-Environment"] = '<x-dekasign-environment>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"template_id\": \"<string>\",\n \"expires_in_days\": 183,\n \"signers\": [\n {\n \"slot_id\": \"<string>\",\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\"\n }\n ],\n \"sender_values\": {}\n}"
response = http.request(request)
puts response.read_body{
"preview_token": "<string>",
"template_id": "<string>",
"template_name": "<string>",
"template_version": 123,
"expires_at": "2023-11-07T05:31:56Z",
"preview_valid_until": "2023-11-07T05:31:56Z",
"signers": [
{}
],
"fields": [
{}
],
"pdf_url": "<string>",
"pdf_url_is_source": true,
"prepared_pdf": {
"url": "<string>",
"method": "POST",
"body": {
"template_id": "<string>",
"preview_token": "<string>"
}
},
"notice": "<string>"
}Authorizations
Sandbox dks_test_ key, server-side only.
Headers
Available options:
sandbox Body
application/json
Response
Operation result. Read fields vary by endpoint and deployment; see narrative guide.
Secret frozen receipt; valid for 10 minutes. Do not log.
Available options:
true Show child attributes
Show child attributes
