Get a generation's signing package
const url = 'https://necodoc.example.com/api/v1/generations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/signing-package?embedPdf=true&placement=position';const options = {method: 'GET', headers: {'x-api-key': '<x-api-key>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}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.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”Query Parameters
Section titled “Query Parameters”Provider JSON to include (default docusign). Repeat it or comma-separate for several.
Put the PDF in provider JSON as base64 (default true).
DocuSign tabs by page coordinates (default) or anchor string.
Responses
Section titled “Responses”The signing package.
The PDF’s signers and sign boxes, for an e-sign provider.
object
A signer, with name and email rendered from the data.
object
object
PDF points in the page’s user space, origin bottom-left (what pdf-lib uses).
object
Points (pixels at 72 dpi) from the top-left of the page as displayed (DocuSign, Dropbox Sign, Adobe Sign).
object
Fractions (0..1) of the displayed page, origin top-left.
object
Invisible text at the box’s top-left corner, for anchor-based tab placement. Null when the PDF has none.
object
Signed; works without a key for 1 hour.
/api/v1/generations/{id}/pdf, with a key.
Provider JSON, as asked for in formats.
object
DocuSign eSignature v2.1 envelope definition: POST it to /restapi/v2.1/accounts/{accountId}/envelopes.
object
Dropbox Sign signers and form_fields_per_document for /signature_request/send.
object
Adobe Acrobat Sign participantSetsInfo (POST /agreements) and formFields (PUT /agreements/{id}/formFields).
object
Example
{ "boxes": [ { "kind": "signature" } ]}Missing, unknown, revoked or expired key, or the key’s account is disabled.
object
object
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.
object
object
Example generated
{ "error": "example", "code": "example", "fieldErrors": { "additionalProperty": [ "example" ] }, "generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Not found, or not yours.
object
object
Example generated
{ "error": "example", "code": "example", "fieldErrors": { "additionalProperty": [ "example" ] }, "generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Invalid request or data; fieldErrors lists each.
object
object
Example generated
{ "error": "example", "code": "example", "fieldErrors": { "additionalProperty": [ "example" ] }, "generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Rate limit exceeded.
object
object
Example generated
{ "error": "example", "code": "example", "fieldErrors": { "additionalProperty": [ "example" ] }, "generationId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Headers
Section titled “Headers”Seconds until the key may call again.