> ## 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.

# List signing methods

> 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.

The response covers both the legacy **SigningTypes** (from the deprecated
Signing Options settings) and the newer **SigningMethods** together with the
**Signing Behavior** they belong to. New signing methods are formatted as
`SigningBehavior:SigningMethod` - for example `SmartCard:BeID`. The
`RemoteHashSigning` behaviour covers the `itsme` and `Swisscom` methods.

When a signing method returns `RequiredProperties`, mandated signing rules
have been applied to it: NSEV compares the data passed in those
properties against the data retrieved from the signing certificate or signing
service to decide whether a signer is mandated to sign in a given session.



## OpenAPI

````yaml /nsev/api-reference/openapi.yaml get /signingmethods
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:
  /signingmethods:
    get:
      tags:
        - Configuration
      summary: List signing methods
      description: >-
        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.


        The response covers both the legacy **SigningTypes** (from the
        deprecated

        Signing Options settings) and the newer **SigningMethods** together with
        the

        **Signing Behavior** they belong to. New signing methods are formatted
        as

        `SigningBehavior:SigningMethod` - for example `SmartCard:BeID`. The

        `RemoteHashSigning` behaviour covers the `itsme` and `Swisscom` methods.


        When a signing method returns `RequiredProperties`, mandated signing
        rules

        have been applied to it: NSEV compares the data passed in those

        properties against the data retrieved from the signing certificate or
        signing

        service to decide whether a signer is mandated to sign in a given
        session.
      parameters:
        - name: isActive
          in: query
          description: only return active / inactive signing methods
          schema:
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ConfiguredSigningMethod'
              examples:
                signing-methods:
                  summary: OK
                  value:
                    - IsActive: true
                      Name: MailOtp:MailOtp
                      DisplayNames:
                        en: Email one-time password
                        nl: E-mail eenmalig wachtwoord
                      DisplayNamesInitiator:
                        en: Email OTP
                      Descriptions:
                        en: Sign using a one-time password sent by email.
                      RequiredProperties: []
                    - IsActive: true
                      Name: SmartCard:BeID
                      DisplayNames:
                        en: Belgian eID
                      DisplayNamesInitiator:
                        en: Belgian eID
                      Descriptions:
                        en: Sign using a Belgian electronic identity card.
                      RequiredProperties:
                        - BeId
        '401':
          $ref: '#/components/responses/UnAuthorized'
components:
  schemas:
    ConfiguredSigningMethod:
      type: object
      description: A configured signing method in NSEV
      properties:
        IsActive:
          type: boolean
          description: >-
            Whether the signingMethod can be used for creating new signing
            fields
        Name:
          type: string
          description: The configured name of the signing method
          example: my_manual_signing
        DisplayNames:
          type: object
          description: The name per language that will be shown to a signer
          additionalProperties:
            type: string
          example:
            en: manual
            nl: manueel
            fr: manuscrite
        DisplayNamesInitiator:
          type: object
          description: >-
            The name per language that should be shown to the initiator when
            creating the package.
          additionalProperties:
            type: string
          example:
            en: manual signature + sealing
            nl: manuele handtekening + sealing
            fr: signature manuelle + sealing
        Descriptions:
          type: object
          description: >-
            Description of the signing method per language to provide more
            information about the signing method during package creation.
          additionalProperties:
            type: string
          example:
            en: The user will have to draw using their mouse
            nl: De gebruiker zal moeten tekenen met zijn muis
            fr: L'utilisateur devra dessiner à l'aide de sa souris
        RequiredProperties:
          type: array
          description: The required properties for mandated signing
          items:
            type: string
          example:
            - BeId
            - FirstName
            - BirthDate
        KeyPairs:
          type: array
          description: available KeyPairs that can be used to sign with this method
          items:
            $ref: '#/components/schemas/KeyPair'
    KeyPair:
      type: object
      description: representation of a signing key pair
      properties:
        Name:
          type: string
          description: Name of the key pair
          example: myKeyPair
        DisplayNames:
          type: object
          description: The name per language that will be shown to a signer
          additionalProperties:
            type: string
          example:
            en: my key pair
            nl: mijn sleutelpaar
            fr: ma paire de clefs
  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 <access_token>

        ```

````