> ## Documentation Index > Fetch the complete documentation index at: https://developers.gonitro.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Confirm document actions > 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. When such a document is fetched (Get document), its `IsActionNeeded` flag is `true`, and `HasSignatures`, `HasSigningFields` and `HasFormFields` indicate what was detected. Use this call to decide which of those to keep, after which the document moves to `Draft` status and is fully processed. `KeepSignatures` and `KeepFormFields` are mutually exclusive: a document cannot keep existing signatures and use form fields at the same time, so these two cannot both be `true` in one request. ## OpenAPI ````yaml /nsev/api-reference/openapi.yaml post /packages/{packageId}/documents/{documentId}/actions openapi: 3.0.0 info: title: NSEV WebPortal API version: 4.0.0 contact: name: NSEV Support Team url: https://connectivegroup.my.site.com/s/contactsupport?language=en_US description: > **Nitro Sign Enterprise Verified (NSEV) WebPortal API Version 4** A comprehensive digital signing API that enables secure document signing workflows. This API provides endpoints for managing packages, documents, elements, stakeholders, and signing processes within the NSEV platform. ## Authentication This API supports multiple authentication methods: ### Basic Authentication Traditional HTTP Basic Authentication using username and password. ### OAuth 2.0 **Client Credentials Flow (Machine-to-Machine)** - Full API access including administrative endpoints - Ideal for server-to-server integrations **Authorization Code Flow (User-based)** - Limited API access excluding administrative endpoints - Ideal for user-facing applications - Supports delegated user access scenarios ## API Variants This specification is available in two variants: - **Full API**: Complete API with all endpoints (BasicAuth + OAuth2 M2M) - **User API**: Limited API excluding admin endpoints (OAuth2 user-based only) Administrative endpoints (`/poisonqueue`, `/absenceperiods`, `/auditproofs`) are restricted to machine-to-machine authentication only. ## Versioning This API follows semantic versioning principles. Major version changes may introduce breaking changes, while minor and patch versions maintain backwards compatibility. servers: - url: '{baseUrl}/esig/webportalapi/v4' variables: baseUrl: default: https://your-tenant.sign.gonitro.com description: >- Your tenant-specific base URL, including scheme and host (e.g. https://acme.sign.gonitro.com). Each NSEV customer has a unique URL. Replace this with yours before sending a request. The esig path segment is required - the Web Application Firewall routes requests on it. security: - basicAuth: [] - bearerAuth: [] tags: - name: Configuration description: | Endpoints for retrieving system configuration settings, contact groups, templates and signing methods. - name: Packages description: | Core endpoints for creating, managing, and tracking packages throughout their lifecycle. - name: Documents description: | Endpoints for adding, removing, and managing documents within packages. Handles document upload, processing, and metadata management. - name: Elements description: | Endpoints for managing elements (fields) within documents, including signatures and other form elements. - name: Stakeholders description: | Endpoints for managing stakeholders (recipients) associated with packages and their roles in the package workflow. - name: Actors description: | Endpoints for managing individual actors within stakeholders, including their contact information and role preferences: Approver, FormFiller, Signer or Receiver - name: Process description: | Endpoints for managing the package process workflow, including process steps, parallel actions, and workflow orchestration. - name: AuditTrails description: | Modern endpoints for retrieving comprehensive audit trails as signed PDFs, verifying the integrity of audit trail data and retrieving audit events. - name: BulkActions description: | Endpoints for performing and managing bulk actions on multiple packages. - name: Users description: | Endpoints for managing user accounts, including user invitations. - name: AbsencePeriods description: | Administrative endpoints for managing user absence periods and delegation settings during out-of-office scenarios. **Access Level**: Machine-to-machine only (administrative access required) paths: /packages/{packageId}/documents/{documentId}/actions: parameters: - $ref: '#/components/parameters/documentIdPathParam' - $ref: '#/components/parameters/packageIdPathParam' post: tags: - Documents summary: Confirm document actions description: >- 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. When such a document is fetched (Get document), its `IsActionNeeded` flag is `true`, and `HasSignatures`, `HasSigningFields` and `HasFormFields` indicate what was detected. Use this call to decide which of those to keep, after which the document moves to `Draft` status and is fully processed. `KeepSignatures` and `KeepFormFields` are mutually exclusive: a document cannot keep existing signatures and use form fields at the same time, so these two cannot both be `true` in one request. operationId: confirmDocumentActions requestBody: $ref: '#/components/requestBodies/ConfirmDocumentActionsRequest' responses: '204': description: Document is in Draft status, no action required '400': $ref: '#/components/responses/ValidationFailed' '401': $ref: '#/components/responses/UnAuthorized' '404': $ref: '#/components/responses/NotFound.DocumentInPackage' '409': description: Unable to perform actions on the document content: application/json: schema: type: array items: $ref: '#/components/schemas/Error' components: parameters: documentIdPathParam: name: documentId in: path required: true description: The target document's unique identifier schema: $ref: '#/components/schemas/Document.Id' packageIdPathParam: name: packageId in: path required: true description: The target package's unique identifier schema: $ref: '#/components/schemas/Package.Id' requestBodies: ConfirmDocumentActionsRequest: description: Actions to be performed on Draft document with IsActionNeeded flag required: true content: application/json: schema: $ref: '#/components/schemas/DocumentActions' examples: keep-nothing: summary: Discard detected signatures and fields value: KeepSignatures: false KeepSigningFields: false KeepFormFields: false responses: ValidationFailed: description: Request failed validation content: application/json: schema: type: array items: $ref: '#/components/schemas/ValidationError' UnAuthorized: description: Caller is unauthorized to perform this operation NotFound.DocumentInPackage: description: Document could not be found in package content: application/json: schema: type: array items: $ref: '#/components/schemas/DocumentNotFoundInPackageError' schemas: Error: title: Error type: object description: Something that went wrong example: ErrorCode: Something.WentWrong ErrorMessage: Something went wrong properties: ErrorCode: type: string description: >- An error code of something that went wrong, in the form of 'Subject.Error:value' ErrorMessage: type: string description: A human-readable explanation of what went wrong Document.Id: allOf: - $ref: '#/components/schemas/Guid' - type: string description: A document's unique identifier Package.Id: allOf: - $ref: '#/components/schemas/Guid' - type: string description: A package's unique identifier DocumentActions: type: object description: >- Document actions to be performed on Draft document with IsActionNeeded flag set to true. properties: KeepSignatures: type: boolean description: >- When true, existing signatures detected in the document are applied to the document file. Default is false. Cannot be true at the same time as KeepFormFields. default: false KeepSigningFields: type: boolean description: >- When true, detected signing field markers are converted to actual signing fields. Default is false. default: false KeepFormFields: type: boolean description: >- When true, detected form field markers are converted to actual form fields. Default is false. Cannot be true at the same time as KeepSignatures. default: false ValidationError: title: Validation error allOf: - $ref: '#/components/schemas/Error' - description: Request failed validation example: ErrorCode: Name.MinimumLength:6 ErrorMessage: The minimum length for a name is 6 DocumentNotFoundInPackageError: title: Document not found in package allOf: - $ref: '#/components/schemas/NotFoundError' example: ErrorCode: Document.NotFoundInPackage:00000000-0000-0000-0000-000000000000 ErrorMessage: >- The document with id [00000000-0000-0000-0000-000000000000] was found in package with id [00000000-0000-0000-0000-000000000000] Guid: title: GUID type: string description: A globally unique identifier format: guid example: 00000000-0000-0000-0000-000000000000 NotFoundError: title: Not found allOf: - $ref: '#/components/schemas/Error' - description: The resource could not be found example: ErrorCode: Document.NotFound:00000000-0000-0000-0000-000000000000 ErrorMessage: >- The document with id '00000000-0000-0000-0000-000000000000' could not be found securitySchemes: basicAuth: type: http scheme: basic bearerAuth: type: http scheme: bearer bearerFormat: JWT description: > Bearer token authentication using JSON Web Tokens (JWT) or opaque tokens. **Usage**: Send the access token in the Authorization header: ``` Authorization: Bearer ``` ````