Skip to main content
POST
/
brokerage-firms
Create brokerage firm
curl --request POST \
  --url https://api.example.com/brokerage-firms \
  --header 'Content-Type: application/json' \
  --data '
{
  "customFields": [
    {
      "key": "<string>",
      "value": "<string>"
    }
  ],
  "parentBrokerageFirmId": "<string>"
}
'
{
  "type": "<string>",
  "id": "<string>"
}

Body

application/json

Brokerage firm creation payload

​
firmType
enum<string>
required

Brokerage firm type

Available options:
WHOLESALE,
RETAIL,
TEAM
​
customFields
object[]

custom fields per product

​
parentBrokerageFirmId
string

Brokerage firm id

Response

Brokerage firm created successfully.

​
type
string
required

type of entity

​
id
string
required

id of the entity