People & profiles
Create Hris Person
Creates an HRIS employee or contractor with compliance and onboarding records, then sends notification emails and the invite.
Not available to API keys yet. It will need people:write.
curl --request POST \
--url 'https://api.toku.com/hris/create-hris-person' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"givenName": "string",
"familyName": "string",
"email": "user@example.com",
"workEmail": "user@example.com",
"country": "string",
"startDate": "string",
"title": "string",
"department": "string",
"probationEndDate": "string",
"probationClause": "INCLUDE",
"employmentServiceType": "EOR",
"jobDescription": "string",
"baseSalary": "string",
"baseSalaryPaymentType": "FIAT",
"baseSalaryCurrency": "TRY",
"baseSalaryTokenTypeID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"agreementType": "ONGOING",
"workSchedule": "FULL_TIME",
"hoursPerWeek": 0,
"directorStatus": "Director",
"dePriorEmployment": {
"groupEmployment": "YES",
"agencyPlacement": "YES",
"agencyPlacementStart": "string",
"agencyPlacementEnd": "string"
},
"leaseSignatory": {
"name": "string",
"email": "user@example.com"
},
"continuousServiceDate": "string",
"continuousServiceBasis": "TUPE_TRANSFER",
"endDate": "string",
"fixedTermReason": "string",
"visaSupportNeeded": false,
"tokenGrantRequested": false,
"signOnBonusAmount": 0,
"signOnBonusCurrency": "TRY",
"employmentAgreementReview": {
"templateVersionId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"displayHash": "string",
"suggestions": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"templateId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quote": "string",
"start": 0,
"replacement": "string",
"comment": "string",
"decision": "PENDING",
"response": "string"
}
]
},
"usdSalaryConversion": {
"usdAmount": "string",
"rateDate": "string"
}
}'{
"roleInOrgID": "string",
"email": "string",
"fullName": "string",
"inviteHoldReason": "MISSING_EMPLOYMENT_AGREEMENT",
"inviteHoldMessage": "string"
}Authorizations
AuthorizationstringheaderrequiredBearer authentication header of the form Bearer <token>, where <token> is an access token from a Toku sign-in. See Authentication in the API reference.
Body
application/json
givenNamestringrequiredAllowed: at least 1 characters
familyNamestringrequiredAllowed: at least 1 characters
emailstring<email>requiredworkEmailstring<email> | anycountrystringrequiredAllowed: at least 1 characters
startDatestringAllowed: matches ^\d{4}-\d{2}-\d{2}$
titlestringrequiredAllowed: 1 to 200 characters
departmentstringAllowed: at most 200 characters
probationEndDatestringprobationClausestringAvailable options: INCLUDE, REMOVE
employmentTypeanyrequiredemploymentServiceTypestringrequiredAvailable options: EOR, PEO, PAYROLL_ONLY
jobDescriptionstringAllowed: at most 5000 characters
baseSalarystringrequiredbaseSalaryPaymentTypestringAvailable options: FIAT, TOKEN
baseSalaryCurrencystringAvailable options: TRY, ILS, CRC, TTD, SGD, JPY, AUD, NOK, INR, GBP, CHF, RUB, CAD, BRL, NGN, KRW, AED, LBP, EUR, NZD, ZAR, USD, USDC, USDT, USDP, PHP, PLN, RSD, HKD, TWD, AFN, AMD, ANG, AOA, ARS, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BSD, BTN, BWP, BYN, BZD, CDF, CLF, CLP, CNY, COP, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HNL, HRK, HTG, HUF, IDR, IQD, IRR, ISK, JMD, JOD, KES, KGS, KHR, KMF, KPW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NPR, NIO, OMR, PAB, PEN, PGK, PKR, PYG, QAR, RON, RWF, SAR, SBD, SCR, SDG, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, TJS, TMT, TND, TOP, TZS, UAH, UGX, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZMW, SEK, THB
baseSalaryTokenTypeIDstring<uuid>agreementTypestringrequiredAvailable options: ONGOING, FIXED_TERM
Default: "ONGOING"
workSchedulestringAvailable options: FULL_TIME, PART_TIME
hoursPerWeeknumberAllowed: at most 168, greater than 0
directorStatusstringAvailable options: Director, Non-Director
dePriorEmploymentobjectShow child attributes
groupEmploymentstringrequiredAvailable options: YES, NO, NOT_SURE
agencyPlacementstringrequiredAvailable options: YES, NO, NOT_SURE
agencyPlacementStartstringAllowed: matches ^\d{4}-\d{2}-\d{2}$
agencyPlacementEndstringAllowed: matches ^\d{4}-\d{2}-\d{2}$
leaseSignatoryobjectShow child attributes
namestringrequiredAllowed: at least 1 characters
emailstring<email>requiredcontinuousServiceDatestringAllowed: matches ^\d{4}-\d{2}-\d{2}$
continuousServiceBasisstringAvailable options: TUPE_TRANSFER
endDatestringAllowed: matches ^\d{4}-\d{2}-\d{2}$
fixedTermReasonstringAllowed: at most 500 characters
visaSupportNeededbooleanrequiredDefault: false
tokenGrantRequestedbooleanrequiredDefault: false
signOnBonusAmountnumberAllowed: greater than 0
signOnBonusCurrencystringAvailable options: TRY, ILS, CRC, TTD, SGD, JPY, AUD, NOK, INR, GBP, CHF, RUB, CAD, BRL, NGN, KRW, AED, LBP, EUR, NZD, ZAR, USD, USDC, USDT, USDP, PHP, PLN, RSD, HKD, TWD, AFN, AMD, ANG, AOA, ARS, AWG, AZN, BAM, BBD, BDT, BGN, BHD, BIF, BMD, BND, BOB, BSD, BTN, BWP, BYN, BZD, CDF, CLF, CLP, CNY, COP, CUC, CUP, CVE, CZK, DJF, DKK, DOP, DZD, EGP, ERN, ETB, FJD, FKP, GEL, GHS, GIP, GMD, GNF, GTQ, GYD, HNL, HRK, HTG, HUF, IDR, IQD, IRR, ISK, JMD, JOD, KES, KGS, KHR, KMF, KPW, KWD, KYD, KZT, LAK, LKR, LRD, LSL, LYD, MAD, MDL, MGA, MKD, MMK, MNT, MOP, MRU, MUR, MVR, MWK, MXN, MYR, MZN, NAD, NPR, NIO, OMR, PAB, PEN, PGK, PKR, PYG, QAR, RON, RWF, SAR, SBD, SCR, SDG, SHP, SLL, SOS, SRD, SSP, STN, SVC, SYP, SZL, TJS, TMT, TND, TOP, TZS, UAH, UGX, UYU, UZS, VES, VND, VUV, WST, XAF, XCD, XOF, XPF, YER, ZMW, SEK, THB
employmentAgreementReviewobjectShow child attributes
templateVersionIdstring<uuid>requireddisplayHashstringrequiredAllowed: matches ^[a-f0-9]{64}$
suggestionsobject[]requiredAllowed: 1 to 200 items
Show child attributes
idstring<uuid>requiredtemplateIdstring<uuid>requiredquotestringrequiredAllowed: at least 1 characters
startintegerAllowed: at least 0
replacementstring | nullrequiredcommentstringrequiredAllowed: at most 4000 characters
decisionstringrequiredAvailable options: PENDING, APPROVED, REJECTED
responsestringrequiredAllowed: at most 4000 characters
acceptChangeFeeanyrequiredusdSalaryConversionobjectShow child attributes
usdAmountstringrequiredAllowed: matches ^\d+(?:\.\d{1,2})?$
rateDatestringrequiredAllowed: matches ^\d{4}-\d{2}-01$
Response
200Successful response
roleInOrgIDstringrequiredemailstringrequiredfullNamestringrequiredinviteHoldReasonstring | nullrequiredAvailable options: MISSING_EMPLOYMENT_AGREEMENT, null
inviteHoldMessagestring | nullrequired