Create brokerage firm
curl --request POST \
--url https://api.korint.io/brokerage-firms \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenant: <tenant>' \
--data '
{
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"parentBrokerageFirmId": "<string>",
"companyInfo": {
"siret": "<string>",
"siren": "<string>",
"name": "<string>",
"location": {
"address": "<string>",
"postCode": "<string>",
"city": "<string>",
"country": "<string>"
}
}
}
'import requests
url = "https://api.korint.io/brokerage-firms"
payload = {
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"parentBrokerageFirmId": "<string>",
"companyInfo": {
"siret": "<string>",
"siren": "<string>",
"name": "<string>",
"location": {
"address": "<string>",
"postCode": "<string>",
"city": "<string>",
"country": "<string>"
}
}
}
headers = {
"tenant": "<tenant>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
tenant: '<tenant>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customFields: [{key: '<string>', value: '<string>'}],
parentBrokerageFirmId: '<string>',
companyInfo: {
siret: '<string>',
siren: '<string>',
name: '<string>',
location: {
address: '<string>',
postCode: '<string>',
city: '<string>',
country: '<string>'
}
}
})
};
fetch('https://api.korint.io/brokerage-firms', 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://api.korint.io/brokerage-firms",
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([
'customFields' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'parentBrokerageFirmId' => '<string>',
'companyInfo' => [
'siret' => '<string>',
'siren' => '<string>',
'name' => '<string>',
'location' => [
'address' => '<string>',
'postCode' => '<string>',
'city' => '<string>',
'country' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"tenant: <tenant>"
],
]);
$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://api.korint.io/brokerage-firms"
payload := strings.NewReader("{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parentBrokerageFirmId\": \"<string>\",\n \"companyInfo\": {\n \"siret\": \"<string>\",\n \"siren\": \"<string>\",\n \"name\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"postCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("tenant", "<tenant>")
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://api.korint.io/brokerage-firms")
.header("tenant", "<tenant>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parentBrokerageFirmId\": \"<string>\",\n \"companyInfo\": {\n \"siret\": \"<string>\",\n \"siren\": \"<string>\",\n \"name\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"postCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korint.io/brokerage-firms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["tenant"] = '<tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parentBrokerageFirmId\": \"<string>\",\n \"companyInfo\": {\n \"siret\": \"<string>\",\n \"siren\": \"<string>\",\n \"name\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"postCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"id": "<string>"
}brokerage-firms
Create brokerage firm
Creates a brokerage firm for the tenant using the provided configuration. Requires a valid authenticated user. The body contains company, product, and commission configuration.
POST
/
brokerage-firms
Create brokerage firm
curl --request POST \
--url https://api.korint.io/brokerage-firms \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'tenant: <tenant>' \
--data '
{
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"parentBrokerageFirmId": "<string>",
"companyInfo": {
"siret": "<string>",
"siren": "<string>",
"name": "<string>",
"location": {
"address": "<string>",
"postCode": "<string>",
"city": "<string>",
"country": "<string>"
}
}
}
'import requests
url = "https://api.korint.io/brokerage-firms"
payload = {
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"parentBrokerageFirmId": "<string>",
"companyInfo": {
"siret": "<string>",
"siren": "<string>",
"name": "<string>",
"location": {
"address": "<string>",
"postCode": "<string>",
"city": "<string>",
"country": "<string>"
}
}
}
headers = {
"tenant": "<tenant>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
tenant: '<tenant>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
customFields: [{key: '<string>', value: '<string>'}],
parentBrokerageFirmId: '<string>',
companyInfo: {
siret: '<string>',
siren: '<string>',
name: '<string>',
location: {
address: '<string>',
postCode: '<string>',
city: '<string>',
country: '<string>'
}
}
})
};
fetch('https://api.korint.io/brokerage-firms', 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://api.korint.io/brokerage-firms",
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([
'customFields' => [
[
'key' => '<string>',
'value' => '<string>'
]
],
'parentBrokerageFirmId' => '<string>',
'companyInfo' => [
'siret' => '<string>',
'siren' => '<string>',
'name' => '<string>',
'location' => [
'address' => '<string>',
'postCode' => '<string>',
'city' => '<string>',
'country' => '<string>'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"tenant: <tenant>"
],
]);
$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://api.korint.io/brokerage-firms"
payload := strings.NewReader("{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parentBrokerageFirmId\": \"<string>\",\n \"companyInfo\": {\n \"siret\": \"<string>\",\n \"siren\": \"<string>\",\n \"name\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"postCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("tenant", "<tenant>")
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://api.korint.io/brokerage-firms")
.header("tenant", "<tenant>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parentBrokerageFirmId\": \"<string>\",\n \"companyInfo\": {\n \"siret\": \"<string>\",\n \"siren\": \"<string>\",\n \"name\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"postCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korint.io/brokerage-firms")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["tenant"] = '<tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"customFields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ],\n \"parentBrokerageFirmId\": \"<string>\",\n \"companyInfo\": {\n \"siret\": \"<string>\",\n \"siren\": \"<string>\",\n \"name\": \"<string>\",\n \"location\": {\n \"address\": \"<string>\",\n \"postCode\": \"<string>\",\n \"city\": \"<string>\",\n \"country\": \"<string>\"\n }\n }\n}"
response = http.request(request)
puts response.read_body{
"type": "<string>",
"id": "<string>"
}Authorizations
oauth2bearerAuth
Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.
Headers
Your tenant identifier. Requests without it are rejected.
Body
application/json
Brokerage firm creation payload
Brokerage firm type
Available options:
WHOLESALE, RETAIL, TEAM custom fields per product
Show child attributes
Show child attributes
Brokerage firm id
Pattern:
^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Partial company info supplied directly (used when the user enters company details manually instead of relying on a SIREN lookup).
Show child attributes
Show child attributes
Was this page helpful?
⌘I

