Skip to main content
POST
/
broker-invite
cURL
curl --request POST \
  --url https://api.example.com/broker-invite \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "<string>",
  "brokerageFirmId": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "type": "COMPANY",
  "brokerRole": "<string>"
}
'
{
  "token": "<string>"
}

Body

application/json
​
email
string
required

Email address to invite

​
brokerageFirmId
string
required

Brokerage firm id

​
firstName
string
required

First name

​
lastName
string
required

Last name

​
type
enum<string>
required

Invite type

Available options:
COMPANY,
EMPLOYEE,
RETAIL_TO_RETAIL_BROKER,
POLICY_OWNER,
REINVITE,
ANONYMOUS,
WHOLESALE_TO_RETAIL_BROKER
​
brokerRole
string

Broker role

Response

​
token
string

Token