Skip to main content
Submit a request

Authorizations

Authorization
string
header
required

Sandbox dks_test_ key, server-side only.

Headers

X-Dekasign-Environment
enum<string>
required
Available options:
sandbox
Idempotency-Key
string
required
Required string length: 8 - 160
Pattern: ^[!-~]+$

Body

application/json
workflow_id
string
required
Required string length: 1 - 100
workflow_release_id
string
required
Required string length: 1 - 160
external_id
string
required
Pattern: ^[A-Za-z0-9_.:-]{3,120}$
form_data
object
required
documents
object[]
Maximum array length: 20
submit
boolean
default:true

Response

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

id
string
request_number
string
external_id
string
workflow_id
string
workflow_release_id
string
category_id
string
request_template_id
string
form_version
integer
published_version
integer
approval_status
string
version
integer
request_revision
integer
environment
enum<string>
Available options:
sandbox
document_approval_mode
enum<string>
Available options:
digital_only