Deel · Schema

Deel Person

Canonical schema for a unified Deel HRIS person record (IC, EOR, direct employee, Global Payroll).

HRPayrollGlobal PayrollEOREmployer of RecordContractorsHRISATSWorkforceComplianceImmigrationBackground ChecksWebhooksIT

Properties

Name Type Description
id string
first_name string
last_name string
preferred_name string
email string
work_email string
hiring_type string
employment_status string
country string
working_location object
department object
manager object
job_title string
start_date string
external_id string
View JSON Schema on GitHub

JSON Schema

deel-person-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/deel-com/main/json-schema/deel-person-schema.json",
  "title": "Deel Person",
  "description": "Canonical schema for a unified Deel HRIS person record (IC, EOR, direct employee, Global Payroll).",
  "type": "object",
  "required": ["id", "first_name", "last_name", "email", "hiring_type"],
  "properties": {
    "id": { "type": "string" },
    "first_name": { "type": "string" },
    "last_name": { "type": "string" },
    "preferred_name": { "type": "string" },
    "email": { "type": "string", "format": "email" },
    "work_email": { "type": "string", "format": "email" },
    "hiring_type": {
      "type": "string",
      "enum": ["contractor", "eor", "direct_employee", "global_payroll"]
    },
    "employment_status": {
      "type": "string",
      "enum": ["active", "terminated", "onboarding", "offboarded"]
    },
    "country": { "type": "string" },
    "working_location": {
      "type": "object",
      "properties": {
        "country": { "type": "string" },
        "state": { "type": "string" },
        "city": { "type": "string" },
        "address": { "type": "string" },
        "timezone": { "type": "string" }
      }
    },
    "department": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "name": { "type": "string" }
      }
    },
    "manager": {
      "type": "object",
      "properties": {
        "id": { "type": "string" },
        "name": { "type": "string" }
      }
    },
    "job_title": { "type": "string" },
    "start_date": { "type": "string", "format": "date" },
    "external_id": { "type": "string" }
  },
  "additionalProperties": true
}