Namirial

Namirial Envelopes API

Manage eSignAnyWhere envelope

GitHub OpenAPI

Operations 2

POST /envelopes Get the envelope list #
GET /envelopes/{envelopeId} Get the envelope detail #

Documentation

📖
Documentation
https://service.esignanywhere.net/help/#X-Web_ApiDocumentation
📖
APIReference
https://demo.esignanywhere.net/Api/swagger/ui/index
📖
Documentation
https://doc.namirial.com/connectors-apis/latest/

Specifications

⚙
OpenAPI
https://artifacts.apis.io/namirial/openapi/namirial-envelopes-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/namirial/json-schema/namirial-create-process-draft-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/namirial/json-schema/namirial-envelope-detail-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/namirial/json-schema/namirial-instance-schema.json
📊
JSONSchema
https://artifacts.apis.io/namirial/json-schema/namirial-get-process-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/namirial/json-schema/namirial-instance-no-id-schema.json
📊
JSONSchema
https://artifacts.apis.io/namirial/json-schema/namirial-organization-schema.json

Other Resources

🔗
ChangeLog
https://doc.namirial.com/connectors-apis/latest/changelog/

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/namirial:namirial-envelopes-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

namirial-envelopes-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Namirial Envelopes API
  version: 1.5.1
  license:
    name: Apache 2.0
    url: http://www.apache.org/licenses/LICENSE-2.0.html
  description: 'Operations tagged Envelopes across 2 of this provider''s published API definitions: namirial-connectors-apis.yaml, namirial-connectors-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://esaw-conn-test.namirialtsp.com
  description: (Development)
tags:
- name: Envelopes
  description: Manage eSignAnyWhere envelope
  externalDocs:
    description: Documentation
    url: https://doc.namirial.com/esaw-connectors/envelopes
paths:
  /envelopes:
    post:
      tags:
      - Envelopes
      summary: Get the envelope list
      security:
      - oAuth2AuthCode: []
      - oAuth2ClientCredentials: []
      requestBody:
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                status:
                  type: string
                  description: If set, filters for envelopes by status. = ['Draft', 'Canceled', 'Completed', 'Expired', 'Rejected', 'Template', 'ActionRequired', 'WaitingForOthers', 'ExpiringSoon', 'Active']
                name:
                  type: string
                  description: If set, filters for the given text in envelope name.
                caseSensitive:
                  type: boolean
                  description: If set, uses a case-sensitive filter for the given text in envelope name.
      responses:
        '200':
          description: The envelope list
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FindEnvelopeListResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      operationId: postEnvelopes
      x-operation-id-source: derived
    servers:
    - url: https://esaw-conn-test.namirialtsp.com
      description: (Development)
  /envelopes/{envelopeId}:
    get:
      tags:
      - Envelopes
      summary: Get the envelope detail
      security:
      - oAuth2AuthCode: []
      - oAuth2ClientCredentials: []
      parameters:
      - in: path
        name: envelopeId
        schema:
          type: string
        required: true
        description: Envelope identifier
        example: 0725bfef-c223-4045-a7a0-49f2b54624c2
      responses:
        '200':
          description: The envelope detail
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnvelopeDetailResponse'
              examples:
                detail:
                  $ref: '#/components/examples/EnvelopeDetailResponse'
        '401':
          $ref: '#/components/responses/UnauthorizedError'
      operationId: getEnvelopesByEnvelopeId
      x-operation-id-source: derived
    servers:
    - url: https://esaw-conn-test.namirialtsp.com
      description: (Development)
components:
  schemas:
    EnvelopeDetailResponse:
      type: object
      properties:
        status:
          type: string
          description: The Envelope status
        auditDocument:
          type: string
          description: The Envelope Audit Document Id
        envelopeJsonStatus:
          type: string
          description: The Envelope Json Status
        completedDocuments:
          type: array
          items:
            $ref: '#/components/schemas/CompletedDocuments'
        documentList:
          type: array
          items:
            $ref: '#/components/schemas/DocumentDetail'
        recipientStatus:
          type: array
          items:
            $ref: '#/components/schemas/RecipientsStatus'
    RecipientsStatus:
      type: object
      properties:
        id:
          type: string
          description: The recipient identifier
        email:
          type: string
          description: The recipient email
        firstName:
          type: string
          description: The recipient first name
        lastName:
          type: string
          description: The recipient last name
        orderIndex:
          type: integer
          description: The recipient order index
        signedDate:
          type: string
          description: The recipient signed date
        status:
          type: string
          description: The recipient status
        workstepRedirectUrl:
          type: string
          description: The recipient workstep redirect url
    FindEnvelopeItem:
      type: object
      properties:
        status:
          type: string
          description: The status of the envelope. = ['Draft', 'Started', 'InProgress', 'Canceled', 'Completed', 'Expired', 'Rejected', 'Template', 'CompletedWithWarnings', 'BulkCompleted', 'BulkPartlyCompleted']
        id:
          type: string
          description: The envelope identifier (guid format)
        name:
          type: string
          description: The envelope name
        metaDataXml:
          type: string
          description: The envelope Xml metadata
        bulk:
          type: string
          description: The bulk id. Only set if the envelope is part of a bulk.
    CompletedDocuments:
      type: object
      properties:
        auditDocument:
          type: string
          description: Audit document
        documentId:
          type: string
          description: The document identifier
        fileName:
          type: string
          description: The file name
    FindEnvelopeListResponse:
      type: array
      items:
        $ref: '#/components/schemas/FindEnvelopeItem'
    DocumentDetail:
      type: object
      properties:
        pageSizesInPoints:
          type: array
          items:
            $ref: '#/components/schemas/PageSizePoint'
        docRefNumber:
          type: integer
          description: The document reference number
        fileName:
          type: string
          description: The file name
        formFields:
          type: array
    PageSizePoint:
      type: object
      properties:
        height:
          type: number
          description: Page Height
        width:
          type: number
          description: Page Width
  examples:
    EnvelopeDetailResponse:
      summary: Envelope detail
      value:
        status: InProgress
        auditDocument: a3ec27f2-26a2-493a-974f-3ec6908fae84
        envelopeJsonStatus: jsonobject
        completedDocuments:
        - auditDocument: fe324172-3353-4f25-bc80-51f7a4d2919c
          documentId: 57f2aab6-794b-494b-a9f5-1e2de05c2eae
          fileName: name.pdf
        recipientStatus:
        - id: 4fa2709b-c312-455c-b050-ad174c8b7fbb
          email: nikola@tesla.com
          firstName: Nikola
          lastName: Tesla
          orderIndex: 1
          signedDate: 2021-01-01:18:01:32Z
          status: Signed
          workstepRedirectUrl: https://testuri.com/callback
        documentList:
        - docRefNumber: 1
          fileName: test.pdf
          formFields: []
          pageSizesInPoints:
          - height: 304.2
            width: 332.6
  responses:
    UnauthorizedError:
      description: Access token is missing or invalid
  securitySchemes:
    oAuth2AuthCode:
      type: oauth2
      description: This API uses OAuth 2 with the authorization code grant flow.
      flows:
        authorizationCode:
          authorizationUrl: /auth/authorize
          tokenUrl: /auth/token
          scopes:
            documents:read: Read documents
            documents:write: Modify documents
            processes:read: Read processes
            processes:write: Modify processes
            auth:read: Read auth
    oAuth2ClientCredentials:
      type: oauth2
      description: This API uses OAuth 2 with the client credentials grant flow.
      flows:
        clientCredentials:
          tokenUrl: /auth/token
          scopes:
            documents:read: Read documents
            documents:write: Modify documents
            processes:read: Read processes
            processes:write: Modify processes
            auth:read: Read auth
    basicAuth:
      type: http
      scheme: basic
externalDocs:
  description: Official eSAW Connectors
  url: https://doc.namirial.com/connectors-apis/latest/
x-refined-from:
- namirial-connectors-apis.yaml
- namirial-connectors-openapi.yml