> ## 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. # Invite user > 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. Inviting users is processed asynchronously: the response returns a `SessionId` that can be used to look up the invitation session's details. ## OpenAPI ````yaml /nsev/api-reference/openapi.yaml post /users/invite 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: /users/invite: post: tags: - Users summary: Invite user description: >- 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. Inviting users is processed asynchronously: the response returns a `SessionId` that can be used to look up the invitation session's details. operationId: inviteUser requestBody: content: application/json: schema: $ref: '#/components/schemas/UserEmailInvitationRequest' examples: invite: summary: Invite users and assign user groups value: Emails: - jane.doe@comp.com - john.roe@comp.com UserGroups: - Sales CreationOptions: IsSharedContact: true InvitationLanguage: en responses: '202': description: Request is accepted. content: application/json: schema: $ref: '#/components/schemas/BulkInviteUsersResult' examples: accepted: summary: Request is accepted value: SessionId: b459d74c-1f90-4d63-9f4a-6de9cead8c5e Link: >- https://example.test/bulkactionsession/b459d74c-1f90-4d63-9f4a-6de9cead8c5e '400': description: Request failed validation. content: application/json: schema: type: array items: $ref: '#/components/schemas/ValidationError' examples: validation-failed: summary: Request failed validation value: - ErrorCode: EmailAddress.Invalid ErrorMessage: The provided email address is invalid. '401': $ref: '#/components/responses/UnAuthorized' components: schemas: UserEmailInvitationRequest: type: object description: Request for sending the user invitation email required: - Emails properties: Emails: type: array items: $ref: '#/components/schemas/EmailAddress' UserGroups: type: array items: $ref: '#/components/schemas/UserGroup.Name' CreationOptions: $ref: '#/components/schemas/UserCreationOptions' BulkInviteUsersResult: type: object description: The bulk invite users request information. properties: SessionId: $ref: '#/components/schemas/Guid' Link: type: string format: url description: url for retrieving bulk invite users session details 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 EmailAddress: title: Email address type: string format: email example: hello@world.test UserGroup.Name: type: string description: A user group name. UserCreationOptions: type: object description: Defines the user creation options. properties: IsSharedContact: type: boolean description: When true, a shared contact is created for each invited user. InvitationLanguage: type: string description: >- Language used for the invitation email, as a two-letter ISO 639-1 code. example: nl enum: - en - nl - de - fr - es - da - nb - sv - fi - lv - pl - hu - it - pt - ro Guid: title: GUID type: string description: A globally unique identifier format: guid example: 00000000-0000-0000-0000-000000000000 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 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 ``` ````