Skip to main content
POST
signature.document.upload

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 PDF to upload for signing, in place of a public link.

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

Document title.

Required string length: 1 - 200
password
string

PDF password, forwarded once without retention.

Required string length: 1 - 200

Response

The result

status
string
required

Document accepted for signing.

Allowed value: "ready"
ref
string

Reference to what this call created. Pass it as ref to signature.document.get or signature.request.create.