> ## 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. # Get package warnings > 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. ## OpenAPI ````yaml /nsev/api-reference/openapi.yaml get /packages/{packageId}/warnings 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}/warnings: parameters: - $ref: '#/components/parameters/packageIdPathParam' get: tags: - Packages summary: Get package warnings description: >- 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. operationId: getPackageWarnings responses: '200': description: OK content: application/json: schema: type: array items: $ref: '#/components/schemas/Warning' '401': $ref: '#/components/responses/UnAuthorized' '404': $ref: '#/components/responses/NotFound.Package' components: parameters: packageIdPathParam: name: packageId in: path required: true description: The target package's unique identifier schema: $ref: '#/components/schemas/Package.Id' schemas: Warning: oneOf: - $ref: '#/components/schemas/ProcessWarning' - $ref: '#/components/schemas/PackageWarning' - $ref: '#/components/schemas/DocumentWarning' discriminator: propertyName: ResourceType mapping: process: $ref: '#/components/schemas/ProcessWarning' package: $ref: '#/components/schemas/PackageWarning' document: $ref: '#/components/schemas/DocumentWarning' Package.Id: allOf: - $ref: '#/components/schemas/Guid' - type: string description: A package's unique identifier ProcessWarning: title: Process warning allOf: - $ref: '#/components/schemas/WarningBase' - type: object description: > A warning about the process of a package. E.g. group members that don't have the necessary data to sign with a signing method properties: Stakeholder: type: object description: The stakeholder involved properties: Id: $ref: '#/components/schemas/Stakeholder.Id' ExternalReference: $ref: '#/components/schemas/ExternalReference' Actor: description: The actor involved properties: Id: $ref: '#/components/schemas/Actor.Id' example: ResourceType: process Code: ContactGroup.SomeMissingPhoneNumbers Message: >- Some of the group members don't have a phone number required for [SmsOTP] signing type. Stakeholder: Id: 82c6b4f4-70fe-4fff-b176-6df0f4e79293 ExternalReference: userXYZ Actor: Id: 73462bf5-8430-411d-befb-b35c92f35e10 PackageWarning: title: Package warning allOf: - $ref: '#/components/schemas/WarningBase' - type: object description: | A warning about the package. E.g. the package size exceeded the recommended limit. example: ResourceType: package Code: Package.RecommendedMaxSize:150 Message: Recommended size of the package is 150 MB DocumentWarning: title: Document warning allOf: - $ref: '#/components/schemas/WarningBase' - type: object description: | A warning about the document of a package. E.g. the document size exceeded the recommended limit. properties: Document: type: object description: The document involved properties: Id: $ref: '#/components/schemas/Document.Id' ExternalReference: $ref: '#/components/schemas/ExternalReference' example: ResourceType: document Code: Document.RecommendedMaxSize:100 Message: Recommended maximum document size is 100 MB. Document: Id: 02caccbb-91b4-4e7a-902a-0e0cfc9cf134 ExternalReference: doc1 PackageNotFoundError: title: Package not found allOf: - $ref: '#/components/schemas/NotFoundError' example: ErrorCode: Package.NotFound:00000000-0000-0000-0000-000000000000 ErrorMessage: >- The package with id '00000000-0000-0000-0000-000000000000' could not be found Guid: title: GUID type: string description: A globally unique identifier format: guid example: 00000000-0000-0000-0000-000000000000 WarningBase: type: object description: | A notice of a possible problem so it can be resolved or prevented properties: ResourceType: type: string description: The subject of the warning enum: - process - package - document - archiving Code: type: string Message: type: string Stakeholder.Id: allOf: - $ref: '#/components/schemas/Guid' - type: string description: A stakeholder's unique identifier ExternalReference: type: string maxLength: 256 description: >- External reference to this resource set by the calling application. NSEV does not use this value itself. When filtering packages, this matches the package-level external reference only, not document or field references. Actor.Id: allOf: - $ref: '#/components/schemas/Guid' - type: string description: This actor's unique identifier Document.Id: allOf: - $ref: '#/components/schemas/Guid' - type: string description: A document's unique identifier 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 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 responses: UnAuthorized: description: Caller is unauthorized to perform this operation NotFound.Package: description: Package could not be found content: application/json: schema: type: array items: $ref: '#/components/schemas/PackageNotFoundError' 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 ``` ````