Skip to main content
POST
signature.request.send-configured

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-Max-Price-Micro
string

Optional. The most this request may be priced at, in micro-USD (a whole number above 0). It replaces the capability's own price ceiling for this request, lower or higher. Sources that could cost more are left out; when none is left the answer is 400 with the lowest limit that would work.

Pattern: ^[1-9]\d{0,14}$

Body

application/json
fileId
string
required

Id of an uploaded file holding a PDF up to 10 MB, in place of a public link.

Pattern: ^file_[0-9A-HJKMNP-TV-Z]{26}$
fileName
string
required

Download filename ending in .pdf.

Pattern: ^[A-Za-z0-9][A-Za-z0-9 _.-]{0,119}\.pdf$
signers
object[]
required

One to twenty distinct labelled signers.

Required array length: 1 - 20 elements
notify
boolean
default:true

Send the signing invitation; false is refused until private links are available.

sequential
boolean
default:false

Sign in the supplied order.

expiryDays
integer
default:10

Invitation lifetime in days.

Required range: 1 <= x <= 90
displayOnPage
enum<string>
default:first

Pages displaying signatures; custom requires rectangles.

Available options:
first,
last,
all,
custom
transport
enum<string>
default:binary

Upload PDF bytes or base64 encoded bytes.

Available options:
binary,
base64
stampRequests
object[]

Explicit stamps; maximum combined value 200000 rupees.

Required array length: 1 - 20 elements

Response

The result

status
string
required

The signing invitation was accepted, not completed.

Allowed value: "accepted"
ref
string

Reference to what this call created. Pass it as ref to signature.request.get, signature.request.audit, signature.request.download, signature.request.stop.