Skip to main content
POST
signature.request.send

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string
required

Required: this capability has an external effect.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
title
string
required

Agreement title.

Required string length: 1 - 100
subject
string
required

Email subject.

Required string length: 1 - 100
documents
object[]
required

At most 10 files, with a combined limit of 10 MB.

Required array length: 1 - 10 elements
signers
object[]
required

Names and email addresses of at most 20 signers.

Required array length: 1 - 20 elements
message
string

Message emailed to the signers.

Required string length: 1 - 5000
fields
object[]

At most 200 explicitly placed signing fields.

Maximum array length: 200
delivery
enum<string>
default:email

Email reaches the signers. Embedded delivery needs a supported signing session.

Available options:
email,
embedded
testMode
boolean
default:false

Requests are real; test sends are not offered here.

Response

Job started; poll GET /v1/jobs/{id}

job_id
string
required
status
enum<string>
required
Available options:
running
held_micro
integer
required

The credit set aside for the job (its estimate), micro-USD; 0 when it takes none. Not a price: what the job is charged reads on GET /v1/jobs/{id} once it is settled.