Skip to content

Get a generation's signing package

GET
/generations/{id}/signing-package
curl --request GET \
--url 'https://necodoc.example.com/api/v1/generations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/signing-package?embedPdf=true&placement=position' \
--header 'x-api-key: <x-api-key>'

Signers, sign box positions and provider JSON (DocuSign, Dropbox Sign, Adobe Acrobat Sign) for handing the PDF to an e-sign service. Empty for documents without signers or sign boxes.

id
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
formats
Any of:
string
Allowed values: docusign dropbox_sign adobe_sign

Provider JSON to include (default docusign). Repeat it or comma-separate for several.

embedPdf
string
Allowed values: true false

Put the PDF in provider JSON as base64 (default true).

placement
string
Allowed values: position anchor

DocuSign tabs by page coordinates (default) or anchor string.

The signing package.

Media typeapplication/json

The PDF’s signers and sign boxes, for an e-sign provider.

object
signers
required
Array<object>

A signer, with name and email rendered from the data.

object
id
required
string
<= 64 characters /^[a-z][a-z0-9_]*$/
role
required
string
>= 1 characters <= 100 characters
routingOrder
required
integer
>= -9007199254740991 <= 9007199254740991
name
required
string
email
required
string
boxes
required
Array<object>
object
id
required
string
signerId
required
string
kind
required
string
Allowed values: signature initials date_signed full_name text
required
required
boolean
page
required
integer
>= 1 <= 9007199254740991
rect
required

PDF points in the page’s user space, origin bottom-left (what pdf-lib uses).

object
x
required
number
y
required
number
width
required
number
height
required
number
topLeft
required

Points (pixels at 72 dpi) from the top-left of the page as displayed (DocuSign, Dropbox Sign, Adobe Sign).

object
x
required
number
y
required
number
width
required
number
height
required
number
normalized
required

Fractions (0..1) of the displayed page, origin top-left.

object
x
required
number
y
required
number
width
required
number
height
required
number
anchorString
required

Invisible text at the box’s top-left corner, for anchor-based tab placement. Null when the PDF has none.

string | null
pages
required
Array<object>
object
width
required
number
height
required
number
anchors
required
boolean
warnings
required
Array<string>
generationId
required
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/
filename
required
string
pageCount
required
integer
>= -9007199254740991 <= 9007199254740991
pdfUrl
required

Signed; works without a key for 1 hour.

string format: uri
pdfPath
required

/api/v1/generations/{id}/pdf, with a key.

string
formats
required

Provider JSON, as asked for in formats.

object
docusign

DocuSign eSignature v2.1 envelope definition: POST it to /restapi/v2.1/accounts/{accountId}/envelopes.

object
key
additional properties
dropbox_sign

Dropbox Sign signers and form_fields_per_document for /signature_request/send.

object
key
additional properties
adobe_sign

Adobe Acrobat Sign participantSetsInfo (POST /agreements) and formFields (PUT /agreements/{id}/formFields).

object
key
additional properties

Example

{
"boxes": [
{
"kind": "signature"
}
]
}

Missing, unknown, revoked or expired key, or the key’s account is disabled.

Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Example generated

{
"error": "example",
"code": "example",
"fieldErrors": {
"additionalProperty": [
"example"
]
},
"generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

The key lacks the scope, role, template or source address this call needs.

Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Example generated

{
"error": "example",
"code": "example",
"fieldErrors": {
"additionalProperty": [
"example"
]
},
"generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Not found, or not yours.

Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Example generated

{
"error": "example",
"code": "example",
"fieldErrors": {
"additionalProperty": [
"example"
]
},
"generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Invalid request or data; fieldErrors lists each.

Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Example generated

{
"error": "example",
"code": "example",
"fieldErrors": {
"additionalProperty": [
"example"
]
},
"generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

Rate limit exceeded.

Media typeapplication/json
object
error
required
string
code
required
string
fieldErrors
object
key
additional properties
Array<string>
generationId
string format: uuid
/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

Example generated

{
"error": "example",
"code": "example",
"fieldErrors": {
"additionalProperty": [
"example"
]
},
"generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}
Retry-After
integer

Seconds until the key may call again.