Employee Data Models

Here are the different models you can subscribe to while doing a sync.

Model IDEvent Data KeyDescription
employee_profileprofileGet profile data of an employee like first and last names, date of birth, work email, termination date, hire date, etc.
employee_contactInfocontactInfoGet personal contact details of an employee like personal emails and phone numbers
employee_orgStructureorgStructureGet hierarchical data related to an employee like employee's manager, department and designation.
employee_dependentdependentsGet family members' data for an employee.
employee_locationlocationsGet work and home addresses of an employee.
employee_bankAccountbankAccountsGet an employee's bank account details
employee_kycDocumentsemployeeKYCGet an employee's KYC documents
employee_identificationemployeeIdentificationDataGet an employee's identification details
employee_profilePictureemployeeProfilePictureGet an employee's Profile Picture
employee_rawValuesrawValuesGet the raw values of enum fields like employmentStatus, employmentType, maritalStatus, gender
custom_fieldscustomFieldsEdit Field Mappings from the Knit dashboard to get custom fields

All these models have been detailed out below for your reference.

📘

Use the Model ID for syncs

While invoking sync APIs, pass these model IDs in order to get the desired data. Make sure the dataTypein sync request body is employee

Employee Profile

Model ID: employee_profile

NameTypeDescription
firstNameString
lastNameString
idStringUnique ID of the employee as seen in origin system
workEmailStringThe official email of an employee.
startDateDateThe first day of an employee at the organization.
birthDateDateDate of birth of the employee
terminationDateDateLast working day of an employee
employmentStatusEnumOne of
ACTIVE
INACTIVE
NOT_SPECIFIED
maritalStatusEnumOne of
MARRIED
SINGLE,
WIDOWED,
SEPARATED,
NOT_SPECIFIED
genderEnumOne of
MALE
FEMALE
NOT_SPECIFIED
NON_BINARY
employmentTypeEnumOne of
FULL_TIME
PART_TIME
CONTRACT
NOT_SPECIFIED

Employee Contact Info

Model ID: employee_contactInfo

NameTypeDescription
personalEmailsList[String]
phonesList[Phone]

Phone

NameTypeDescription
typeEnumOne of
WORK,
PERSONAL,
HOME,
NOT_SPECIFIED
numberString

Employee Org Structure

Model ID: employee_orgStructure

NameTypeDescription
designationStringJob title of the employee
departmentString
managerEmployee ManagerThe manager of the employee

Employee Manager

NameTypeDescription
idStringEmployee's manager's employee id in origin app
workEmailStringEmployee's manager's work email in origin app

Employee Dependents

Model ID: employee_dependent

NameTypeDescription
dependentsList[Employee Dependent]

Employee Dependent

NameTypeDescription
idStringDependent Id
firstNameStringDependent's first name
lastNameStringDependent's last name
relationEnumPossible values are
NOT_SPECIFIED,
FATHER,
MOTHER,
CHILD,
SIBLING,
SPOUSE,
OTHER
birthDateISO TimestampDependent's date of birth, Eg: 2020-10-11T00:00:00Z

Employee Locations

Model ID: employee_location

NameTypeDescription
workAddressEmployee LocationWork location
permanentAddressEmployee LocationPermanent residential address
presentAddressEmployee LocationPresent residential address

Employee Location

NameTypeDescription
addressLine1String
addressLine2String
cityString
stateString
countryEnumAlpha 2 code, Refer https://www.iban.com/country-codes or else country field in origin data
zipCodeString
addressTypeEnumOne of
WORK
HOME_PRESENT
HOME_PERMANENT

Employee Bank Accounts

Model ID: employee_bankAccount

NameTitleDescription
bankAccountsList[Bank Account]

Bank Account

NameTypeDescription
accountNumberString
accountTypeEnumOne of
SAVINGS,
CURRENT,
CHECKING,
NOT_SPECIFIED
bankNameString
routingInfoList[Routing Info]

Routing Info

NameTypeDescription
typeEnumOne of
ROUTING_NUMBER,
IBAN,
SWIFT_CODE,
IFSC_CODE,
BANK_IDENTIFICATION_CODE,
BRANCH_CODE
numberString

Employee KYC Details

Model ID: employee_kycDocuments

NameTypeDescription
aadharNumberString
aadharURLString
panNumberString
panURLString

Employee Identification Details

Model ID: employee_identification

NameTypeDescription
employeeIdentificationDataList[ID Data]

ID Data

NameTypeDescription
typeEnumOne of
NATIONAL_ID,
LICENSE,
PASSPORT,
OTHERS,
NOT_SPECIFIED
subTypeStringEg, SSN, ITIN
identificationNumberString

Employee Profile Picture

Model ID: employee_profilePicture

NameTypeDescription
pictureNameString
pictureURLString

Employee Raw Values

Model ID: employee_rawValues

NameTypeDescription
profileProfile Raw Values

Profile Raw Values

NameTypeDescription
employmentStatusString
maritalStatusString
genderString
employmentTypeString

Custom Fields

Model ID: custom_fields

Edit Field Mappings from the Knit dashboard for each integrated account to get unmapped fields

NameTypeDescription
fieldsMap<String, Object>

Event Data Example

{
  "profile": {
    "firstName": "0XcrE7zm5UMipuT",
    "lastName": "twkFD16f8q4D2R7",
    "id": "omLAR353IjXZ4Mt",
    "workEmail": "[email protected]",
    "startDate": "1970-01-01T00:00:00Z",
    "birthDate": "1970-01-01T00:00:00Z",
    "terminationDate": "1970-01-01T00:00:00Z",
    "employmentStatus": "ACTIVE",
    "maritalStatus": "SINGLE",
    "gender": "MALE",
    "employmentType": "FULL_TIME"
  },
  "contactInfo": {
    "personalEmails": [
      "[email protected]",
      "[email protected]"
    ],
    "phones": [
      {
        "type": "PERSONAL",
        "number": "564-871-1385"
      }
    ]
  },
  "orgStructure": {
    "designation": "m7Vv4fhvVpoGvM0",
    "department": "kLkUPMpzsCEErbt",
    "manager": {
      "id": "RALpFjOQBAjCozi",
      "workEmail": "[email protected]"
    }
  },
  "locations": {
    "workAddress": {
      "addressLine1": "jHvul9kxXMmpGsa",
      "addressLine2": "ZRZEUuGtghgY9bx",
      "city": "Bengaluru",
      "state": "KA",
      "country": "IN",
      "zipCode": "560016",
      "addressType": "WORK"
    },
    "permanentAddress": null,
    "presentAddress": null
  },
  "dependents": [
    {
      "id": "iaNR6Abj8qksGTe",
      "firstName": "cQxqiWWVLMhMDsO",
      "lastName": "lCnk39U3TUCC38t",
      "birthDate": "1970-01-01T00:00:00Z",
      "relation": "FATHER"
    },
    {
      "id": "nVtWLlJluoG6CgL",
      "firstName": "gCRiIxi1aSTyEkd",
      "lastName": "HMfoPrjy4dGyxiJ",
      "birthDate": "1970-01-01T00:00:00Z",
      "relation": "MOTHER"
    }
  ],
  "bankAccounts": [
    {
      "accountNumber": "ROY12486516AS",
      "accountType": "SAVINGS",
      "bankName": "Waystar Roy Bank",
      "routingInfo": [
        {
          "type": "IFSC_CODE",
          "number": "AIDN309301034"
        },
        {
          "type": "BRANCH_CODE",
          "number": "AIDN"
        }
      ]
    },
    {
      "accountNumber": "548493043F903J",
      "accountType": "Chekcing",
      "bankName": "Gold Star Bank",
      "routingInfo": [
        {
          "type": "BANK_IDENTIFICATION_CODE",
          "number": "GSBK302K0140EW"
        }
      ]
    }
  ],
  "employeeKYC": {
    "aadharNumber": "46743545",
    "aadharURL": "link.com/aadhar",
    "panNumber": "PED5663",
    "panURL": "link.com/pan"
  },
  "employeeIdentificationData": [
    {
      "type": "NATIONAL_ID",
      "subType": "SSN",
      "identificationNumber": "RIDOFJSIDJF"
    }
  ],
  "employeeProfilePicture": {
    "pictureName": "avatar.jpg",
    "pictureURL": "link.com/picture"
  },
  "customFields": {
    "fields": {
      "unmappedFieldKey": "value"
    }
  },
  "rawValues": {
    "profile": {
      "employmentStatus": "Probation",
      "maritalStatus": "single",
      "gender": "male",
      "employmentType": "full time"
    }
  }
}