Skip to main content
POST
/
v1
/
persons
Create
curl --request POST \
  --url https://api.cadanapay.com/v1/persons \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "John",
  "lastName": "Doe",
  "email": "<string>",
  "address": {
    "countryCode": "US",
    "line1": "Street 1",
    "line2": "Apt 1",
    "city": "Gotham",
    "postalCode": "10001",
    "state": "NY"
  },
  "compInfo": {
    "type": "net",
    "salary": {
      "amount": 10000,
      "currency": "USD"
    },
    "frequency": "monthly"
  },
  "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"
      }
    ]
  }
}
'
{
  "id": "8ef9a712-cdae-4110-b1ea-9ba95abbee6e"
}

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.

Body

application/json

Create person request payload

​
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

Response

create person response

​
id
string<uuid>
Example:

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