How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Cadana

Cadana Persons API

APIs for interacting with the HR module

Documentation Provider Profile APIs.io OpenAPI GitHub

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

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

This API exposes 14 operations across 11 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 1.0.0.

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

14 operations 11 paths 34 schemas 4 GET4 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Base URL
https://api.cadanapay.com
Authentication
HTTP Bearer
Contact
api@cadanapay.com
License
Apache 2.0
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

Cadana Persons 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 14

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

Persons 14

APIs for interacting with the HR module

GET
/v1/persons/{personId}
Get
getPerson 2 params → 2004045XX
GET
/v1/persons
List
getPersons 4 params → 2004005XX
POST
/v1/persons
Create
createPerson 1 param body → 2004005XX
PUT
/v1/persons/{personId}/basicInfo
Update basic information
updatePersonBasicInfo 2 params body → 2044004045XX
PUT
/v1/persons/{personId}/personalInfo
Update personal information
updatePersonPersonalInfo 2 params body → 2044004045XX
GET
/v1/persons/{personId}/taxProfile
Get tax profile
getPersonTaxProfile 2 params → 2004004045XX
PUT
/v1/persons/{personId}/taxProfile
Update tax profile
updatePersonTaxProfile 2 params body → 2044004045XX
PUT
/v1/persons/{personId}/jobInfo
Update job information
updatePersonJobInfo 2 params body → 2044004045XX
GET
/v1/persons/{personId}/paymentInfo
Get payment information
getPersonPaymentInfo 2 params → 2004045XX
PUT
/v1/persons/{personId}/paymentInfo
Update payment information
updatePersonPaymentInfo 2 params body → 2044004045XX
POST
/v1/persons/{personId}/offboard
Schedule offboarding
scheduleOffboarding 2 params body → 2044004045XX
POST
/v1/persons/{personId}/cancelOffboarding
Cancel offboarding
cancelOffboarding 2 params → 2044004045XX
POST
/v1/persons/{personId}/reinstate
Reinstate
reinstatePerson 2 params → 2044004045XX
PUT
/v1/persons/{personId}/type
Update person type
updatePersonType 2 params body → 2044004045XX

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are bankDetails (15 properties), UpdatePersonPersonalInfoRequest (7 properties), paymentMethods (7 properties), swiftDetails (7 properties). Each schema is shown below with its type and property counts.

jobInfo
object
Person's job information, start date, job title, and employee number
6 properties
NotFoundError
Not Found
bankDetails
object
15 properties
momoDetails
object
5 properties
phoneNumber
object
Person's phone number
2 properties
InternalError
Internal server error
UpdatePersonJobInfoRequest
object
Update person job info request payload
2 properties
CreatePersonRequest
object
Create person request payload
7 properties 6 required
GetPersonTaxProfileResponse
object
1 property
uuid
string
compInfo
object
Person's compensation information, how much will they get paid, currency and frequency
4 properties
NationalID
object
National identification document
3 properties
BadRequestError
Bad input provided by client
beneficiaryId
object
ID details for the beneficiary
2 properties
basicInfo
object
5 properties 3 required
wireDetails
object
Wire transfer payment details
5 properties
UpdatePersonTypeRequest
object
2 properties 1 required
customField
object
3 properties
address
object
Address
6 properties 1 required
UpdatePersonPersonalInfoRequest
object
Update person personal info request payload
7 properties
UpdatePersonBasicInfoRequest
object
Update person basic info request payload
ScheduleOffboardingRequest
object
4 properties 2 required
OffboardingDetails
object
4 properties
paymentMethods
object
7 properties 1 required
meta
object
Meta about the pagination
5 properties
UpdatePersonTaxProfileRequest
object
Update a person's tax profile. The submitted object replaces the person's entire tax profile — it is not a merge, so omitted fields are cleared. Updates are ap…
amount
object
2 properties 2 required
achDetails
object
7 properties
Error
object
2 properties
tags
object
Any custom data you want to store
swiftDetails
object
7 properties 7 required
UpdatePersonPaymentInfoRequest
object
Update person payment info request payload
personEntry
object
1 property
walletDetails
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cadana-persons-api-openapi.yml Raw ↑

Other APIs Cadana publishes across the network.

Cadana Balances API
AE Profile APIs.io
Cadana Beneficiaries API
AE Profile APIs.io
Cadana Businesses API
AE Profile APIs.io
Cadana Contracts API
AE Profile APIs.io
Cadana Custom Auth API
AE Profile APIs.io
Cadana Entities API
AE Profile APIs.io
Cadana Events API
AE Profile APIs.io
Cadana Files API
AE Profile APIs.io
Cadana Filings API
AE Profile APIs.io
Cadana FX API
AE Profile APIs.io
Cadana Instant Pay API
AE Profile APIs.io
Cadana Invoices API
AE Profile APIs.io
#Persons
← Back to C APIs
API Details
ID
cadana:cadana-persons-api
Base URL
https://api.cadanapay.com
Docs
https://docs.cadanapay.com/workforce/overview
Provider
Cadana
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cadana-persons-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cadana-persons-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Cadana Persons API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.