Skip to main content
POST
/
v1
/
persons
/
{personId}
/
offboard
Schedule offboarding
curl --request POST \
  --url https://api.cadanapay.com/v1/persons/{personId}/offboard \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "exitDate": "2025-06-30",
  "reason": "Voluntary resignation",
  "compensation": {
    "type": "net",
    "frequency": "monthly",
    "employmentModel": "eor"
  },
  "includeInRegularPayroll": true
}
'
{
  "code": "invalid_request_body",
  "message": "The request body provided is not valid",
  "params": {
    "field": "Value is invalid."
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

​
personId
string<uuid>
required

The unique identifier for the person

Body

application/json
​
exitDate
string<date>
required

The date the person will exit the organization

Example:

"2025-06-30"

​
reason
string
required

The reason for offboarding

Example:

"Voluntary resignation"

​
compensation
object

Person's compensation information, how much will they get paid, currency and frequency

​
includeInRegularPayroll
boolean

Whether to include the person in the regular payroll run for their exit period

Example:

true

Response

Offboarding scheduled successfully