Skip to main content
POST
/
api
/
external
/
companies
/
{companyId}
/
brokers
curl --request POST \ --url https://app.aiinsurance.io/api/external/companies/{companyId}/brokers \ --header 'Authorization: <api-key>' \ --header 'Content-Type: application/json' \ --data ' { "brokerageId": "770e8400-e29b-41d4-a716-446655440000", "name": "John Smith" } '
{
  "id": "550e8400-e29b-41d4-a716-446655440003"
}

Authorizations

Authorization
string
header
required

Use format: ApiKey <your-api-key>

Path Parameters

companyId
string<uuid>
required

Company identifier

Body

application/json
brokerageId
string<uuid>
required

The brokerage this broker belongs to (required)

name
string
required

Broker name (required)

email
string<email>

Broker email address

defaultCommissionPercentage
number

Default commission percentage (0-100)

Required range: 0 <= x <= 100
addressStructured
object

Structured address information

phone
string

Primary phone number

workPhone
string

Work phone number

producerNumber
string

Producer number/identifier

Response

Broker created successfully

id
string<uuid>

The ID of the created broker