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

Charthop signature-request API

The signature-request API from Charthop — 9 operation(s) for signature-request.

Charthop signature-request API is one of 87 APIs that Charthop publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include signature-request. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 10 operations across 9 paths, and defines 16 schemas. It is described by OpenAPI 2.0, at version V1.0.0.

Requests are made against the base URL https://api.charthop.com.

10 operations 9 paths 16 schemas 6 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 2.0
API Version
V1.0.0
Base URL
https://api.charthop.com
Contact
Resource Areas
1

Paths & Operations 10

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

signature-request 10
GET
/v1/org/{orgId}/signature-request
Return signature requests
findSignatureRequests 8 params → 200400401404
GET
/v1/org/{orgId}/signature-request/file/{fileId}
Retrieve an individual signature request on an existing file
getSignatureRequestForFile 2 params → 200400401404
POST
/v1/org/{orgId}/signature-request/file/{fileId}
Create a new signature request on a file
createSignatureRequestForFile 3 params → 400401404
GET
/v1/org/{orgId}/signature-request/usage
Retrieve current signature request usage for the organization
getSignatureRequestUsage 1 param → 200400401404
GET
/v1/org/{orgId}/signature-request/{id}
Retrieve an individual signature request
getSignatureRequest 2 params → 200400401404
POST
/v1/org/{orgId}/signature-request/{id}/cancel
Cancel an existing signature request
cancelSignatureRequest 2 params → 400401404
POST
/v1/org/{orgId}/signature-request/{id}/decline
Decline to sign a signature request
declineSignatureRequest 3 params → 400401404
GET
/v1/org/{orgId}/signature-request/{id}/external-url
Retrieve an individual signature request's signing URL if using an external service
getSignatureRequestExternalUrl 3 params → 200400401404
POST
/v1/org/{orgId}/signature-request/{id}/sign
Sign a signature request
signSignatureRequest 3 params → 400401404
GET
/v1/org/{orgId}/signature-request/{id}/signature
Retrieve all of the signatures relating to a signature request
findSignaturesOnSignatureRequest 2 params → 200400401404

Schemas 16

The contract defines 16 schemas that model the data the API accepts and returns. The most detailed are SignatureRequest (27 properties), Signature (18 properties), Address (9 properties), SignatureBlock (6 properties). Each schema is shown below with its type and property counts.

AccessAction
object
3 properties 1 required
ResultsAccess
object
2 properties 1 required
SignatureSigner
object
3 properties 3 required
Address
object
9 properties 1 required
CreateSignatureRequestRequest
object
4 properties 1 required
ExternalSignUrlResponse
object
1 property 1 required
ResultsSignature
object
3 properties 1 required
SignatureRequest
object
27 properties 10 required
SignRequest
object
3 properties 1 required
Geopoint
object
2 properties 2 required
MessageChannelConfig
object
2 properties 2 required
Attribution
object
6 properties
SignatureBlock
object
6 properties 6 required
SignatureRequestUsageResponse
object
4 properties 4 required
Signature
object
18 properties 6 required
ResultsSignatureRequest
object
3 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

charthop-signature-request-api-openapi.yml Raw ↑

Other APIs Charthop publishes across the network.

Charthop access API
Charthop action API
Charthop ai API
Charthop ai-credit-limit API
Charthop ai-hint API
Charthop ai-prompt API
Charthop app API
Charthop appConfig API
Charthop approval API
Charthop approval-delegate API
Charthop approval-request API
Charthop assessment API