Skip to main content
POST
signature.template.get

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

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
ref
string
required

The ref returned by signature.template.create or a row of signature.templates.list.

Pattern: ^(ref_[0-9A-HJKMNP-TV-Z]{26}|rh_[A-Za-z0-9_-]{24,1024})$
includeFields
boolean
default:true

Include field labels, roles and positions.

Response

The result

title
string
required

Template title.

roles
object[]
required

Signer roles.

state
enum<string>
required

Readiness only when documented; existence alone is unknown.

Available options:
accepted,
ready,
unknown
message
string

Default message for signers.

fields
object[]

Field labels, kinds and positions; no stored values.

editable
boolean

Whether this sender can edit the template.