List brokerage firm policies

POST /view-specific/{brokerageFirmId}/policies

List brokerage firm policies

cURL

curl --request POST \
  --url https://api.example.com/view-specific/{brokerageFirmId}/policies \
  --header 'Content-Type: application/json' \
  --data '
{
  "viewType": "newBusiness",
  "pageInfo": {
    "count": 10,
    "page": 1
  },
  "statuses": [
    "<string>"
  ],
  "customStatuses": [
    "<string>"
  ],
  "businessIntroducers": [
    "<string>"
  ],
  "startedAt": {
    "start": "<string>",
    "end": "<string>"
  },
  "stoppedAt": {
    "start": "<string>",
    "end": "<string>"
  },
  "hasAcknowledgedAlerts": true,
  "expandCustomers": true,
  "expandAssets": true,
  "expandBrokerageFirm": true,
  "expandDerogations": true,
  "queryString": "<string>",
  "brokerageFirmName": "<string>",
  "derogationStatuses": [
    "PENDING"
  ],
  "productIds": [
    "<string>"
  ]
}
'

200

{
  "data": [
    {
      "customerId": "<string>",
      "policyId": "<string>",
      "branches": [
        {
          "policy": {
            "id": "<string>",
            "productId": "<string>",
            "createdAt": "<string>",
            "lastModifiedAt": "<string>",
            "status": "POLICY_CREATED",
            "hasOpenedClientAccount": true,
            "customFields": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ],
            "externalId": "<string>",
            "startedAt": "<string>",
            "stoppedAt": "<string>"
          },
          "assets": [
            {
              "id": "<string>",
              "lastModifiedAt": "<string>",
              "createdAt": "<string>",
              "status": "ASSET_CREATED",
              "customFields": [
                {
                  "key": "<string>",
                  "value": "<string>"
                }
              ],
              "startedAt": "<string>",
              "stoppedAt": "<string>"
            }
          ],
          "derogations": [
            {
              "id": "<string>",
              "status": "PENDING",
              "policyId": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

Path Parameters

brokerageFirmId · string · required

Body

application/json

viewType · enum<string> · required

View type

Available options: newBusiness, derogation, live

pageInfo · object

the page info

Show child attributes

order · object

the sort options

Show child attributes

statuses · string[]

Statuses to filter by

customStatuses · string[]

Custom statuses to filter by

businessIntroducers · string[]

Business introducers to filter by

startedAt · object

Started at range

Show child attributes

stoppedAt · object

Stopped at range

Show child attributes

hasAcknowledgedAlerts · boolean

Optional: if filled, returns policies with at least one alert which acknowledgement matches this attribute

expandCustomers · boolean

expandAssets · boolean

expandBrokerageFirm · boolean

expandDerogations · boolean

queryString · string

Full text search

brokerageFirmName · string

Brokerage firm name

derogationStatuses · enum<string>[]

Filter by derogation status

Available options: PENDING, DECLINED, APPROVED

productIds · string[]

List of product ids

Response

200 - application/json

data · object[] · required

the list of items in the page

Show child attributes

pageInfo · object · required

the page info

Show child attributes

totalCount · number · required

the total number of items

currentPage · number · required

the current page

totalPages · number · required

the total number of pages