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

Cadana Contracts API

APIs for interacting with contracts

Cadana Contracts API is one of 30 APIs that Cadana publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 6 operations across 5 paths, and defines 12 schemas. It is described by OpenAPI 3.0.0, at version 1.0.0.

Requests are made against 2 base URLs: https://api.cadanapay.com, https://dev-api.cadanapay.com.

6 operations 5 paths 12 schemas 4 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
1.0.0
Base URL
https://api.cadanapay.com
Authentication
HTTP Bearer
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Cadana Contracts API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (API_SECRET_KEY) (Authorization). By default, every request must be authenticated.

Paths & Operations 6

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

Contracts 6

APIs for interacting with contracts

GET
/v1/contract-templates
List Templates
retrieveContractTemplates 1 param → 200400
GET
/v1/contracts
List
retrieveContracts 2 params → 200400
POST
/v1/contracts
Create
createContracts 1 param body → 200400
GET
/v1/contracts/{contractId}
Retrieve
retrieveContract 3 params → 200404
GET
/v1/contracts/{contractId}/signingUrl
Signing URL
getContractSigningUrl 3 params → 200500
POST
/v1/contracts-upload
Upload Contract
uploadContract 1 param body → 200400

Schemas 12

The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are contractTemplate (10 properties), contract (8 properties), contractSignature (7 properties), templateVariable (6 properties). Each schema is shown below with its type and property counts.

signer
object
2 properties
contractSignature
object
7 properties
UploadContractRequest
object
3 properties 3 required
uuid
string
NotFoundError
Not Found
InternalError
Internal server error
BadRequestError
Bad input provided by client
contract
object
8 properties
contractTemplate
object
10 properties
CreateContractRequest
object
4 properties 3 required
templateVariable
object
6 properties
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cadana-contracts-api-openapi.yml Raw ↑

Other APIs Cadana publishes across the network.

Cadana Balances API
Cadana Beneficiaries API
Cadana Businesses API
Cadana Custom Auth API
Cadana Entities API
Cadana Events API
Cadana Files API
Cadana Filings API
Cadana FX API
Cadana Instant Pay API
Cadana Invoices API
Cadana Jurisdictions API