# Nitro APIs - [Access the Nitro APIs](https://developers.gonitro.com/docs/getting-started/basic-setup.md): Access Nitro's REST APIs for PDF automation and eSignature workflows — conversions, extractions, redactions, transformations, and document signing. - [Get API Credentials](https://developers.gonitro.com/docs/authentication/credentials.md): Get your Nitro API client ID and secret. Create an application in the Nitro Developer portal to authenticate API requests via machine-to-machine OAuth. - [Generate Access Tokens](https://developers.gonitro.com/docs/authentication/token-renew.md): Create and renew OAuth access tokens from your client ID and secret to authenticate requests to the Nitro APIs. - [Get Access Token](https://developers.gonitro.com/docs/api-reference/authentication/get-access-token.md): The Get Access Token endpoint exchanges client credentials for an access token using the OAuth 2.0 client credentials flow. - [Optimize PDF Tutorial](https://developers.gonitro.com/docs/build-nitro/optimize-pdf.md): Optimize a PDF with the Nitro PDF Services API. Choose a profile, send a POST request, and download the result synchronously or async. - [Callbacks](https://developers.gonitro.com/docs/build-nitro/pdf-services-callbacks.md): Attach a callback URL to an asynchronous Nitro PDF Services job and receive a single HTTP POST when the job has been created. - [Bounding Box Guide](https://developers.gonitro.com/docs/build-nitro/bounding-box.md): Define field position and size in a PDF using bounding box coordinates with the Nitro Sign API. Specify location, width, and height in PDF points. - [PDF Services Postman Collection](https://developers.gonitro.com/docs/build-nitro/pdf-services-postman-collection.md): Import the Nitro PDF Services Postman collection — test conversion, extraction, transformation, and async job endpoints directly in Postman. - [OCR](https://developers.gonitro.com/docs/api-reference/platform/transformations/ocr.md): Apply OCR to scanned or image-based PDFs with the Nitro API to add a searchable, selectable text layer without changing appearance. - [Optimize](https://developers.gonitro.com/docs/api-reference/platform/transformations/optimize.md): Optimize a PDF with the Nitro API using predefined profiles for web viewing, printing, archiving, or minimum file size. - [Compress](https://developers.gonitro.com/docs/api-reference/platform/transformations/compress.md): Compress a PDF to its smallest size with the Nitro API — one call, no options, maximum file-size reduction for sharing and upload. - [Watermark](https://developers.gonitro.com/docs/api-reference/platform/transformations/watermark.md): Add an image watermark to any PDF page with the Nitro API. Control position, size, opacity, rotation, and placement. - [Redact](https://developers.gonitro.com/docs/api-reference/platform/transformations/redact.md): Permanently remove or hide sensitive content in a PDF with the Nitro API by applying redaction boxes to specific pages. - [Merge](https://developers.gonitro.com/docs/api-reference/platform/transformations/merge.md): Combine multiple PDF files into a single document with the Nitro API, preserving page order across all files. - [Split](https://developers.gonitro.com/docs/api-reference/platform/transformations/split.md): Split a multi-page PDF into multiple files with the Nitro API. Define custom page ranges to control exactly which pages go into each output file. - [Flatten](https://developers.gonitro.com/docs/api-reference/platform/transformations/flatten.md): Flatten a PDF with the Nitro API. Convert form fields, annotations, signatures, and layers into static, non-editable page content. - [Rotate](https://developers.gonitro.com/docs/api-reference/platform/transformations/rotate.md): Rotate one or more pages in a PDF with the Nitro API by specifying page indexes and rotation angles. - [Delete Pages](https://developers.gonitro.com/docs/api-reference/platform/transformations/delete.md): Delete specific pages from a PDF with the Nitro API using a list of zero-based page indices. - [Protect](https://developers.gonitro.com/docs/api-reference/platform/transformations/protect.md): Password-protect a PDF and control user permissions with the Nitro API to secure sensitive documents. - [Unprotect](https://developers.gonitro.com/docs/api-reference/platform/transformations/unprotect.md): Remove passwords and permission restrictions from a protected PDF with the Nitro API. - [Set Properties](https://developers.gonitro.com/docs/api-reference/platform/transformations/properties.md): Update standard PDF metadata fields such as title, author, and subject with the Nitro API. - [Text](https://developers.gonitro.com/docs/api-reference/platform/extractions/text.md): Extract text content from a PDF with the Nitro API, with options for specific pages and natural reading order. - [Forms](https://developers.gonitro.com/docs/api-reference/platform/extractions/forms.md): Automatically extract all form field values from a PDF with the Nitro API — no extra parameters required. - [Extract Fillable Form Data](https://developers.gonitro.com/docs/api-reference/platform/extractions/extract-fillable-form-data.md): Extract the data of a PDF's existing AcroForm — field names, current values, field types and positions — as JSON, XFDF, FDF, or CSV - [Smart Detect Form Fields](https://developers.gonitro.com/docs/api-reference/platform/extractions/smart-detect-form-fields.md): Detect where fillable form fields should be placed in a PDF document and return their bounding boxes as JSON - [Tables](https://developers.gonitro.com/docs/api-reference/platform/extractions/tables.md): Automatically extract tabular data from PDFs with the Nitro API, returning structured rows and columns for each table. - [PII Bounding Boxes](https://developers.gonitro.com/docs/api-reference/platform/extractions/pii.md): Detect and locate Personally Identifiable Information (PII) in PDFs with the Nitro API. Supports English and Spanish. - [Text Bounding Boxes](https://developers.gonitro.com/docs/api-reference/platform/extractions/text-box.md): Locate specific strings in a PDF with the Nitro API and return the bounding box coordinates for each match. - [Properties](https://developers.gonitro.com/docs/api-reference/platform/extractions/properties.md): Extract PDF metadata fields such as title, author, and creation date from a document with the Nitro API. - [Invoices](https://developers.gonitro.com/docs/api-reference/platform/extractions/extract-invoices.md): Extract structured invoice and receipt data from PDFs with the Nitro API. Scanned documents are processed automatically via built-in OCR. - [Fill Forms](https://developers.gonitro.com/docs/api-reference/platform/generations/fill-forms.md): Fill PDF form fields with the Nitro API — supply values inline or via a CSV, JSON, XFDF, or FDF data file and get back a completed PDF. - [Create Fillable Forms](https://developers.gonitro.com/docs/api-reference/platform/generations/create-fillable-forms.md): Generate a PDF with detected form fields written as a real AcroForm - [PDF to MS Office](https://developers.gonitro.com/docs/api-reference/platform/conversions/pdftoms.md): Convert a PDF into Microsoft Office formats such as Word, Excel, and PowerPoint with the Nitro API. - [MS Office to PDF](https://developers.gonitro.com/docs/api-reference/platform/conversions/mstopdf.md): Convert Microsoft Office files such as Word, Excel, and PowerPoint into PDF with the Nitro API. - [PDF to Image](https://developers.gonitro.com/docs/api-reference/platform/conversions/pdftoimg.md): Convert PDF pages into image formats such as JPG and PNG with the Nitro API. - [Image to PDF](https://developers.gonitro.com/docs/api-reference/platform/conversions/imgtopdf.md): Convert common image formats such as JPG and PNG into PDF with the Nitro API. - [Miscellaneous to PDF](https://developers.gonitro.com/docs/api-reference/platform/conversions/misctopdf.md): Convert HTML, XML, CSV, RTF, and EPS files to PDF with the Nitro API. Supports both synchronous and async processing. - [PDF to PDF/A](https://developers.gonitro.com/docs/api-reference/platform/conversions/pdfa.md): Convert a standard PDF to the ISO-standard PDF/A archival format with the Nitro API for long-term preservation. - [Job Status](https://developers.gonitro.com/docs/api-reference/platform/jobs/status.md): Retrieve the current status of an asynchronous Nitro API conversion, transformation, or extraction job. - [Job Results](https://developers.gonitro.com/docs/api-reference/platform/jobs/result.md): Retrieve the result of a completed asynchronous Nitro API conversion, transformation, or extraction job. - [Request Presigned File URLs](https://developers.gonitro.com/docs/api-reference/platform/presigned-urls/request.md): Generate presigned upload and download URL pairs to transfer large files directly to storage, bypassing the standard multipart request size limit. - [Make your first 'Get Envelopes' API call](https://developers.gonitro.com/docs/getting-started/first-sign-api-call.md): Fetch envelopes via the Nitro Sign API. Walk through your first GET request using your access token and explore the paginated response. - [Create Envelope Tutorial](https://developers.gonitro.com/docs/build-nitro/create-envelope.md): Create an eSignature envelope with the Nitro Sign API. Upload documents, add participants and fields, and send for signing. - [Webhooks](https://developers.gonitro.com/docs/build-nitro/sign-webhooks.md): Register a Nitro Sign webhook to receive real-time envelope, document and signature events over HTTP POST, and verify their signatures. - [Sign Postman Collection](https://developers.gonitro.com/docs/build-nitro/sign-postman-collection.md): Import the Nitro Sign API Postman collection — test envelope, document, field, and participant endpoints directly in Postman. - [List Envelopes](https://developers.gonitro.com/docs/api-reference/sign/list-envelopes.md): The **List Envelopes** endpoint returns all envelopes associated with an application in an account. - [Get Envelope by ID](https://developers.gonitro.com/docs/api-reference/sign/get-envelope-by-id.md): The **Get Envelope by ID** endpoint retrieves the details of a single envelope using its UUIDv4 identifier. - [Delete Envelope by ID](https://developers.gonitro.com/docs/api-reference/sign/delete-envelope-by-id.md): The **Delete Envelope by ID** endpoint permanently deletes the envelope. - [Update Envelope](https://developers.gonitro.com/docs/api-reference/sign/update-envelope.md): The **Update Envelope** endpoint modifies an envelope’s name, notification settings, or signing mode. All parameters are optional, so you can update any combination of these fields without affecting the others. - [Create Envelope](https://developers.gonitro.com/docs/api-reference/sign/create-envelope.md): The **Create Envelope** endpoint creates a new **sign envelope** in Nitro. - [Cancel Envelope by ID](https://developers.gonitro.com/docs/api-reference/sign/cancel-envelope-by-id.md): The **Cancel Envelope by ID** endpoint cancels the signing request for the envelope specified by its UUIDv4 identifier. This endpoint allows you to cancel an envelope and changes its status to Cancelled but keeps it available for reference and reuse after updates. In Cancelled status, no further sig… - [Send Envelope for Signing](https://developers.gonitro.com/docs/api-reference/sign/send-envelope-for-signing.md): The **Send Envelope for Signing** endpoint sends an envelope to participants for signature collection. - [Send Reminders for Envelope](https://developers.gonitro.com/docs/api-reference/sign/send-reminders-for-envelope.md): The **Send Reminders for Envelope** endpoint triggers reminder notifications to pending participants of a specified envelope using its UUIDv4 identifier. - [Download Sealed Envelope](https://developers.gonitro.com/docs/api-reference/sign/download-sealed-envelope.md): The **Download Sealed Envelope** downloads a sealed (signed) envelope's documents along with audit trail in a ZIP archive. - [Download Original Envelope](https://developers.gonitro.com/docs/api-reference/sign/download-original-envelope.md): The **Download Original Envelope** downloads an envelope's original (unsigned) documents in a ZIP archive. - [Download Audit Trail of Envelope](https://developers.gonitro.com/docs/api-reference/sign/download-audit-trail-of-envelope.md): Downloads the PDF file containing the full audit trail for the selected envelope. - [List Documents by Envelope ID](https://developers.gonitro.com/docs/api-reference/sign/list-documents-by-envelope-id.md): The **List Documents by Envelope ID** endpoint retrieves all documents associated with a specific envelope. Documents are returned in an `items` array within the JSON response. The request must include the envelope ID to ensure the complete set of documents is retrieved for the correct envelope. - [Create Document by Envelope ID](https://developers.gonitro.com/docs/api-reference/sign/create-document-by-envelope-id.md): In Nitro, a *Document* is a file that participants in an eSignature Envelope will read and sign. This could be an employment contract, NDA, legal agreement, banking form, or any other file required in your signature workflow. - [Reorder Documents by Envelope ID](https://developers.gonitro.com/docs/api-reference/sign/reorder-documents-by-envelope-id.md): The **Reorder Documents by Envelope ID** endpoint reorders all documents associated with a specific envelope based on the order specified in the request body. Documents are returned in an `items` array within the JSON response reflecting the new order. - [Get Document by ID](https://developers.gonitro.com/docs/api-reference/sign/get-document-by-id.md): The **Get Document by ID** endpoint retrieves the details of a single document using its identifier within a specific envelope. - [Delete Document by ID](https://developers.gonitro.com/docs/api-reference/sign/delete-document-by-id.md): The **Delete Document by ID** endpoint deletes permanently removes a document from an envelope. - [Update Document by ID](https://developers.gonitro.com/docs/api-reference/sign/update-document-by-id.md): The **Update Document by ID** endpoint allows you to update an existing document's metadata within an envelope. This endpoint performs a partial update on the document, changing only the provided fields while preserving all other properties. Currently, only the document name can be updated. - [Download Sealed Document by ID](https://developers.gonitro.com/docs/api-reference/sign/download-sealed-document-by-id.md): The **Download Sealed Document by ID** downloads a single sealed (signed) document as a PDF from a sealed envelope. - [Create Field(s) by Document ID](https://developers.gonitro.com/docs/api-reference/sign/create-fields-by-document-id.md): The **Create Field(s) by Document ID** endpoint creates one or more fields on a document and assigns it to a participant. Accepts either a single field object or a bulk request with an 'items' array containing multiple field objects. - [List Fields by Document ID](https://developers.gonitro.com/docs/api-reference/sign/list-fields-by-document-id.md): The **List Fields by Document ID** endpoint retrieves all fields associated with a specific document within an envelope. The request must include the envelope and document ID to ensure the complete set of fields is retrieved for the correct document. - [Delete Field by ID](https://developers.gonitro.com/docs/api-reference/sign/delete-field-by-id.md): The **Delete Field by ID** endpoint permanently deletes a field from a document within an envelope. - [Delete Fields by Field IDs](https://developers.gonitro.com/docs/api-reference/sign/delete-fields-by-field-ids.md): The **Delete Fields** endpoint permanently deletes multiple fields from a document within an envelope. - [Update Field by ID](https://developers.gonitro.com/docs/api-reference/sign/update-field-by-id.md): The **Update Field by ID** endpoint modifies the properties of an existing field. The Field type cannot be updated. All parameters are optional. - [Delete Participant by ID](https://developers.gonitro.com/docs/api-reference/sign/delete-participant-by-id.md): The **Delete Participant by ID** endpoint permanently deletes a participant from an envelope. - [List Participants by Envelope ID](https://developers.gonitro.com/docs/api-reference/sign/list-participants-by-envelope-id.md): The **List Participant by Envelope ID** endpoint returns all participants associated with a specific envelope. The request must include the envelope ID to ensure the complete set of participants is retrieved for the correct envelope. - [List Participant Signing URLs by Envelope ID](https://developers.gonitro.com/docs/api-reference/sign/list-participant-signing-urls-by-envelope-id.md): The **List Participant Signing URLs by Envelope ID** endpoint returns the URL and its expiry for each participant of an envelope, for every role. Signers receive a URL into the signing experience; CC participants receive a read-only view URL. - [Create Participant(s) by Envelope ID](https://developers.gonitro.com/docs/api-reference/sign/create-participants-by-envelope-id.md): The **Create Participant(s) by Envelope ID** endpoint adds one or more participants to a specified envelope. Accepts either a single participant object or a bulk request with an 'items' array. Participants are associated to the parent Envelope and can sign multiple fields in different documents. - [Delete Participants by Participant IDs](https://developers.gonitro.com/docs/api-reference/sign/delete-participants-by-participant-ids.md): The **Delete Participants** endpoint permanently deletes multiple participants from an envelope. - [Update Participant by ID](https://developers.gonitro.com/docs/api-reference/sign/update-participant-by-id.md): The **Update Participant by ID** endpoint modifies a participant's authentication settings. The participant's email cannot be updated. All parameters are optional. - [List webhook configs for the authenticated application](https://developers.gonitro.com/docs/api-reference/webhooks/list-webhook-configs-for-the-authenticated-application.md) - [Create webhook config](https://developers.gonitro.com/docs/api-reference/webhooks/create-webhook-config.md) - [Get webhook config by ID](https://developers.gonitro.com/docs/api-reference/webhooks/get-webhook-config-by-id.md) - [Update webhook config](https://developers.gonitro.com/docs/api-reference/webhooks/update-webhook-config.md) - [Delete webhook config](https://developers.gonitro.com/docs/api-reference/webhooks/delete-webhook-config.md) - [Send a test event to a webhook endpoint](https://developers.gonitro.com/docs/api-reference/webhooks/send-a-test-event-to-a-webhook-endpoint.md): Relays the customer endpoint's response: the HTTP status mirrors theirs, and the body (httpStatus, latencyMs, success, error) reports the outcome. A 4xx/5xx usually means their endpoint responded that way; this API's own responses are 400 (validation), 429 problem+json with Retry-After (rate limit),… - [List supported webhook event types](https://developers.gonitro.com/docs/api-reference/webhooks/list-supported-webhook-event-types.md): Returns the event types a webhook config can subscribe to, in envelope lifecycle order. To subscribe to all of them - including event types introduced in the future - send ["AllEvents"] as the config's events instead of an explicit list. - [Good Development Practices](https://developers.gonitro.com/docs/build-nitro/good-practices.md): Recommended practices for building reliable, maintainable integrations with the Nitro REST APIs. - [API Error Codes](https://developers.gonitro.com/docs/build-nitro/errors.md): Common Nitro API error responses (400, 401, 404, 500…) explained, with what causes each and how to resolve them. - [Rotate Credentials](https://developers.gonitro.com/docs/authentication/credential-rotation.md): Rotate your Nitro API credentials to revoke a compromised client secret, generate a new one, and restore secure API access. - [Changelog](https://developers.gonitro.com/docs/api-reference/changelog.md): Latest Nitro API product updates, new endpoints, and announcements. - [Power Automate connector](https://developers.gonitro.com/docs/integrations/power-automate/overview.md): Add Nitro PDF and Sign actions to your Microsoft Power Automate flows. - [Get started with Power Automate](https://developers.gonitro.com/docs/integrations/power-automate/getting-started.md): Create a Nitro PDF Services connection in Power Automate and build your first flow — no connector import required. - [Authentication](https://developers.gonitro.com/docs/integrations/power-automate/authentication.md): How the Nitro PDF Services connector authenticates Power Automate flows using OAuth 2.0 client credentials. - [Actions](https://developers.gonitro.com/docs/integrations/power-automate/actions.md): Every action in the Nitro PDF Services connector for Power Automate, grouped by conversions, transformations, extractions, and forms. - [Compress PDF Document](https://developers.gonitro.com/docs/integrations/power-automate/actions/compress-pdf.md): Reduce the file size of a PDF inside a Power Automate flow with the Nitro PDF Services connector. - [Merge PDF Documents](https://developers.gonitro.com/docs/integrations/power-automate/actions/merge-pdfs.md): Combine several PDFs into one inside a Power Automate flow with the Nitro PDF Services connector. - [Extract all Text from PDF](https://developers.gonitro.com/docs/integrations/power-automate/actions/extract-text.md): Pull the readable text out of a PDF inside a Power Automate flow with the Nitro PDF Services connector. - [Working with files](https://developers.gonitro.com/docs/integrations/power-automate/working-with-files.md): How Power Automate passes files between steps, how to chain Nitro actions, and the exact JSON each Nitro action takes and returns. - [Limits and errors](https://developers.gonitro.com/docs/integrations/power-automate/limits-and-errors.md): File size and page limits, throttling, and error codes for the Nitro PDF Services connector in Power Automate. - [Zapier connector](https://developers.gonitro.com/docs/integrations/zapier/overview.md): Add Nitro PDF and Sign actions to your Zaps. - [Get started with Zapier](https://developers.gonitro.com/docs/integrations/zapier/getting-started.md): Connect the Nitro PDF Services app to Zapier and build your first Zap. - [Authentication](https://developers.gonitro.com/docs/integrations/zapier/authentication.md): How the Nitro PDF Services Zapier app authenticates using OAuth 2.0 client credentials. - [Actions](https://developers.gonitro.com/docs/integrations/zapier/actions.md): Every action in the Nitro PDF Services Zapier app, grouped by conversions, extractions, transformations, and forms. - [Compress PDF](https://developers.gonitro.com/docs/integrations/zapier/actions/compress-pdf.md): Reduce the file size of a PDF inside a Zap with the Nitro PDF Services app. - [Merge PDFs](https://developers.gonitro.com/docs/integrations/zapier/actions/merge-pdfs.md): Combine several PDFs into one inside a Zap with the Nitro PDF Services app. - [Text Extract](https://developers.gonitro.com/docs/integrations/zapier/actions/extract-text.md): Pull the readable text out of a PDF inside a Zap with the Nitro PDF Services app. - [Working with files](https://developers.gonitro.com/docs/integrations/zapier/working-with-files.md): How Zapier passes files to Nitro PDF Services actions, how to chain actions, and the input formats each action expects. - [Limits and errors](https://developers.gonitro.com/docs/integrations/zapier/limits-and-errors.md): File size and page limits, throttling, and error handling for the Nitro PDF Services Zapier app. - [Overview](https://developers.gonitro.com/docs/nsev/getting-started/overview.md): What Nitro Sign Enterprise Verified is, how its WebPortal API is structured, and how it authenticates. - [Platform Access](https://developers.gonitro.com/docs/nsev/getting-started/basic-setup.md): What you need before making your first request: credentials and your tenant base URL. - [Credentials & Authentication](https://developers.gonitro.com/docs/nsev/authentication/credentials.md): The two authentication methods of the NSEV WebPortal API - Basic Auth and OAuth 2.0 - and when to use each. - [Make your first call](https://developers.gonitro.com/docs/nsev/getting-started/first-call.md): Verify your credentials and base URL by making an authenticated request to the document groups endpoint. - [The package model](https://developers.gonitro.com/docs/nsev/build/concepts/package-model.md): How a package is structured in Nitro Sign Enterprise Verified: documents, stakeholders, actors, elements, and the process that orders them. - [Instant package](https://developers.gonitro.com/docs/nsev/build/tutorials/instant-package.md): The fastest path to a signed document: create the package, its document, signer, and signing field in a single super call, then poll and download. - [Send a document for signing](https://developers.gonitro.com/docs/nsev/build/tutorials/send-for-signing.md): End-to-end tutorial: create a package with its stakeholders, upload a document, set the signing process, and activate the workflow. - [Templates](https://developers.gonitro.com/docs/nsev/build/tutorials/templates.md): Save a configured package as a reusable template, then create new packages from it with a single TemplateCode instead of rebuilding documents, stakeholders, and fields each time. - [Deleting packages](https://developers.gonitro.com/docs/nsev/build/tutorials/deleting-packages.md): How to delete packages one at a time or in bulk, and how deleting differs from revoking. - [Callbacks and redirects](https://developers.gonitro.com/docs/nsev/build/guides/callbacks.md): How to receive status-change callbacks, regenerate one-time signing links, suppress NSEV's own notifications, and redirect users after they act. - [Field positioning](https://developers.gonitro.com/docs/nsev/build/guides/field-positioning.md): The three ways to place a signing field, text box, checkbox, radio group, or combo box on a document: explicit coordinates, text markers embedded in the document, and references to existing PDF form fields. - [Best Practices](https://developers.gonitro.com/docs/nsev/build/guides/good-practices.md): Guidelines for authentication, error handling, document limits, pagination, and security when using the NSEV WebPortal API. - [Gotchas](https://developers.gonitro.com/docs/nsev/build/guides/gotchas.md): Things that surprise integrators: PDF input pitfalls, why an API stakeholder is not a Contact, document-group permissions, package naming rules, and the Web Application Firewall. - [Changelog](https://developers.gonitro.com/docs/nsev/changelog.md): Latest Nitro Sign Enterprise Verified API updates, new endpoints, and announcements. - [List packages](https://developers.gonitro.com/docs/nsev/api-reference/packages/list-packages.md): Retrieves all packages that currently exist in NSEV, together with their current status. Results are always sorted on creation date. - [Create package](https://developers.gonitro.com/docs/nsev/api-reference/packages/create-package.md): Creates a package and, optionally, everything it contains in a single request. - [Get package](https://developers.gonitro.com/docs/nsev/api-reference/packages/get-package.md): Retrieves a single package by its unique identifier, including its documents, stakeholders, actors, elements and current status. - [Delete package](https://developers.gonitro.com/docs/nsev/api-reference/packages/delete-package.md): Deletes a package from the database. - [Get package expiry date](https://developers.gonitro.com/docs/nsev/api-reference/packages/get-package-expiry-date.md): Retrieves the expiry date of a package - the moment after which the package and all documents within it can no longer be form filled, approved or signed. - [Update package expiry date](https://developers.gonitro.com/docs/nsev/api-reference/packages/update-package-expiry-date.md): Updates the expiry date of a package. Extending the expiry date makes a package that had already expired available again. Documents within the package always expire on the same date as the package. - [Get package status](https://developers.gonitro.com/docs/nsev/api-reference/packages/get-package-status.md): Retrieves the current status of a package. - [Update package status](https://developers.gonitro.com/docs/nsev/api-reference/packages/update-package-status.md): Updates the status of a package. Only two transitions are supported: - [Update package document order](https://developers.gonitro.com/docs/nsev/api-reference/packages/update-package-document-order.md): Updates the order of the documents in a draft package. Provide each document's ID together with the order index it should take. - [Get package warnings](https://developers.gonitro.com/docs/nsev/api-reference/packages/get-package-warnings.md): Retrieves all warnings about a package, such as missing data. The response is a list of warnings; warnings whose `ResourceType` is `process` additionally identify the stakeholder and actor involved. - [Send package reminders](https://developers.gonitro.com/docs/nsev/api-reference/packages/send-package-reminders.md): Sends a reminder to the actors in the current process step who have not yet form filled, approved or signed. - [Skip approvers](https://developers.gonitro.com/docs/nsev/api-reference/packages/skip-approvers.md): Skips all approvers that have not yet approved and sets their status to `Skipped`, which marks the whole package as `Pending`: the package then becomes available to the signers, so you no longer need to wait for every approver to finish. The package must be in the pending-approval stage; whether any… - [Skip signers](https://developers.gonitro.com/docs/nsev/api-reference/packages/skip-signers.md): Skips all signers that have not yet signed and sets their status to `Skipped`, which marks the whole package as `Finished`: the package then becomes available for download without waiting for every signer. The package must be in the pending-signing stage; whether any signer has already signed does n… - [Create template from package](https://developers.gonitro.com/docs/nsev/api-reference/packages/create-template-from-package.md): Saves a draft package as a reusable template. Everything that defines the package - its documents, stakeholders and so on - is stored as part of the template, so you can generate templates on the fly as part of an automated flow. The template name must be unique within its document group. - [Download package](https://developers.gonitro.com/docs/nsev/api-reference/packages/download-package.md): Downloads all documents in a package as a single `.zip` file. Only finished and archived packages can be downloaded; other states return `409 Conflict`. - [Get actors for a user](https://developers.gonitro.com/docs/nsev/api-reference/packages/get-actors-for-a-user.md): Retrieves all actors across packages for a specific user, identified by email address. Use the query parameters to page and to filter by status, actor type, creation date and sort order. - [List documents](https://developers.gonitro.com/docs/nsev/api-reference/documents/list-documents.md): Retrieves all documents that currently exist within the specified package. - [Add document](https://developers.gonitro.com/docs/nsev/api-reference/documents/add-document.md): Adds a document to an existing package. After the document is added you can build it out further by adding elements (signing fields, checkbox fields, text box fields and radio groups) in separate calls, or you can supply everything in this single call by including the `Elements` array. - [Get document](https://developers.gonitro.com/docs/nsev/api-reference/documents/get-document.md): Retrieves a single document from a package by its document ID. - [Delete document](https://developers.gonitro.com/docs/nsev/api-reference/documents/delete-document.md): Deletes a document from a package. The document can only be deleted while the package is in the `Draft`, `Processing` or `ProcessingFailed` status. - [Confirm document actions](https://developers.gonitro.com/docs/nsev/api-reference/documents/confirm-document-actions.md): Performs keep/remove actions on a document that is not yet fully processed - for example a document uploaded through the Document Portal that still contains existing signatures, form fields or signing field markers. - [Download document](https://developers.gonitro.com/docs/nsev/api-reference/documents/download-document.md): Downloads a single document from a package as a PDF or XML file. A document can only be downloaded once the package is fully finished. - [Get document by order index](https://developers.gonitro.com/docs/nsev/api-reference/documents/get-document-by-order-index.md): Retrieves a single document from a package by its order index - the position that defines how documents are sorted within the package. The order index must be a positive integer. - [Get elements action url](https://developers.gonitro.com/docs/nsev/api-reference/elements/get-elements-action-url.md): Retrieves a one-time action URL that lets an end user open the Package Elements Editor and drag and drop placed and unplaced elements onto the package's documents. - [List unplaced elements](https://developers.gonitro.com/docs/nsev/api-reference/elements/list-unplaced-elements.md): Retrieves all unplaced elements that currently exist on the specified package. - [Create unplaced element](https://developers.gonitro.com/docs/nsev/api-reference/elements/create-unplaced-element.md): Creates one or more unplaced elements on the specified package. The request body is an array; each entry creates one unplaced element. - [Get unplaced element](https://developers.gonitro.com/docs/nsev/api-reference/elements/get-unplaced-element.md): Retrieves a single unplaced element on the specified package by its element ID. - [Delete unplaced element](https://developers.gonitro.com/docs/nsev/api-reference/elements/delete-unplaced-element.md): Deletes a single unplaced element from the specified package. The package must be in the `Draft` status; deleting an unplaced element from a package in another status fails. - [List document elements](https://developers.gonitro.com/docs/nsev/api-reference/elements/list-document-elements.md): Retrieves all elements that currently exist on the specified document within the specified package. - [Create element](https://developers.gonitro.com/docs/nsev/api-reference/elements/create-element.md): Adds one element to an existing document. The element type is chosen with the `Type` field, which can be one of five values: - [Get element by id](https://developers.gonitro.com/docs/nsev/api-reference/elements/get-element-by-id.md): Retrieves a single element on the specified document by its element ID. - [Delete element](https://developers.gonitro.com/docs/nsev/api-reference/elements/delete-element.md): Deletes a single element from the specified document. The package must be in the `Draft` status; deleting an element from a package in another status fails. - [List stakeholders](https://developers.gonitro.com/docs/nsev/api-reference/stakeholders/list-stakeholders.md): Retrieves all stakeholders that currently exist within the specified package. - [Create stakeholder](https://developers.gonitro.com/docs/nsev/api-reference/stakeholders/create-stakeholder.md): Creates a stakeholder and adds it to the specified package. A stakeholder is an entity that has an interest in a package; a single stakeholder may carry multiple actors (the actions it must take, such as filling forms, approving, signing or receiving). - [Get stakeholder](https://developers.gonitro.com/docs/nsev/api-reference/stakeholders/get-stakeholder.md): Retrieves a single stakeholder from a package by its stakeholder ID. - [Delete stakeholder](https://developers.gonitro.com/docs/nsev/api-reference/stakeholders/delete-stakeholder.md): Deletes a stakeholder from a draft package. The package must still be in draft for the stakeholder to be removed. The implicit "undecided" stakeholder cannot be deleted. - [List actors](https://developers.gonitro.com/docs/nsev/api-reference/actors/list-actors.md): Retrieves all actors of the specified stakeholder. An actor represents a single action a stakeholder must take on the package; see Create actor for the actor types and their semantics. - [Create actor](https://developers.gonitro.com/docs/nsev/api-reference/actors/create-actor.md): Creates an actor and adds it to the specified stakeholder. An actor is a single action a stakeholder must take on a package. There are four actor types, selected with the `Type` property: - [Get actor](https://developers.gonitro.com/docs/nsev/api-reference/actors/get-actor.md): Retrieves a single actor by its actor ID. - [Delete actor](https://developers.gonitro.com/docs/nsev/api-reference/actors/delete-actor.md): Deletes an actor from a draft package. The package must still be in draft. The actor of the implicit "undecided" stakeholder cannot be deleted. - [Reassign actor](https://developers.gonitro.com/docs/nsev/api-reference/actors/reassign-actor.md): Reassigns an appointed actor to a new person stakeholder - for example when the original assignee is unavailable and someone else must take over the action. The replacement is always a **person** stakeholder. - [Get process](https://developers.gonitro.com/docs/nsev/api-reference/process/get-process.md): Retrieves the package's full process: the ordered list of process steps, each step being a set of actors whose actions run in parallel. The steps themselves run in sequence. See Create process step for how a process is structured. - [Create process step](https://developers.gonitro.com/docs/nsev/api-reference/process/create-process-step.md): Adds one process step to the package's process. A process step is an array of actors whose actions can be performed in parallel; steps run sequentially in the order they appear in the process. - [Update process](https://developers.gonitro.com/docs/nsev/api-reference/process/update-process.md): Overwrites the package's entire process with the supplied steps. The body is a 2D array: the outer array is the ordered list of steps, and each inner array is the set of actors that run in parallel within that step. The same step-ordering and actor-type rules as Create process step apply. - [List process step actions](https://developers.gonitro.com/docs/nsev/api-reference/process/list-process-step-actions.md): Retrieves the set of actions of a single process step, identified by its `stepIndex`. These are the actions that can be completed in parallel within that step. - [Delete process step](https://developers.gonitro.com/docs/nsev/api-reference/process/delete-process-step.md): Deletes a process step and all of its actions from the package, identified by its `stepIndex`. The package must still be in draft. - [Submit process step action](https://developers.gonitro.com/docs/nsev/api-reference/process/submit-process-step-action.md): Adds an actor to an existing process step, identified by its `stepIndex`. The actor parameters are the same as for Create process step. On success the `Location` header points to the created actor under its stakeholder. - [Get current process step](https://developers.gonitro.com/docs/nsev/api-reference/process/get-current-process-step.md): Retrieves the actions of the process step that is currently in progress - for example the signing step once approval and form filling are complete. The returned actions can be completed in parallel. - [Download audit trail](https://developers.gonitro.com/docs/nsev/api-reference/audittrails/download-audit-trail.md): Downloads a package's audit trail as a signed PDF file, rendered in the requested culture. - [Get the package audit trail](https://developers.gonitro.com/docs/nsev/api-reference/audittrails/get-the-package-audit-trail.md): Retrieves a package's audit trail as structured JSON - a list of events that occurred during the package's lifecycle, together with package and document information. The audit trail is available for a package in any status. - [Verify audit trail](https://developers.gonitro.com/docs/nsev/api-reference/audittrails/verify-audit-trail.md): Verifies whether a package's audit trail is valid, returning a boolean. - [Bulk sign packages](https://developers.gonitro.com/docs/nsev/api-reference/bulkactions/bulk-sign-packages.md): Starts a bulk signing session for a user so they can sign multiple pending packages from a single session URL. The response contains an `ActionUrl` that opens the bulk signing session. - [Bulk update package status](https://developers.gonitro.com/docs/nsev/api-reference/bulkactions/bulk-update-package-status.md): Updates the status of multiple packages at once. The supported transitions are draft → pending and pending → revoked. - [Bulk delete packages](https://developers.gonitro.com/docs/nsev/api-reference/bulkactions/bulk-delete-packages.md): Permanently deletes multiple packages from the database in a single call. - [Bulk download packages](https://developers.gonitro.com/docs/nsev/api-reference/bulkactions/bulk-download-packages.md): Requests the contents of multiple finished packages for download. - [Bulk send reminders](https://developers.gonitro.com/docs/nsev/api-reference/bulkactions/bulk-send-reminders.md): Sends a reminder notification to the actors of the specified packages who have not yet approved, signed or filled out their documents. - [Bulk extend package expiry date](https://developers.gonitro.com/docs/nsev/api-reference/bulkactions/bulk-extend-package-expiry-date.md): Extends the expiry date of multiple packages at once, making expired documents accessible again. Documents within a package expire on the same date as the package. - [Bulk skip actors](https://developers.gonitro.com/docs/nsev/api-reference/bulkactions/bulk-skip-actors.md): Skips actors who have not yet acted on the specified packages. - [Bulk download audit trail PDFs](https://developers.gonitro.com/docs/nsev/api-reference/bulkactions/bulk-download-audit-trail-pdfs.md): Requests the audit trail PDFs of multiple packages for download. The packages must not be in draft status. - [Get package bulk action session status](https://developers.gonitro.com/docs/nsev/api-reference/bulkactions/get-package-bulk-action-session-status.md): Bulk package actions are processed in the background, so they do not report success or failure immediately. Instead, each bulk action returns a bulk action session identifier. Use this operation to poll that session: it reports whether processing is still `Pending`, `Finishing` or `Finished`, and ho… - [Get bulk action session status](https://developers.gonitro.com/docs/nsev/api-reference/bulkactions/get-bulk-action-session-status.md): Returns the status of a bulk action session that is not scoped to packages - for example the session created when inviting users in bulk. - [Download bulk action result](https://developers.gonitro.com/docs/nsev/api-reference/bulkactions/download-bulk-action-result.md): Retrieves the result of a bulk action that produces a `.zip` archive - bulk download packages or bulk download audit trail PDFs - once that bulk action has finished. - [List contact groups](https://developers.gonitro.com/docs/nsev/api-reference/configuration/list-contact-groups.md): Retrieves all contact groups and their codes that are currently configured in the WebPortal. - [List document groups](https://developers.gonitro.com/docs/nsev/api-reference/configuration/list-document-groups.md): Lists the document groups that packages and documents can be assigned to, returning each group's name and code. - [List languages](https://developers.gonitro.com/docs/nsev/api-reference/configuration/list-languages.md): Retrieves the languages that are enabled in the NSEV configuration and are therefore available in the Portal. - [List themes](https://developers.gonitro.com/docs/nsev/api-reference/configuration/list-themes.md): Retrieves all themes and their codes that are currently configured. - [Get version](https://developers.gonitro.com/docs/nsev/api-reference/configuration/get-version.md): Returns the product version and build (file) number of the NSEV deployment serving your tenant. No authentication is required. - [List signing methods](https://developers.gonitro.com/docs/nsev/api-reference/configuration/list-signing-methods.md): Retrieves the signing methods that are currently enabled or disabled in the NSEV configuration, so integrators can discover which methods an installation supports without maintaining a duplicate list. - [List templates](https://developers.gonitro.com/docs/nsev/api-reference/configuration/list-templates.md): Retrieves the package templates available in the WebPortal, with their codes. - [Invite user](https://developers.gonitro.com/docs/nsev/api-reference/users/invite-user.md): Invites one or more users to the NSEV environment by email and, optionally, adds them to user groups. A shared contact can be created from an invited user via the creation options. - [Creates an absence period](https://developers.gonitro.com/docs/nsev/api-reference/absenceperiods/creates-an-absence-period.md): Creates an absence period for a user and assigns the substitutes who take over that user's actions while they are away. - [Gets absence periods by email address](https://developers.gonitro.com/docs/nsev/api-reference/absenceperiods/gets-absence-periods-by-email-address.md): Retrieves the absence periods configured for a user, identified by email address. The response shape matches the create-absence-period operation. - [Gets an absence period by id](https://developers.gonitro.com/docs/nsev/api-reference/absenceperiods/gets-an-absence-period-by-id.md): Retrieves a single absence period by its identifier. The response shape matches the create-absence-period operation. - [Updates an absence period by id](https://developers.gonitro.com/docs/nsev/api-reference/absenceperiods/updates-an-absence-period-by-id.md): Updates an absence period by its identifier. The request and response shapes match the create-absence-period operation, with each existing substitute identified by its `Id`. - [Deletes an absence period by id](https://developers.gonitro.com/docs/nsev/api-reference/absenceperiods/deletes-an-absence-period-by-id.md): Deletes an absence period by its identifier. Returns no content on success. ## OpenAPI Specs - [compress](/docs/api-reference/platform/output/compress.json) - [create-fillable-forms](/docs/api-reference/platform/output/create-fillable-forms.json) - [delete](/docs/api-reference/platform/output/delete.json) - [extract-fillable-form-data](/docs/api-reference/platform/output/extract-fillable-form-data.json) - [extract-invoices](/docs/api-reference/platform/output/extract-invoices.json) - [extract-text](/docs/api-reference/platform/output/extract-text.json) - [fill-forms](/docs/api-reference/platform/output/fill-forms.json) - [flatten](/docs/api-reference/platform/output/flatten.json) - [forms](/docs/api-reference/platform/output/forms.json) - [get-properties](/docs/api-reference/platform/output/get-properties.json) - [imgtopdf](/docs/api-reference/platform/output/imgtopdf.json) - [job](/docs/api-reference/platform/output/job.json) - [merge](/docs/api-reference/platform/output/merge.json) - [misctopdf](/docs/api-reference/platform/output/misctopdf.json) - [mstopdf](/docs/api-reference/platform/output/mstopdf.json) - [ocr](/docs/api-reference/platform/output/ocr.json) - [optimize](/docs/api-reference/platform/output/optimize.json) - [pdfa](/docs/api-reference/platform/output/pdfa.json) - [pdftoimg](/docs/api-reference/platform/output/pdftoimg.json) - [pdftoms](/docs/api-reference/platform/output/pdftoms.json) - [pii](/docs/api-reference/platform/output/pii.json) - [presigned-file-urls](/docs/api-reference/platform/output/presigned-file-urls.json) - [protect](/docs/api-reference/platform/output/protect.json) - [redact](/docs/api-reference/platform/output/redact.json) - [rotate](/docs/api-reference/platform/output/rotate.json) - [set-properties](/docs/api-reference/platform/output/set-properties.json) - [smart-detect-form-fields](/docs/api-reference/platform/output/smart-detect-form-fields.json) - [split](/docs/api-reference/platform/output/split.json) - [tables](/docs/api-reference/platform/output/tables.json) - [text-box](/docs/api-reference/platform/output/text-box.json) - [unprotect](/docs/api-reference/platform/output/unprotect.json) - [watermark](/docs/api-reference/platform/output/watermark.json) - [openapi](https://api.gonitro.dev/openapi.json) - [openapi](/docs/nsev/api-reference/openapi.yaml) This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.