Skip to main content
GET
/
v1
/
persons
/
{personId}
Get
curl --request GET \
  --url https://api.cadanapay.com/v1/persons/{personId} \
  --header 'Authorization: Bearer <token>'
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "<string>",
  "address": {
    "countryCode": "US",
    "line1": "Street 1",
    "line2": "Apt 1",
    "city": "Gotham",
    "postalCode": "10001",
    "state": "NY"
  },
  "compInfo": {
    "type": "net",
    "frequency": "monthly",
    "employmentModel": "eor"
  },
  "phoneNumber": {
    "countryCode": "1",
    "number": "2345678901"
  },
  "metadata": {
    "customField1": "value1",
    "customField2": "value2"
  },
  "businessName": "Wayne Enterprise",
  "type": "CONTRACTOR",
  "contractorType": "INDIVIDUAL",
  "jobInfo": {
    "startDate": "2023-01-01",
    "employeeNumber": "1",
    "title": "Software Engineer",
    "department": "Product",
    "customFields": [
      {
        "id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
        "name": "Tshirt Size",
        "value": "M"
      }
    ],
    "entityId": "37ad8c1e-0187-4e10-8c54-395e3385b4d2"
  },
  "id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e",
  "dateOfBirth": "1990-05-15",
  "nationalId": {
    "fullId": "T22084535",
    "suffix": "01",
    "type": "tin"
  },
  "taxId": {
    "fullId": "T22084535",
    "suffix": "01",
    "type": "tin"
  },
  "socialSecurityId": {
    "fullId": "T22084535",
    "suffix": "01",
    "type": "tin"
  },
  "gender": "female",
  "nationality": "DE",
  "offboardingDetails": {
    "exitDate": "2025-06-30",
    "reason": "Voluntary resignation",
    "compensation": {
      "type": "net",
      "frequency": "monthly",
      "employmentModel": "eor"
    },
    "includeInRegularPayroll": true
  }
}

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

Response

get person response

Get person response

​
firstName
string
required

Person's first name

Example:

"John"

​
lastName
string
required

Person's last name

Example:

"Doe"

​
email
string
required

Person's email

​
address
object
required

Address

​
compInfo
object
required

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

​
phoneNumber
object

Person's phone number

​
metadata
object

Optional metadata you can store as key-value pairs

Example:
{
  "customField1": "value1",
  "customField2": "value2"
}
​
businessName
string

Business name, required if contractor type is business

Example:

"Wayne Enterprise"

​
type
enum<string>

Type of the person, we allow contractors and employees

Available options:
EMPLOYEE,
CONTRACTOR
Example:

"CONTRACTOR"

​
contractorType
enum<string>

Type of the contractor, only required if person is a contractor type, we allow individual and business type contractors

Available options:
INDIVIDUAL,
BUSINESS
Example:

"INDIVIDUAL"

​
jobInfo
object

Person's job information, start date, job title, and employee number

​
id
string<uuid>
Example:

"8ef9a712-cdae-4110-b1ea-9ba95abbee6e"

​
dateOfBirth
string<date> | null

Person's date of birth. Only present when set.

Example:

"1990-05-15"

​
nationalId
object

National identification document. Only present when set.

​
taxId
object

Tax identification document. Only present when set.

​
socialSecurityId
object

Social security identification document. Only present when set.

​
gender
enum<string> | null

Person's gender. Only present when set.

Available options:
male,
female,
other
Example:

"female"

​
nationality
string | null

ISO 3166-1 alpha-2 country code. Only present when set.

Example:

"DE"

​
offboardingDetails
object