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 Entities API

APIs for managing legal sub-entities (subsidiaries, branches) under a parent business

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

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

This API exposes 4 operations across 2 paths, and defines 11 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.

4 operations 2 paths 11 schemas 2 GET1 PATCH1 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 Entities 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 4

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

Entities 4

APIs for managing legal sub-entities (subsidiaries, branches) under a parent business

POST
/v1/entities
Create
createEntity 1 param body → 2004005XX
GET
/v1/entities
List
listEntities 1 param → 2005XX
GET
/v1/entities/{entityId}
Get
getEntity 2 params → 2004045XX
PATCH
/v1/entities/{entityId}
Update
updateEntity 2 params body → 2044004045XX

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are GetEntityResponse (14 properties), CreateEntityRequest (9 properties), GetEntitiesResponse (8 properties), UpdateEntityRequest (7 properties). Each schema is shown below with its type and property counts.

GetEntityResponse
object
Full entity details
14 properties
UpdateEntityRequest
object
Update entity request payload (partial update)
7 properties
GetEntitiesResponse
object
Entity summary for list responses
8 properties
CreateEntityResponse
object
Create entity response
1 property
NotFoundError
Not Found
InternalError
Internal server error
address
object
Address
6 properties 1 required
BadRequestError
Bad input provided by client
Error
object
2 properties
CreateEntityRequest
object
Create entity request payload
9 properties 3 required
phoneNumber
object
Person's phone number
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cadana-entities-api-openapi.yml Raw ↑

Other APIs Cadana publishes across the network.

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