Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Certifaction Signing API

Sign files and request signatures

Certifaction Signing API is one of 6 APIs that Certifaction publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Signing. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 9 operations across 9 paths, and defines 7 schemas. It is described by OpenAPI 3.1.0.

Requests are made against a single base URL, {{ .APIServerURL }}.

9 operations 9 paths 7 schemas 2 GET7 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
Base URL
https://api.certifaction.io
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Certifaction Signing API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (api_key). By default, every request must be authenticated.

Paths & Operations 9

Across 9 paths, the API surfaces 9 operations — 2 GET, 7 POST. Each is listed below with its method, path, parameters, and response codes.

Signing 9

Sign files and request signatures

POST
/prepare
Prepare a file for signing
prepare_file 12 params body → 200400401
POST
/sign
Sign a file
sign_file 20 params body → 200400401
POST
/request/create
Request a signature
request_signature 35 params body → 200400401409
POST
/request/cancel
Cancel signature request for signer
cancel_request 2 params body → 204400401403404
POST
/request/cancel/all
Cancel signature requests for file
cancel_request_all 1 param body → 204400401403404
POST
/request/listdeprecated
List signature requests for file
list_requests body → 200400401403404
GET
/request/status
Show status of signature request
request_status 2 params → 200400401403404
GET
/request/file/status
Show status of signature requests of given file
file_requests_status 2 params → 200400401403404
POST
/qes/check
Check account QES status
body → 200400401404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are user (26 properties), identity (14 properties), organization (4 properties). Each schema is shown below with its type and property counts.

identity
object
14 properties 12 required
language
string
organization
object
4 properties 1 required
legal_weight
string
envelope_item_status
string
prepare_scope
string
user
object
26 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

certifaction-signing-api-openapi.yml Raw ↑

Other APIs Certifaction publishes across the network.

Certifaction Account API
Certifaction Documents API
Certifaction Organization API
Certifaction Server API
Certifaction Teamspace API