Sign in

v1

latestOpenAPI 3.0.02026-07-24176123205.3 KB
Documents - Entry Pads

Create an entry pad

Create an entry pad in the document, which must be in either DRAFT or LIVE_EDITING statuses.

post/e-signature-packages/{eSignaturePackageId}/documents/{documentId}/entry-pads

Request body

idstring
signerIdstring required

Id of the signer

type'signature' | 'initials' | 'stamp' | 'date' | 'text' | 'checkbox' | 'name' | 'notary_public_profile_info' | 'email' required
leftnumber required

Offset from the left. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

topnumber required

Offset from the top. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

heightnumber required

Height of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

widthnumber required

Width of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

pageIndexnumber required

Page index whereby the entry pad is contained in the document.

isOptionalboolean

Set to true if the entry pad is optional.

{"stackTrail":"components:schemas:AnyValue","oasType":"schema","type":"unknown"}

Response

Returns the object if it was successfully created.

idstring
signerIdstring required

Id of the signer

type'signature' | 'initials' | 'stamp' | 'date' | 'text' | 'checkbox' | 'name' | 'notary_public_profile_info' | 'email' required
leftnumber required

Offset from the left. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

topnumber required

Offset from the top. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

heightnumber required

Height of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

widthnumber required

Width of the entry pad. Must be between 0 and 100. Units of measure is the percentage relative to the width of the containing page.

pageIndexnumber required

Page index whereby the entry pad is contained in the document.

isOptionalboolean

Set to true if the entry pad is optional.

{"stackTrail":"components:schemas:AnyValue","oasType":"schema","type":"unknown"}