Create HRIS Person

Create HRIS person

curl --request POST \
  --url https://app.toku.com/api/tokuApi/v1/createHrisPerson \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-role-type: <x-role-type>' \
  --data '
{
  "givenName": "<string>",
  "familyName": "<string>",
  "email": "[email protected]",
  "country": "<string>",
  "title": "<string>",
  "agreementType": "<string>",
  "citizenship": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "department": "<string>",
  "employmentServiceType": "<string>",
  "jobDescription": "<string>",
  "baseSalary": 123,
  "baseSalaryCurrency": "<string>",
  "endDate": "2023-11-07T05:31:56Z",
  "visaSupportNeeded": true,
  "tokenGrantRequested": true,
  "signOnBonusAmount": 123,
  "signOnBonusCurrency": "<string>",
  "contractorType": "<string>",
  "rateType": "<string>",
  "rateAmount": 123,
  "rateCurrency": "<string>"
}
'

import requests

url = "https://app.toku.com/api/tokuApi/v1/createHrisPerson"

payload = {
    "givenName": "<string>",
    "familyName": "<string>",
    "email": "[email protected]",
    "country": "<string>",
    "title": "<string>",
    "agreementType": "<string>",
    "citizenship": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "department": "<string>",
    "employmentServiceType": "<string>",
    "jobDescription": "<string>",
    "baseSalary": 123,
    "baseSalaryCurrency": "<string>",
    "endDate": "2023-11-07T05:31:56Z",
    "visaSupportNeeded": True,
    "tokenGrantRequested": True,
    "signOnBonusAmount": 123,
    "signOnBonusCurrency": "<string>",
    "contractorType": "<string>",
    "rateType": "<string>",
    "rateAmount": 123,
    "rateCurrency": "<string>"
}
headers = {
    "x-role-type": "<x-role-type>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-role-type': '<x-role-type>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    givenName: '<string>',
    familyName: '<string>',
    email: '[email protected]',
    country: '<string>',
    title: '<string>',
    agreementType: '<string>',
    citizenship: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    department: '<string>',
    employmentServiceType: '<string>',
    jobDescription: '<string>',
    baseSalary: 123,
    baseSalaryCurrency: '<string>',
    endDate: '2023-11-07T05:31:56Z',
    visaSupportNeeded: true,
    tokenGrantRequested: true,
    signOnBonusAmount: 123,
    signOnBonusCurrency: '<string>',
    contractorType: '<string>',
    rateType: '<string>',
    rateAmount: 123,
    rateCurrency: '<string>'
  })
};

fetch('https://app.toku.com/api/tokuApi/v1/createHrisPerson', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.toku.com/api/tokuApi/v1/createHrisPerson",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'givenName' => '<string>',
    'familyName' => '<string>',
    'email' => '[email protected]',
    'country' => '<string>',
    'title' => '<string>',
    'agreementType' => '<string>',
    'citizenship' => '<string>',
    'startDate' => '2023-11-07T05:31:56Z',
    'department' => '<string>',
    'employmentServiceType' => '<string>',
    'jobDescription' => '<string>',
    'baseSalary' => 123,
    'baseSalaryCurrency' => '<string>',
    'endDate' => '2023-11-07T05:31:56Z',
    'visaSupportNeeded' => true,
    'tokenGrantRequested' => true,
    'signOnBonusAmount' => 123,
    'signOnBonusCurrency' => '<string>',
    'contractorType' => '<string>',
    'rateType' => '<string>',
    'rateAmount' => 123,
    'rateCurrency' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-role-type: <x-role-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.toku.com/api/tokuApi/v1/createHrisPerson"

	payload := strings.NewReader("{\n  \"givenName\": \"<string>\",\n  \"familyName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"country\": \"<string>\",\n  \"title\": \"<string>\",\n  \"agreementType\": \"<string>\",\n  \"citizenship\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"department\": \"<string>\",\n  \"employmentServiceType\": \"<string>\",\n  \"jobDescription\": \"<string>\",\n  \"baseSalary\": 123,\n  \"baseSalaryCurrency\": \"<string>\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"visaSupportNeeded\": true,\n  \"tokenGrantRequested\": true,\n  \"signOnBonusAmount\": 123,\n  \"signOnBonusCurrency\": \"<string>\",\n  \"contractorType\": \"<string>\",\n  \"rateType\": \"<string>\",\n  \"rateAmount\": 123,\n  \"rateCurrency\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-role-type", "<x-role-type>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.toku.com/api/tokuApi/v1/createHrisPerson")
  .header("x-role-type", "<x-role-type>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"givenName\": \"<string>\",\n  \"familyName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"country\": \"<string>\",\n  \"title\": \"<string>\",\n  \"agreementType\": \"<string>\",\n  \"citizenship\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"department\": \"<string>\",\n  \"employmentServiceType\": \"<string>\",\n  \"jobDescription\": \"<string>\",\n  \"baseSalary\": 123,\n  \"baseSalaryCurrency\": \"<string>\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"visaSupportNeeded\": true,\n  \"tokenGrantRequested\": true,\n  \"signOnBonusAmount\": 123,\n  \"signOnBonusCurrency\": \"<string>\",\n  \"contractorType\": \"<string>\",\n  \"rateType\": \"<string>\",\n  \"rateAmount\": 123,\n  \"rateCurrency\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.toku.com/api/tokuApi/v1/createHrisPerson")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-role-type"] = '<x-role-type>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"givenName\": \"<string>\",\n  \"familyName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"country\": \"<string>\",\n  \"title\": \"<string>\",\n  \"agreementType\": \"<string>\",\n  \"citizenship\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"department\": \"<string>\",\n  \"employmentServiceType\": \"<string>\",\n  \"jobDescription\": \"<string>\",\n  \"baseSalary\": 123,\n  \"baseSalaryCurrency\": \"<string>\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"visaSupportNeeded\": true,\n  \"tokenGrantRequested\": true,\n  \"signOnBonusAmount\": 123,\n  \"signOnBonusCurrency\": \"<string>\",\n  \"contractorType\": \"<string>\",\n  \"rateType\": \"<string>\",\n  \"rateAmount\": 123,\n  \"rateCurrency\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "roleInOrgID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "[email protected]",
  "fullName": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

POST

createHrisPerson

Create HRIS person

curl --request POST \
  --url https://app.toku.com/api/tokuApi/v1/createHrisPerson \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-role-type: <x-role-type>' \
  --data '
{
  "givenName": "<string>",
  "familyName": "<string>",
  "email": "[email protected]",
  "country": "<string>",
  "title": "<string>",
  "agreementType": "<string>",
  "citizenship": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "department": "<string>",
  "employmentServiceType": "<string>",
  "jobDescription": "<string>",
  "baseSalary": 123,
  "baseSalaryCurrency": "<string>",
  "endDate": "2023-11-07T05:31:56Z",
  "visaSupportNeeded": true,
  "tokenGrantRequested": true,
  "signOnBonusAmount": 123,
  "signOnBonusCurrency": "<string>",
  "contractorType": "<string>",
  "rateType": "<string>",
  "rateAmount": 123,
  "rateCurrency": "<string>"
}
'

import requests

url = "https://app.toku.com/api/tokuApi/v1/createHrisPerson"

payload = {
    "givenName": "<string>",
    "familyName": "<string>",
    "email": "[email protected]",
    "country": "<string>",
    "title": "<string>",
    "agreementType": "<string>",
    "citizenship": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "department": "<string>",
    "employmentServiceType": "<string>",
    "jobDescription": "<string>",
    "baseSalary": 123,
    "baseSalaryCurrency": "<string>",
    "endDate": "2023-11-07T05:31:56Z",
    "visaSupportNeeded": True,
    "tokenGrantRequested": True,
    "signOnBonusAmount": 123,
    "signOnBonusCurrency": "<string>",
    "contractorType": "<string>",
    "rateType": "<string>",
    "rateAmount": 123,
    "rateCurrency": "<string>"
}
headers = {
    "x-role-type": "<x-role-type>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-role-type': '<x-role-type>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    givenName: '<string>',
    familyName: '<string>',
    email: '[email protected]',
    country: '<string>',
    title: '<string>',
    agreementType: '<string>',
    citizenship: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    department: '<string>',
    employmentServiceType: '<string>',
    jobDescription: '<string>',
    baseSalary: 123,
    baseSalaryCurrency: '<string>',
    endDate: '2023-11-07T05:31:56Z',
    visaSupportNeeded: true,
    tokenGrantRequested: true,
    signOnBonusAmount: 123,
    signOnBonusCurrency: '<string>',
    contractorType: '<string>',
    rateType: '<string>',
    rateAmount: 123,
    rateCurrency: '<string>'
  })
};

fetch('https://app.toku.com/api/tokuApi/v1/createHrisPerson', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.toku.com/api/tokuApi/v1/createHrisPerson",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'givenName' => '<string>',
    'familyName' => '<string>',
    'email' => '[email protected]',
    'country' => '<string>',
    'title' => '<string>',
    'agreementType' => '<string>',
    'citizenship' => '<string>',
    'startDate' => '2023-11-07T05:31:56Z',
    'department' => '<string>',
    'employmentServiceType' => '<string>',
    'jobDescription' => '<string>',
    'baseSalary' => 123,
    'baseSalaryCurrency' => '<string>',
    'endDate' => '2023-11-07T05:31:56Z',
    'visaSupportNeeded' => true,
    'tokenGrantRequested' => true,
    'signOnBonusAmount' => 123,
    'signOnBonusCurrency' => '<string>',
    'contractorType' => '<string>',
    'rateType' => '<string>',
    'rateAmount' => 123,
    'rateCurrency' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-role-type: <x-role-type>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.toku.com/api/tokuApi/v1/createHrisPerson"

	payload := strings.NewReader("{\n  \"givenName\": \"<string>\",\n  \"familyName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"country\": \"<string>\",\n  \"title\": \"<string>\",\n  \"agreementType\": \"<string>\",\n  \"citizenship\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"department\": \"<string>\",\n  \"employmentServiceType\": \"<string>\",\n  \"jobDescription\": \"<string>\",\n  \"baseSalary\": 123,\n  \"baseSalaryCurrency\": \"<string>\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"visaSupportNeeded\": true,\n  \"tokenGrantRequested\": true,\n  \"signOnBonusAmount\": 123,\n  \"signOnBonusCurrency\": \"<string>\",\n  \"contractorType\": \"<string>\",\n  \"rateType\": \"<string>\",\n  \"rateAmount\": 123,\n  \"rateCurrency\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-role-type", "<x-role-type>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.toku.com/api/tokuApi/v1/createHrisPerson")
  .header("x-role-type", "<x-role-type>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"givenName\": \"<string>\",\n  \"familyName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"country\": \"<string>\",\n  \"title\": \"<string>\",\n  \"agreementType\": \"<string>\",\n  \"citizenship\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"department\": \"<string>\",\n  \"employmentServiceType\": \"<string>\",\n  \"jobDescription\": \"<string>\",\n  \"baseSalary\": 123,\n  \"baseSalaryCurrency\": \"<string>\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"visaSupportNeeded\": true,\n  \"tokenGrantRequested\": true,\n  \"signOnBonusAmount\": 123,\n  \"signOnBonusCurrency\": \"<string>\",\n  \"contractorType\": \"<string>\",\n  \"rateType\": \"<string>\",\n  \"rateAmount\": 123,\n  \"rateCurrency\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.toku.com/api/tokuApi/v1/createHrisPerson")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-role-type"] = '<x-role-type>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"givenName\": \"<string>\",\n  \"familyName\": \"<string>\",\n  \"email\": \"[email protected]\",\n  \"country\": \"<string>\",\n  \"title\": \"<string>\",\n  \"agreementType\": \"<string>\",\n  \"citizenship\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"department\": \"<string>\",\n  \"employmentServiceType\": \"<string>\",\n  \"jobDescription\": \"<string>\",\n  \"baseSalary\": 123,\n  \"baseSalaryCurrency\": \"<string>\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"visaSupportNeeded\": true,\n  \"tokenGrantRequested\": true,\n  \"signOnBonusAmount\": 123,\n  \"signOnBonusCurrency\": \"<string>\",\n  \"contractorType\": \"<string>\",\n  \"rateType\": \"<string>\",\n  \"rateAmount\": 123,\n  \"rateCurrency\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "roleInOrgID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "email": "[email protected]",
  "fullName": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

Authorizations

Authorization

string

header

required

Personal API token. Create via createUserApiToken endpoint.

Headers

x-role-type

enum<string>

required

Role context for the request. Use CLIENT_ORG_ADMIN for most integrations.

Available options:

CLIENT_ORG_ADMIN,

PAYROLL_ADMIN,

FINANCE_ADMIN,

TOKU_ADMIN

Body

application/json

employmentType

enum<string>

required

Employment type discriminator

Available options:

EMPLOYEE,

CONTRACTOR

givenName

string

required

Given name

familyName

string

required

Family name

string<email>

required

Work email address

country

string

required

Country of employment

title

string

required

Job title

agreementType

string

required

Agreement type

citizenship

string | null

Citizenship country code

startDate

string<date-time> | null

Start date

department

string | null

Department name

employmentServiceType

string | null

EOR employment service type

jobDescription

string | null

Job description

baseSalary

number | null

Base salary amount

baseSalaryCurrency

string | null

Base salary currency code

endDate

string<date-time> | null

End date

visaSupportNeeded

boolean | null

Whether visa support is needed

tokenGrantRequested

boolean | null

Whether a token grant was requested

signOnBonusAmount

number | null

Sign-on bonus amount

signOnBonusCurrency

string | null

Sign-on bonus currency code

contractorType

string | null

Contractor classification

rateType

string | null

Contractor rate type

rateAmount

number | null

Contractor rate amount

rateCurrency

string | null

Contractor rate currency code

Response

Successful response

roleInOrgID

string<uuid>

required

Created role-in-org identifier

string<email>

required

fullName

string

required

Created full name

⌘I