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

APIs for interacting with employee/contractor Cadana accounts

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

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

This API exposes 12 operations across 10 paths, and defines 23 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.

12 operations 10 paths 23 schemas 1 DELETE6 GET1 PATCH3 POST1 PUT

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 Users 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 12

Across 10 paths, the API surfaces 12 operations — 1 DELETE, 6 GET, 1 PATCH, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 12

APIs for interacting with employee/contractor Cadana accounts

PUT
/v1/users/{userId}/sub
Attach a custom sub
updateUserSubject 2 params body → 2044005XX
POST
/v1/users/admins
Add Admin
addAdminUser 1 param body → 2004005XX
DELETE
/v1/users/admins/{userId}
Remove Admin
removeAdminUser 2 params → 2044045XX
POST
/v1/users/invite
Invite
inviteUser 1 param body → 2004005XX
GET
/v1/users
List
getUsers 6 params → 2004045XX
GET
/v1/users/{userId}
Get
getUser 2 params → 2004045XX
GET
/v1/users/{userId}/kyc
Get KYC
getUserKYC 2 params → 2004045XX
POST
/v1/users/{userId}/kyc
Submit KYC
submitUserKYC 2 params body → 2044004045XX
PATCH
/v1/users/{userId}/kyc
Resubmit KYC
resubmitUserKYC 2 params body → 2044004045XX
GET
/v1/users/{userId}/balances
Get Balances
getUserBalances 2 params → 2004045XX
GET
/v1/users/{userId}/tax-forms
Tax Forms
getUserTaxForms 2 params → 2004045XX
GET
/v1/users/{userId}/tax-forms/{formId}/download
Tax Form Download
getUserTaxFormLink 3 params → 2004045XX

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are IdentityDetails (9 properties), userKyc (7 properties), KYCRequest (7 properties), userBalance (6 properties). Each schema is shown below with its type and property counts.

meta
object
Meta about the pagination
5 properties
kycStatus
string
kyc status
userStatus
string
kyc status
AddAdminUserRequest
object
Add admin user request payload
5 properties 3 required
phoneNumber
object
Person's phone number
2 properties
IdentityDetails
object
9 properties 8 required
PatchKYCRequest
object
Request to resubmit KYC identity and/or address. At least one of identity or address must be provided.
2 properties
InviteUserRequest
object
Invite user request payload
3 properties 1 required
uuid
string
NotFoundError
Not Found
InternalError
Internal server error
KYCRequest
object
7 properties 5 required
userEntry
object
4 properties
BadRequestError
Bad input provided by client
UpdateUserSubjectRequest
object
Update user external token subject payload
1 property 1 required
userKyc
object
7 properties
idDetails
object
2 properties
userBalance
object
6 properties
basicInfo
object
5 properties 3 required
taxForm
object
5 properties
contractFileLink
object
2 properties
address
object
Address
6 properties 1 required
Error
object
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cadana-users-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 Entities API
Cadana Events API
Cadana Files API
Cadana Filings API
Cadana FX API
Cadana Instant Pay API
Cadana Invoices API