Public Create Employee
curl --request POST \
--url https://public-api.salu.com.vc/dev/routes/v0/employee/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"gov_id": "<string>",
"is_disabled": true,
"admission_date": "2023-12-25",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"social_name": "<string>",
"birth_date": "2023-12-25",
"mother_name": "<string>",
"place_of_birth": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"hr_code": "<string>",
"e_social": "<string>",
"employee_registration_number": "<string>",
"e_social_category": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"create_exam": true,
"send_email": false,
"send_date": "2023-11-07T05:31:56Z",
"disability_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://public-api.salu.com.vc/dev/routes/v0/employee/"
payload = {
"name": "<string>",
"gov_id": "<string>",
"is_disabled": True,
"admission_date": "2023-12-25",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"social_name": "<string>",
"birth_date": "2023-12-25",
"mother_name": "<string>",
"place_of_birth": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"hr_code": "<string>",
"e_social": "<string>",
"employee_registration_number": "<string>",
"e_social_category": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"create_exam": True,
"send_email": False,
"send_date": "2023-11-07T05:31:56Z",
"disability_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
gov_id: '<string>',
is_disabled: true,
admission_date: '2023-12-25',
organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
branch_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
position_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sector_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
address: '<string>',
address_number: '<string>',
address_detail: '<string>',
zip_code: '<string>',
neighborhood: '<string>',
state: '<string>',
city: '<string>',
social_name: '<string>',
birth_date: '2023-12-25',
mother_name: '<string>',
place_of_birth: '<string>',
phone: '<string>',
cell_phone: '<string>',
email: '<string>',
personal_email: '<string>',
hr_code: '<string>',
e_social: '<string>',
employee_registration_number: '<string>',
e_social_category: '<string>',
work_shift: '<string>',
client_integration_code: '<string>',
create_exam: true,
send_email: false,
send_date: '2023-11-07T05:31:56Z',
disability_analysis_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://public-api.salu.com.vc/dev/routes/v0/employee/', 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://public-api.salu.com.vc/dev/routes/v0/employee/",
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([
'name' => '<string>',
'gov_id' => '<string>',
'is_disabled' => true,
'admission_date' => '2023-12-25',
'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'branch_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'position_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sector_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'address' => '<string>',
'address_number' => '<string>',
'address_detail' => '<string>',
'zip_code' => '<string>',
'neighborhood' => '<string>',
'state' => '<string>',
'city' => '<string>',
'social_name' => '<string>',
'birth_date' => '2023-12-25',
'mother_name' => '<string>',
'place_of_birth' => '<string>',
'phone' => '<string>',
'cell_phone' => '<string>',
'email' => '<string>',
'personal_email' => '<string>',
'hr_code' => '<string>',
'e_social' => '<string>',
'employee_registration_number' => '<string>',
'e_social_category' => '<string>',
'work_shift' => '<string>',
'client_integration_code' => '<string>',
'create_exam' => true,
'send_email' => false,
'send_date' => '2023-11-07T05:31:56Z',
'disability_analysis_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://public-api.salu.com.vc/dev/routes/v0/employee/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://public-api.salu.com.vc/dev/routes/v0/employee/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.salu.com.vc/dev/routes/v0/employee/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"is_disabled": true,
"status": "<string>",
"sex": "<string>",
"admission_date": "2023-12-25",
"is_active": true,
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"branch": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"position": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"sector": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"social_name": "<string>",
"gov_id": "<string>",
"birth_date": "2023-12-25",
"gender": "<string>",
"mother_name": "<string>",
"marital_status": "<string>",
"place_of_birth": "<string>",
"educational_stage": "<string>",
"human_skin_tone": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"dismissal_date": "2023-12-25",
"hr_code": "<string>",
"employee_registration_number": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"address": {
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Employees
Create Employee
POST
/
v0
/
employee
/
Public Create Employee
curl --request POST \
--url https://public-api.salu.com.vc/dev/routes/v0/employee/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"gov_id": "<string>",
"is_disabled": true,
"admission_date": "2023-12-25",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"social_name": "<string>",
"birth_date": "2023-12-25",
"mother_name": "<string>",
"place_of_birth": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"hr_code": "<string>",
"e_social": "<string>",
"employee_registration_number": "<string>",
"e_social_category": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"create_exam": true,
"send_email": false,
"send_date": "2023-11-07T05:31:56Z",
"disability_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'import requests
url = "https://public-api.salu.com.vc/dev/routes/v0/employee/"
payload = {
"name": "<string>",
"gov_id": "<string>",
"is_disabled": True,
"admission_date": "2023-12-25",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"branch_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"position_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sector_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"social_name": "<string>",
"birth_date": "2023-12-25",
"mother_name": "<string>",
"place_of_birth": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"hr_code": "<string>",
"e_social": "<string>",
"employee_registration_number": "<string>",
"e_social_category": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"create_exam": True,
"send_email": False,
"send_date": "2023-11-07T05:31:56Z",
"disability_analysis_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
gov_id: '<string>',
is_disabled: true,
admission_date: '2023-12-25',
organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
branch_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
position_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
sector_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
address: '<string>',
address_number: '<string>',
address_detail: '<string>',
zip_code: '<string>',
neighborhood: '<string>',
state: '<string>',
city: '<string>',
social_name: '<string>',
birth_date: '2023-12-25',
mother_name: '<string>',
place_of_birth: '<string>',
phone: '<string>',
cell_phone: '<string>',
email: '<string>',
personal_email: '<string>',
hr_code: '<string>',
e_social: '<string>',
employee_registration_number: '<string>',
e_social_category: '<string>',
work_shift: '<string>',
client_integration_code: '<string>',
create_exam: true,
send_email: false,
send_date: '2023-11-07T05:31:56Z',
disability_analysis_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
})
};
fetch('https://public-api.salu.com.vc/dev/routes/v0/employee/', 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://public-api.salu.com.vc/dev/routes/v0/employee/",
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([
'name' => '<string>',
'gov_id' => '<string>',
'is_disabled' => true,
'admission_date' => '2023-12-25',
'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'branch_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'position_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'sector_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'address' => '<string>',
'address_number' => '<string>',
'address_detail' => '<string>',
'zip_code' => '<string>',
'neighborhood' => '<string>',
'state' => '<string>',
'city' => '<string>',
'social_name' => '<string>',
'birth_date' => '2023-12-25',
'mother_name' => '<string>',
'place_of_birth' => '<string>',
'phone' => '<string>',
'cell_phone' => '<string>',
'email' => '<string>',
'personal_email' => '<string>',
'hr_code' => '<string>',
'e_social' => '<string>',
'employee_registration_number' => '<string>',
'e_social_category' => '<string>',
'work_shift' => '<string>',
'client_integration_code' => '<string>',
'create_exam' => true,
'send_email' => false,
'send_date' => '2023-11-07T05:31:56Z',
'disability_analysis_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://public-api.salu.com.vc/dev/routes/v0/employee/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://public-api.salu.com.vc/dev/routes/v0/employee/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.salu.com.vc/dev/routes/v0/employee/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"gov_id\": \"<string>\",\n \"is_disabled\": true,\n \"admission_date\": \"2023-12-25\",\n \"organization_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"branch_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"position_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"sector_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"address\": \"<string>\",\n \"address_number\": \"<string>\",\n \"address_detail\": \"<string>\",\n \"zip_code\": \"<string>\",\n \"neighborhood\": \"<string>\",\n \"state\": \"<string>\",\n \"city\": \"<string>\",\n \"social_name\": \"<string>\",\n \"birth_date\": \"2023-12-25\",\n \"mother_name\": \"<string>\",\n \"place_of_birth\": \"<string>\",\n \"phone\": \"<string>\",\n \"cell_phone\": \"<string>\",\n \"email\": \"<string>\",\n \"personal_email\": \"<string>\",\n \"hr_code\": \"<string>\",\n \"e_social\": \"<string>\",\n \"employee_registration_number\": \"<string>\",\n \"e_social_category\": \"<string>\",\n \"work_shift\": \"<string>\",\n \"client_integration_code\": \"<string>\",\n \"create_exam\": true,\n \"send_email\": false,\n \"send_date\": \"2023-11-07T05:31:56Z\",\n \"disability_analysis_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"is_disabled": true,
"status": "<string>",
"sex": "<string>",
"admission_date": "2023-12-25",
"is_active": true,
"organization": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"branch": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"position": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"sector": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"social_name": "<string>",
"gov_id": "<string>",
"birth_date": "2023-12-25",
"gender": "<string>",
"mother_name": "<string>",
"marital_status": "<string>",
"place_of_birth": "<string>",
"educational_stage": "<string>",
"human_skin_tone": "<string>",
"phone": "<string>",
"cell_phone": "<string>",
"email": "<string>",
"personal_email": "<string>",
"dismissal_date": "2023-12-25",
"hr_code": "<string>",
"employee_registration_number": "<string>",
"work_shift": "<string>",
"client_integration_code": "<string>",
"address": {
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Creates a new employee in your organization.
create_exam(boolean): whentrue, a pre-employment (hiring) medical exam will be created for the employee right after creation.send_email(boolean): whentrue, the employee will receive an email notification about the exam.send_date(date-time, optional): the date/time when the notification should be sent. Ifsend_email=trueandsend_dateis empty or null, the current date/time will be used to trigger the notification.
- Field:
send_date - Accepted format: ISO 8601 (UTC when applicable)
- Valid examples:
-
2025-01-31T00:00:00Z -
2025-01-31 00:00:00
-
Overview
Fields
| Field | Description |
|---|---|
gov_id (CPF) | Person / Employee identifier In Brazil, every individual has a CPF (Cadastro de Pessoa Física), which is the national taxpayer ID for a person. It’s unique per person and typically does not change. In our API we expose it as gov_id. In practice, it plays a role similar to SSN (US) or a national personal tax ID in other countries. Key point: gov_id identifies the human being, not the employment relationship. |
hr_code | “Matrícula RH” (internal company HR ID) — optional hr_code corresponds to Matrícula RH, which is an internal employee code created by the company for HR/payroll/admin systems. Optional (not required by law). Used for internal controls and integrations with the company’s HRIS/payroll tools. Can vary by company and can change if the company migrates systems. Think of it as a typical Employee ID inside an organization. |
employee_registration_number | “Matrícula eSocial” (government employment link ID) — required (when applicable) employee_registration_number corresponds to Matrícula eSocial, which is an official identifier tied to the formal employment relationship under Brazilian labor law (CLT). Mandatory by law for formal employment reporting (eSocial). It is unique per employment relationship (per “job link”), not necessarily per person for life. It may not be available at onboarding, because it’s usually assigned/confirmed only after payroll/accounting formally registers the employee, including the CTPS registration. Important nuance: A person ( gov_id) can exist in the system before the Matrícula eSocial is known. Once the employment is formalized, employee_registration_number becomes the official “government-side” reference for that employment link. |
- Method:
POST - Path:
/v0/employee/ - OperationId:
public_create_employee_v0_employee__post - Authentication: header
x-api-key(APIKeyHeaderin OpenAPI)
Examples focused on create_exam and send_email
1) Create exam and send email immediately (no send_date)
curl -X POST "https://public-api.salu.com.vc/dev/routes/v0/employee/" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $SALU_PUBLIC_API_KEY" \
--data '{
"name": "Jane Doe",
"gov_id": "12345678900",
"is_disabled": false,
"status": "Ativo",
"sex": "F",
"admission_date": "2025-01-31",
"organization_id": "00000000-0000-0000-0000-000000000001",
"branch_id": "00000000-0000-0000-0000-000000000002",
"position_id": "00000000-0000-0000-0000-000000000003",
"sector_id": "00000000-0000-0000-0000-000000000004",
"create_exam": true,
"send_email": true,
"send_date": null
}'
send_email=true and send_date was not provided.
2) Schedule the email for a specific date/time
curl -X POST "https://public-api.salu.com.vc/dev/routes/v0/employee/" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $SALU_PUBLIC_API_KEY" \
--data '{
"name": "Jane Doe",
"gov_id": "12345678900",
"is_disabled": false,
"status": "Ativo",
"sex": "F",
"admission_date": "2025-01-31",
"organization_id": "00000000-0000-0000-0000-000000000001",
"branch_id": "00000000-0000-0000-0000-000000000002",
"position_id": "00000000-0000-0000-0000-000000000003",
"sector_id": "00000000-0000-0000-0000-000000000004",
"create_exam": true,
"send_email": true,
"send_date": "2025-02-01T09:30:00Z"
}'
send_date provided (ISO 8601).
Enum fields and translations
Use exactly the enum values as defined by the API (Portuguese strings). Do not send the English translations below — they are provided only to clarify the meaning.
status
| Field (request) | Allowed values (API enum) | Meaning (EN) |
|---|---|---|
status | Ativo | Active |
Inativo | Inactive | |
Afastado | On leave | |
Férias | Vacation | |
Pendente | Pending |
sex
| Field (request) | Allowed values (API enum) | Meaning (EN) |
|---|---|---|
sex | M | Male |
F | Female |
gender
| Field (request) | Allowed values (API enum) | Meaning (EN) |
|---|---|---|
gender | Cis | Cisgender |
Trans | Transgender |
marital_status
| Field (request) | Allowed values (API enum) | Meaning (EN) |
|---|---|---|
marital_status | Não informado | Not informed |
Solteiro | Single | |
Casado | Married | |
Separado | Separated | |
Desquitado | Legally separated | |
Viúvo | Widowed | |
Outros | Other | |
Divorciado | Divorced | |
União Estável | Common-law union |
educational_stage
| Field (request) | Allowed values (API enum) | Meaning (EN) |
|---|---|---|
educational_stage | Indefinida | Undefined |
Ensino Fundamental Incompleto | Incomplete Elementary School | |
Ensino Fundamental Completo | Complete Elementary School | |
Ensino Medio Incompleto | Incomplete High School | |
Ensino Medio Completo | Complete High School | |
Ensino Superior Incompleto | Incomplete Undergraduate | |
Ensino Superior Completo | Complete Undergraduate | |
Profissionalizante | Vocational/Professional | |
Técnico Incompleto | Incomplete Technical Course | |
Técnico Completo | Complete Technical Course | |
Tecnólogo Incompleto | Incomplete Technologist Degree | |
Tecnólogo Completo | Complete Technologist Degree | |
Pós-graduação Incompleta | Incomplete Postgraduate | |
Pós-graduação Completo | Complete Postgraduate | |
Mestrado Incompleto | Incomplete Master’s | |
Mestrado Completo | Complete Master’s | |
Doutorado Incompleto | Incomplete Doctorate | |
Doutorado Completo | Complete Doctorate | |
PHD Incompleto | Incomplete PhD | |
PHD Completo | Complete PhD | |
Não Informado | Not informed | |
Analfabeto | Illiterate |
human_skin_tone
| Field (request) | Allowed values (API enum) | Meaning (EN) |
|---|---|---|
human_skin_tone | Indefinido | Undefined |
Branca | White | |
Preta | Black | |
Parda | Brown/mixed | |
Amarela | Yellow | |
Indígena | Indigenous | |
Mulato | Mulatto |
contract_type
| Field (request) | Allowed values (API enum) | Meaning (EN) |
|---|---|---|
contract_type | CLT | CLT (Brazilian labor law employment) |
COOPERADO | Cooperative member | |
TERCERIZADO | Outsourced/third-party worker | |
AUTONOMO | Self-employed contractor | |
TEMPORARIO | Temporary | |
PESSOA_JURIDICA | Legal entity (company contractor) | |
ESTAGIARIO | Intern | |
MENOR_APRENDIZ | Young apprentice | |
ESTATUTARIO | Statutory public servant | |
COMISSIONADO_INTERNO | Internal commissioned | |
COMISSIONADO_EXTERNO | External commissioned | |
APOSENTADO | Retired | |
APOSENTADO_INATIVO_PREFEITURA | Retired inactive (municipality) | |
PENSIONISTA | Pensioner | |
SERVIDOR_PUBLICO_EFETIVO | Tenured public servant | |
EXTRANUMERARIO | Supernumerary employee | |
AUTARQUICO | Autarchic public servant | |
INATIVO | Inactive | |
TITULO_PRECARIO | Provisional title (precarious) | |
SERVIDOR_ADM_CENTRALIZADA_OU_DESCENTRALIZADA | Centralized/Decentralized administration public servant |
Example request
curl -X POST "https://public-api.salu.com.vc/dev/routes/v0/employee/" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $SALU_PUBLIC_API_KEY" \
--data '{
"employee_name": "Jane Doe",
"employee_registration_number": "12345",
"employee_is_disabled": false
}'
Authorizations
Body
application/json
Available options:
Ativo, Inativo, Afastado, Férias, Pendente Available options:
M, F Available options:
Cis, Trans Available options:
Não informado, Solteiro, Casado, Separado, Desquitado, Viúvo, Outros, Divorciado, União Estável Available options:
Indefinida, Ensino Fundamental Incompleto, Ensino Fundamental Completo, Ensino Medio Incompleto, Ensino Medio Completo, Ensino Superior Incompleto, Ensino Superior Completo, Profissionalizante, Técnico Incompleto, Técnico Completo, Tecnólogo Incompleto, Tecnólogo Completo, Pós-graduação Incompleta, Pós-graduação Completo, Mestrado Incompleto, Mestrado Completo, Doutorado Incompleto, Doutorado Completo, PHD Incompleto, PHD Completo, Não Informado, Analfabeto Available options:
Indefinido, Branca, Preta, Parda, Amarela, Indígena, Mulato Available options:
CLT, COOPERADO, TERCERIZADO, AUTONOMO, TEMPORARIO, PESSOA_JURIDICA, ESTAGIARIO, MENOR_APRENDIZ, ESTATUTARIO, COMISSIONADO_INTERNO, COMISSIONADO_EXTERNO, APOSENTADO, APOSENTADO_INATIVO_PREFEITURA, PENSIONISTA, SERVIDOR_PUBLICO_EFETIVO, EXTRANUMERARIO, AUTARQUICO, INATIVO, TITULO_PRECARIO, SERVIDOR_ADM_CENTRALIZADA_OU_DESCENTRALIZADA ID da análise PCD aprovada vinculada ao colaborador. Obrigatório quando is_disabled=true e o customer exige pré-análise.
Response
Successful Response
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
⌘I