Skip to main content
POST
Create brokerage firm

Authorizations

Authorization
string
header
required

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

tenant
string
required

Your tenant identifier. Requests without it are rejected.

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

Pattern: ^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$
companyInfo
object

Partial company info supplied directly (used when the user enters company details manually instead of relying on a SIREN lookup).

Response

Brokerage firm created successfully.

type
string
required

type of entity

id
string
required

id of the entity