Submit a request
curl --request POST \
--url https://{workspace}.dekasign.com/api/v1/approval-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Dekasign-Environment: <x-dekasign-environment>' \
--data '
{
"workflow_id": "<string>",
"workflow_release_id": "<string>",
"external_id": "<string>",
"form_data": {},
"documents": [
{
"document_id": "<string>",
"field_key": "<string>",
"name": "<string>",
"sign_actor_ids": [
"<string>"
]
}
],
"submit": true
}
'import requests
url = "https://{workspace}.dekasign.com/api/v1/approval-requests"
payload = {
"workflow_id": "<string>",
"workflow_release_id": "<string>",
"external_id": "<string>",
"form_data": {},
"documents": [
{
"document_id": "<string>",
"field_key": "<string>",
"name": "<string>",
"sign_actor_ids": ["<string>"]
}
],
"submit": True
}
headers = {
"X-Dekasign-Environment": "<x-dekasign-environment>",
"Idempotency-Key": "<idempotency-key>",
"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>',
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
workflow_id: '<string>',
workflow_release_id: '<string>',
external_id: '<string>',
form_data: {},
documents: [
{
document_id: '<string>',
field_key: '<string>',
name: '<string>',
sign_actor_ids: ['<string>']
}
],
submit: true
})
};
fetch('https://{workspace}.dekasign.com/api/v1/approval-requests', 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/approval-requests",
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([
'workflow_id' => '<string>',
'workflow_release_id' => '<string>',
'external_id' => '<string>',
'form_data' => [
],
'documents' => [
[
'document_id' => '<string>',
'field_key' => '<string>',
'name' => '<string>',
'sign_actor_ids' => [
'<string>'
]
]
],
'submit' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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/approval-requests"
payload := strings.NewReader("{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"form_data\": {},\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"name\": \"<string>\",\n \"sign_actor_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"submit\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Dekasign-Environment", "<x-dekasign-environment>")
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/approval-requests")
.header("X-Dekasign-Environment", "<x-dekasign-environment>")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"form_data\": {},\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"name\": \"<string>\",\n \"sign_actor_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"submit\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.dekasign.com/api/v1/approval-requests")
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["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"form_data\": {},\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"name\": \"<string>\",\n \"sign_actor_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"submit\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"request_number": "<string>",
"external_id": "<string>",
"workflow_id": "<string>",
"workflow_release_id": "<string>",
"category_id": "<string>",
"request_template_id": "<string>",
"form_version": 123,
"published_version": 123,
"approval_status": "<string>",
"version": 123,
"request_revision": 123,
"environment": "sandbox",
"document_approval_mode": "digital_only"
}approval-requests
Submit a request
Required scope: requests:create. Sandbox only; app allowlists and requester authority also apply.
Submit a request
curl --request POST \
--url https://{workspace}.dekasign.com/api/v1/approval-requests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'Idempotency-Key: <idempotency-key>' \
--header 'X-Dekasign-Environment: <x-dekasign-environment>' \
--data '
{
"workflow_id": "<string>",
"workflow_release_id": "<string>",
"external_id": "<string>",
"form_data": {},
"documents": [
{
"document_id": "<string>",
"field_key": "<string>",
"name": "<string>",
"sign_actor_ids": [
"<string>"
]
}
],
"submit": true
}
'import requests
url = "https://{workspace}.dekasign.com/api/v1/approval-requests"
payload = {
"workflow_id": "<string>",
"workflow_release_id": "<string>",
"external_id": "<string>",
"form_data": {},
"documents": [
{
"document_id": "<string>",
"field_key": "<string>",
"name": "<string>",
"sign_actor_ids": ["<string>"]
}
],
"submit": True
}
headers = {
"X-Dekasign-Environment": "<x-dekasign-environment>",
"Idempotency-Key": "<idempotency-key>",
"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>',
'Idempotency-Key': '<idempotency-key>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
workflow_id: '<string>',
workflow_release_id: '<string>',
external_id: '<string>',
form_data: {},
documents: [
{
document_id: '<string>',
field_key: '<string>',
name: '<string>',
sign_actor_ids: ['<string>']
}
],
submit: true
})
};
fetch('https://{workspace}.dekasign.com/api/v1/approval-requests', 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/approval-requests",
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([
'workflow_id' => '<string>',
'workflow_release_id' => '<string>',
'external_id' => '<string>',
'form_data' => [
],
'documents' => [
[
'document_id' => '<string>',
'field_key' => '<string>',
'name' => '<string>',
'sign_actor_ids' => [
'<string>'
]
]
],
'submit' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"Idempotency-Key: <idempotency-key>",
"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/approval-requests"
payload := strings.NewReader("{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"form_data\": {},\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"name\": \"<string>\",\n \"sign_actor_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"submit\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Dekasign-Environment", "<x-dekasign-environment>")
req.Header.Add("Idempotency-Key", "<idempotency-key>")
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/approval-requests")
.header("X-Dekasign-Environment", "<x-dekasign-environment>")
.header("Idempotency-Key", "<idempotency-key>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"form_data\": {},\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"name\": \"<string>\",\n \"sign_actor_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"submit\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{workspace}.dekasign.com/api/v1/approval-requests")
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["Idempotency-Key"] = '<idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workflow_id\": \"<string>\",\n \"workflow_release_id\": \"<string>\",\n \"external_id\": \"<string>\",\n \"form_data\": {},\n \"documents\": [\n {\n \"document_id\": \"<string>\",\n \"field_key\": \"<string>\",\n \"name\": \"<string>\",\n \"sign_actor_ids\": [\n \"<string>\"\n ]\n }\n ],\n \"submit\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"request_number": "<string>",
"external_id": "<string>",
"workflow_id": "<string>",
"workflow_release_id": "<string>",
"category_id": "<string>",
"request_template_id": "<string>",
"form_version": 123,
"published_version": 123,
"approval_status": "<string>",
"version": 123,
"request_revision": 123,
"environment": "sandbox",
"document_approval_mode": "digital_only"
}Authorizations
Sandbox dks_test_ key, server-side only.
Headers
Available options:
sandbox Required string length:
8 - 160Pattern:
^[!-~]+$Body
application/json
Response
Operation result. Read fields vary by endpoint and deployment; see narrative guide.
Available options:
sandbox Available options:
digital_only 