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

APIs for interacting with the HR module

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.0.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.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 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), CreatePersonRequest (7 properties), UpdatePersonPersonalInfoRequest (7 properties), swiftDetails (7 properties). Each schema is shown below with its type and property counts.

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…
meta
object
Meta about the pagination
5 properties
UpdatePersonPersonalInfoRequest
object
Update person personal info request payload
7 properties
swiftDetails
object
7 properties 7 required
phoneNumber
object
Person's phone number
2 properties
NationalID
object
National identification document
3 properties
OffboardingDetails
object
4 properties
uuid
string
NotFoundError
Not Found
walletDetails
object
3 properties
UpdatePersonTypeRequest
object
2 properties 1 required
UpdatePersonBasicInfoRequest
object
Update person basic info request payload
InternalError
Internal server error
ScheduleOffboardingRequest
object
4 properties 2 required
BadRequestError
Bad input provided by client
amount
object
2 properties 2 required
GetPersonTaxProfileResponse
object
1 property
CreatePersonRequest
object
Create person request payload
7 properties 6 required
beneficiaryId
object
ID details for the beneficiary
2 properties
tags
object
Any custom data you want to store
jobInfo
object
Person's job information, start date, job title, and employee number
6 properties
wireDetails
object
Wire transfer payment details
5 properties
paymentMethods
object
7 properties 1 required
bankDetails
object
15 properties
momoDetails
object
5 properties
compInfo
object
Person's compensation information, how much will they get paid, currency and frequency
4 properties
basicInfo
object
5 properties 3 required
UpdatePersonJobInfoRequest
object
Update person job info request payload
2 properties
achDetails
object
7 properties
personEntry
object
1 property
UpdatePersonPaymentInfoRequest
object
Update person payment info request payload
customField
object
3 properties
address
object
Address
6 properties 1 required
Error
object
2 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
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