Formapi

API v1

DocSpring is a service that helps you fill out and sign PDF templates.

AI & machine learning#openapi#text

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

DocSpring is a service that helps you fill out and sign PDF templates.

Endpoints 35

PDF

  • GETTest Authentication/authentication
  • GETGet a list of all combined submissions/combined_submissions?page=2&per_page=1
  • POSTMerge generated PDFs together/combined_submissions
  • GETCheck the status of a combined submission (merged PDFs)/combined_submissions/:combined_submission_id
  • DELETEExpire a combined submission/combined_submissions/:combined_submission_id
  • POSTMerge submission PDFs, template PDFs, or custom files/combined_submissions?v=2
  • POSTCreate a new custom file from a cached presign upload/custom_files
  • GETLook up a submission data request/data_requests/:data_request_id
  • PUTUpdate a submission data request/data_requests/:data_request_id
  • POSTCreates a new data request token for form authentication/data_requests/:data_request_id/tokens
  • GETGet a list of all folders/folders/?parent_folder_id=fld_000000000000000002
  • POSTCreate a folder/folders/
  • DELETEDelete a folder/folders/:folder_id
  • POSTMove a folder/folders/:folder_id/move
  • POSTRename a folder/folders/:folder_id/rename
  • GETList all submissions/submissions?cursor=sub_list_000012&limit=3&created_after=2019-01-01T09:00:00-05:00&created_before=2020-01-01T09:00:00-05:00&type=test&include_data=true
  • POSTGenerates multiple PDFs/submissions/batches
  • GETCheck the status of a submission batch job/submissions/batches/:submission_batch_id?include_submissions=true
  • GETCheck the status of a PDF/submissions/:submission_id?include_data=true
  • DELETEExpire a PDF submission/submissions/:submission_id
  • GETGet a list of all templates/templates?query=2&parent_folder_id=fld_000000000000000001&page=2&per_page=1
  • POSTCreate a new PDF template with a form POST file upload/templates
  • GETCheck the status of an uploaded template/templates/:template_id
  • PUTUpdate a Template/templates/:template_id
  • PUTAdd new fields to a Template/templates/:template_id/add_fields
  • POSTCopy a Template/templates/:template_id/copy
  • POSTMove Template to folder/templates/:template_id/move
  • GETFetch the JSON schema for a template/templates/:template_id/schema
  • GETList all submissions for a given template/templates/:template_id/submissions?cursor=&limit=&created_after=&created_before=&type=&include_data=true
  • POSTGenerates a new PDF/templates/:template_id/submissions
  • POSTGenerates multiple PDFs/templates/:template_id/submissions/batch
  • GETFetch the full template attributes/templates/:template_id?full=true
  • POSTCreate a new PDF template from a cached presign upload/templates?desc=cached_upload
  • POSTCreate a new HTML template/templates?desc=html
  • GETGet a presigned URL so that you can upload a file to our AWS S3 bucket/uploads/presign

API details

Base URL
https://api.docspring.com/api/v1
Authentication
HTTP Basic authentication (username and password)
Operations
35 operations on 27 pathsPOST 15GET 14PUT 3DELETE 3
Main resources
PDF 35
Response formats
application/json
Description format
OpenAPI 3.0.0, API version v1
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the API v1 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the API v1 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses HTTP Basic authentication (username and password). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Test Authentication” (GET /authentication), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the API v1?

DocSpring is a service that helps you fill out and sign PDF templates. It is listed under AI & machine learning and has 35 endpoints.

Who publishes the API v1?

It is listed from Formapi's public API description (an OpenAPI document), not published by Formapi on Swastik Codes. Anyone who controls formapi.io can claim the profile by adding a DNS TXT record.

What is the base URL of the API v1?

Requests go to https://api.docspring.com/api/v1. Endpoint paths are added to this base URL.

How do I authenticate with the API v1?

With HTTP Basic authentication (username and password).

How many endpoints does the API v1 have?

35 operations on 27 paths (15 POST, 14 GET, 3 PUT, 3 DELETE). The largest groups are PDF.

Is forking the API v1 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.