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/esignsimple-com:esignsimple-com-documents-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

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

openapi: 3.2.0
info:
  title: eSignSimple Documents API
  version: 1.0.0
  summary: Send PDF and Word documents for e-signature, track signers and download the signed PDF.
  description: 'A small REST API for eSignSimple (https://esignsimple.com). Upload a PDF or Word document, say who signs where, and get told when it is done. Authenticate with a bearer API key from Settings → Developers (Silver and Gold plans). Field coordinates are fractions of the page (0–1, origin top-left). Webhooks (document.completed, document.declined, document.voided, signer.signed) are signed with HMAC-SHA256 in the `esign-signature` header. Human-readable docs: https://esignsimple.com/developers'
  termsOfService: https://esignsimple.com/legal/terms
  contact:
    name: eSignSimple
    url: https://esignsimple.com/contact
  license:
    name: CC BY 4.0 (this description)
    url: https://creativecommons.org/licenses/by/4.0/
servers:
- url: https://esignsimple.com
security:
- bearerAuth: []
tags:
- name: Documents
paths:
  /api/v1/documents:
    get:
      tags:
      - Documents
      operationId: listDocuments
      summary: List documents, newest first
      parameters:
      - name: status
        in: query
        description: Comma-separated statuses, e.g. `sent,finalizing`.
        schema:
          type: string
      - name: limit
        in: query
        schema:
          type: integer
          minimum: 1
          maximum: 100
          default: 20
      - name: before
        in: query
        description: 'Cursor: pass `next_before` from the previous page.'
        schema:
          type: string
          format: date-time
      responses:
        '200':
          description: A page of documents
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                - has_more
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Document'
                  has_more:
                    type: boolean
                  next_before:
                    type:
                    - string
                    - 'null'
                    format: date-time
        '401':
          $ref: '#/components/responses/Error'
    post:
      tags:
      - Documents
      operationId: createDocument
      summary: Upload a document, add signers and fields, and send it
      description: 'Multipart upload. `file` is a PDF, .doc, .docx, .odt or .rtf (Word files are converted to PDF; up to 25 MB). `data` is a JSON string. Set `send: false` to keep a draft that emails nobody.'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              - data
              properties:
                file:
                  type: string
                  format: binary
                data:
                  $ref: '#/components/schemas/CreateDocumentData'
            encoding:
              data:
                contentType: application/json
      responses:
        '201':
          description: Created (and sent unless `send` was false)
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Document'
                - type: object
                  properties:
                    signing_links:
                      type: array
                      description: 'Filled when the account has no email delivery: deliver each link yourself.'
                      items:
                        type: object
                        properties:
                          signer_id:
                            type: string
                          email:
                            type: string
                          url:
                            type: string
                            format: uri
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '413':
          $ref: '#/components/responses/Error'
        '422':
          $ref: '#/components/responses/Error'
  /api/v1/documents/{id}:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      tags:
      - Documents
      operationId: getDocument
      summary: Status, signers and the full audit trail
      responses:
        '200':
          description: Document with events
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentWithEvents'
        '401':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
    delete:
      tags:
      - Documents
      operationId: deleteDocument
      summary: Permanently delete a draft, voided, declined or completed document
      responses:
        '204':
          description: Deleted
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
  /api/v1/documents/{id}/download:
    parameters:
    - $ref: '#/components/parameters/id'
    get:
      tags:
      - Documents
      operationId: downloadDocument
      summary: Download the signed PDF (or the original)
      parameters:
      - name: file
        in: query
        schema:
          type: string
          enum:
          - final
          - original
          default: final
      responses:
        '200':
          description: PDF
          content:
            application/pdf:
              schema:
                type: string
                format: binary
        '401':
          $ref: '#/components/responses/Error'
        '404':
          $ref: '#/components/responses/Error'
        '409':
          $ref: '#/components/responses/Error'
  /api/v1/documents/{id}/void:
    parameters:
    - $ref: '#/components/parameters/id'
    post:
      tags:
      - Documents
      operationId: voidDocument
      summary: Withdraw a document that is waiting for signatures
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                reason:
                  type: string
      responses:
        '200':
          description: Voided
          content:
            application/json:
              schema:
                type: object
                properties:
                  ok:
                    type: boolean
        '400':
          $ref: '#/components/responses/Error'
        '401':
          $ref: '#/components/responses/Error'
components:
  schemas:
    Signer:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        email:
          type: string
        order:
          type: integer
        status:
          type: string
        signed_at:
          type:
          - string
          - 'null'
          format: date-time
    CreateDocumentData:
      type: object
      properties:
        title:
          type: string
        message:
          type: string
        sequential:
          type: boolean
          default: false
        send:
          type: boolean
          default: true
        signers:
          type: array
          maxItems: 10
          items:
            $ref: '#/components/schemas/SignerInput'
        fields:
          type: array
          items:
            $ref: '#/components/schemas/FieldInput'
    Document:
      type: object
      properties:
        id:
          type: string
          format: uuid
        title:
          type: string
        status:
          type: string
          enum:
          - draft
          - sent
          - finalizing
          - completed
          - voided
          - declined
        status_reason:
          type:
          - string
          - 'null'
        sequential:
          type: boolean
        pages:
          type: integer
        created_at:
          type: string
          format: date-time
        sent_at:
          type:
          - string
          - 'null'
          format: date-time
        completed_at:
          type:
          - string
          - 'null'
          format: date-time
        original_sha256:
          type:
          - string
          - 'null'
        final_sha256:
          type:
          - string
          - 'null'
        download_url:
          type:
          - string
          - 'null'
          format: uri
        signers:
          type: array
          items:
            $ref: '#/components/schemas/Signer'
    DocumentWithEvents:
      allOf:
      - $ref: '#/components/schemas/Document'
      - type: object
        properties:
          events:
            type: array
            items:
              type: object
              properties:
                type:
                  type: string
                at:
                  type: string
                  format: date-time
                signer_id:
                  type:
                  - string
                  - 'null'
                ip:
                  type:
                  - string
                  - 'null'
    SignerInput:
      type: object
      required:
      - name
      - email
      properties:
        name:
          type: string
        email:
          type: string
          format: email
    FieldInput:
      type: object
      required:
      - signer
      - kind
      - page
      - x
      - y
      - w
      - h
      properties:
        signer:
          type: integer
          minimum: 0
          description: Index into `signers`.
        kind:
          type: string
          enum:
          - signature
          - initials
          - date
          - name
          - email
          - text
          - company
          - title
          - number
          - checkbox
          - dropdown
          - radio
        page:
          type: integer
          minimum: 0
          description: Zero-based page index.
        x:
          type: number
          minimum: 0
          maximum: 1
        y:
          type: number
          minimum: 0
          maximum: 1
        w:
          type: number
          minimum: 0
          maximum: 1
        h:
          type: number
          minimum: 0
          maximum: 1
        required:
          type: boolean
          default: true
        label:
          type: string
        options:
          type: array
          items:
            type: string
          minItems: 2
          maxItems: 20
          description: Required for dropdown and radio.
  responses:
    Error:
      description: Error
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: object
                properties:
                  code:
                    type: string
                    enum:
                    - unauthorized
                    - invalid_request
                    - not_found
                    - not_completed
                    - too_large
                    - conversion_failed
                    - internal
                  message:
                    type: string
  parameters:
    id:
      name: id
      in: path
      required: true
      schema:
        type: string
        format: uuid
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key `es_live_…` from Settings → Developers.
externalDocs:
  description: API guide
  url: https://esignsimple.com/developers