Public Create Branch
curl --request POST \
--url https://public-api.salu.com.vc/dev/routes/v0/branch/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"display_name": "<string>",
"company_name": "<string>",
"cnpj": "<string>",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"is_active": true,
"hr_code": "<string>",
"cnae": "<string>",
"client_integration_code": "<string>"
}
'import requests
url = "https://public-api.salu.com.vc/dev/routes/v0/branch/"
payload = {
"display_name": "<string>",
"company_name": "<string>",
"cnpj": "<string>",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"is_active": True,
"hr_code": "<string>",
"cnae": "<string>",
"client_integration_code": "<string>"
}
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({
display_name: '<string>',
company_name: '<string>',
cnpj: '<string>',
organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
address: '<string>',
address_number: '<string>',
address_detail: '<string>',
zip_code: '<string>',
neighborhood: '<string>',
state: '<string>',
city: '<string>',
is_active: true,
hr_code: '<string>',
cnae: '<string>',
client_integration_code: '<string>'
})
};
fetch('https://public-api.salu.com.vc/dev/routes/v0/branch/', 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/branch/",
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([
'display_name' => '<string>',
'company_name' => '<string>',
'cnpj' => '<string>',
'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'address' => '<string>',
'address_number' => '<string>',
'address_detail' => '<string>',
'zip_code' => '<string>',
'neighborhood' => '<string>',
'state' => '<string>',
'city' => '<string>',
'is_active' => true,
'hr_code' => '<string>',
'cnae' => '<string>',
'client_integration_code' => '<string>'
]),
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/branch/"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"organization_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 \"is_active\": true,\n \"hr_code\": \"<string>\",\n \"cnae\": \"<string>\",\n \"client_integration_code\": \"<string>\"\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/branch/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"organization_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 \"is_active\": true,\n \"hr_code\": \"<string>\",\n \"cnae\": \"<string>\",\n \"client_integration_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.salu.com.vc/dev/routes/v0/branch/")
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 \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"organization_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 \"is_active\": true,\n \"hr_code\": \"<string>\",\n \"cnae\": \"<string>\",\n \"client_integration_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"company_name": "<string>",
"cnpj": "<string>",
"is_active": true,
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"hr_code": "<string>",
"client_integration_code": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Branches
Create Branch
POST
/
v0
/
branch
/
Public Create Branch
curl --request POST \
--url https://public-api.salu.com.vc/dev/routes/v0/branch/ \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"display_name": "<string>",
"company_name": "<string>",
"cnpj": "<string>",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"is_active": true,
"hr_code": "<string>",
"cnae": "<string>",
"client_integration_code": "<string>"
}
'import requests
url = "https://public-api.salu.com.vc/dev/routes/v0/branch/"
payload = {
"display_name": "<string>",
"company_name": "<string>",
"cnpj": "<string>",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"is_active": True,
"hr_code": "<string>",
"cnae": "<string>",
"client_integration_code": "<string>"
}
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({
display_name: '<string>',
company_name: '<string>',
cnpj: '<string>',
organization_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
address: '<string>',
address_number: '<string>',
address_detail: '<string>',
zip_code: '<string>',
neighborhood: '<string>',
state: '<string>',
city: '<string>',
is_active: true,
hr_code: '<string>',
cnae: '<string>',
client_integration_code: '<string>'
})
};
fetch('https://public-api.salu.com.vc/dev/routes/v0/branch/', 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/branch/",
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([
'display_name' => '<string>',
'company_name' => '<string>',
'cnpj' => '<string>',
'organization_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'address' => '<string>',
'address_number' => '<string>',
'address_detail' => '<string>',
'zip_code' => '<string>',
'neighborhood' => '<string>',
'state' => '<string>',
'city' => '<string>',
'is_active' => true,
'hr_code' => '<string>',
'cnae' => '<string>',
'client_integration_code' => '<string>'
]),
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/branch/"
payload := strings.NewReader("{\n \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"organization_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 \"is_active\": true,\n \"hr_code\": \"<string>\",\n \"cnae\": \"<string>\",\n \"client_integration_code\": \"<string>\"\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/branch/")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"organization_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 \"is_active\": true,\n \"hr_code\": \"<string>\",\n \"cnae\": \"<string>\",\n \"client_integration_code\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://public-api.salu.com.vc/dev/routes/v0/branch/")
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 \"display_name\": \"<string>\",\n \"company_name\": \"<string>\",\n \"cnpj\": \"<string>\",\n \"organization_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 \"is_active\": true,\n \"hr_code\": \"<string>\",\n \"cnae\": \"<string>\",\n \"client_integration_code\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"company_name": "<string>",
"cnpj": "<string>",
"is_active": true,
"address": "<string>",
"address_number": "<string>",
"address_detail": "<string>",
"zip_code": "<string>",
"neighborhood": "<string>",
"state": "<string>",
"city": "<string>",
"hr_code": "<string>",
"client_integration_code": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}This endpoint creates a branch associated with an organization.
It accepts the
BranchRequestCreateSchema as the request body and
returns PublicApiBranchBaseResponse on success.Overview
- Method:
POST - Path:
/v0/branch/ - OperationId:
public_create_branch_v0_branch__post - Authentication: header
x-api-key(APIKeyHeaderin the OpenAPI)
Fields
- cnpj — Company / Branch identifier A CNPJ (Cadastro Nacional da Pessoa Jurídica) is the tax ID for a legal entity (company). A single company group may have multiple CNPJs, because each branch/worksite can have its own legal registration (branch-specific CNPJ). In our model, the Branch is identified by cnpj because that defines the legal employer entity responsible for compliance.
Example Request
curl -X POST "https://public-api.salu.com.vc/dev/routes/v0/branch/" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "x-api-key: $SALU_PUBLIC_API_KEY" \
-d @branch_payload.json
Authorizations
Body
application/json
Response
Successful Response
⌘I