Search a brokerage firm's policies

curl --request POST \
  --url https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'tenant: <tenant>' \
  --data '
{
  "pageInfo": {
    "count": 10,
    "page": 1
  },
  "statuses": [],
  "customStatuses": [
    "<string>"
  ],
  "onSameBranch": [
    {
      "property": "<string>",
      "value": {
        "equals": "<string>"
      },
      "includeAllBranches": true,
      "excludeBaseBranch": false,
      "timeZone": "UTC",
      "textSearchDepth": 0
    }
  ],
  "businessIntroducers": [
    "<string>"
  ],
  "startedAt": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "stoppedAt": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "endedAt": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "createdAt": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "hasAcknowledgedAlerts": true,
  "awaitingFirstPayment": true,
  "expandCustomers": true,
  "expandAssets": true,
  "expandBrokerageFirm": true,
  "expandDerogations": true,
  "queryString": "<string>",
  "brokerageFirmName": "<string>",
  "derogationStatuses": [],
  "productIds": [
    "<string>"
  ],
  "stopReasons": [
    "<string>"
  ],
  "authorUserIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search"

payload = {
    "pageInfo": {
        "count": 10,
        "page": 1
    },
    "statuses": [],
    "customStatuses": ["<string>"],
    "onSameBranch": [
        {
            "property": "<string>",
            "value": { "equals": "<string>" },
            "includeAllBranches": True,
            "excludeBaseBranch": False,
            "timeZone": "UTC",
            "textSearchDepth": 0
        }
    ],
    "businessIntroducers": ["<string>"],
    "startedAt": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
    },
    "stoppedAt": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
    },
    "endedAt": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
    },
    "createdAt": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
    },
    "hasAcknowledgedAlerts": True,
    "awaitingFirstPayment": True,
    "expandCustomers": True,
    "expandAssets": True,
    "expandBrokerageFirm": True,
    "expandDerogations": True,
    "queryString": "<string>",
    "brokerageFirmName": "<string>",
    "derogationStatuses": [],
    "productIds": ["<string>"],
    "stopReasons": ["<string>"],
    "authorUserIds": ["<string>"]
}
headers = {
    "tenant": "<tenant>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    tenant: '<tenant>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    pageInfo: {count: 10, page: 1},
    statuses: [],
    customStatuses: ['<string>'],
    onSameBranch: [
      {
        property: '<string>',
        value: {equals: '<string>'},
        includeAllBranches: true,
        excludeBaseBranch: false,
        timeZone: 'UTC',
        textSearchDepth: 0
      }
    ],
    businessIntroducers: ['<string>'],
    startedAt: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
    stoppedAt: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
    endedAt: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
    createdAt: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
    hasAcknowledgedAlerts: true,
    awaitingFirstPayment: true,
    expandCustomers: true,
    expandAssets: true,
    expandBrokerageFirm: true,
    expandDerogations: true,
    queryString: '<string>',
    brokerageFirmName: '<string>',
    derogationStatuses: [],
    productIds: ['<string>'],
    stopReasons: ['<string>'],
    authorUserIds: ['<string>']
  })
};

fetch('https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pageInfo' => [
        'count' => 10,
        'page' => 1
    ],
    'statuses' => [
        
    ],
    'customStatuses' => [
        '<string>'
    ],
    'onSameBranch' => [
        [
                'property' => '<string>',
                'value' => [
                                'equals' => '<string>'
                ],
                'includeAllBranches' => true,
                'excludeBaseBranch' => false,
                'timeZone' => 'UTC',
                'textSearchDepth' => 0
        ]
    ],
    'businessIntroducers' => [
        '<string>'
    ],
    'startedAt' => [
        'start' => '2023-11-07T05:31:56Z',
        'end' => '2023-11-07T05:31:56Z'
    ],
    'stoppedAt' => [
        'start' => '2023-11-07T05:31:56Z',
        'end' => '2023-11-07T05:31:56Z'
    ],
    'endedAt' => [
        'start' => '2023-11-07T05:31:56Z',
        'end' => '2023-11-07T05:31:56Z'
    ],
    'createdAt' => [
        'start' => '2023-11-07T05:31:56Z',
        'end' => '2023-11-07T05:31:56Z'
    ],
    'hasAcknowledgedAlerts' => true,
    'awaitingFirstPayment' => true,
    'expandCustomers' => true,
    'expandAssets' => true,
    'expandBrokerageFirm' => true,
    'expandDerogations' => true,
    'queryString' => '<string>',
    'brokerageFirmName' => '<string>',
    'derogationStatuses' => [
        
    ],
    'productIds' => [
        '<string>'
    ],
    'stopReasons' => [
        '<string>'
    ],
    'authorUserIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "tenant: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search"

	payload := strings.NewReader("{\n  \"pageInfo\": {\n    \"count\": 10,\n    \"page\": 1\n  },\n  \"statuses\": [],\n  \"customStatuses\": [\n    \"<string>\"\n  ],\n  \"onSameBranch\": [\n    {\n      \"property\": \"<string>\",\n      \"value\": {\n        \"equals\": \"<string>\"\n      },\n      \"includeAllBranches\": true,\n      \"excludeBaseBranch\": false,\n      \"timeZone\": \"UTC\",\n      \"textSearchDepth\": 0\n    }\n  ],\n  \"businessIntroducers\": [\n    \"<string>\"\n  ],\n  \"startedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"stoppedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"endedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"createdAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"hasAcknowledgedAlerts\": true,\n  \"awaitingFirstPayment\": true,\n  \"expandCustomers\": true,\n  \"expandAssets\": true,\n  \"expandBrokerageFirm\": true,\n  \"expandDerogations\": true,\n  \"queryString\": \"<string>\",\n  \"brokerageFirmName\": \"<string>\",\n  \"derogationStatuses\": [],\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"stopReasons\": [\n    \"<string>\"\n  ],\n  \"authorUserIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("tenant", "<tenant>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search")
  .header("tenant", "<tenant>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pageInfo\": {\n    \"count\": 10,\n    \"page\": 1\n  },\n  \"statuses\": [],\n  \"customStatuses\": [\n    \"<string>\"\n  ],\n  \"onSameBranch\": [\n    {\n      \"property\": \"<string>\",\n      \"value\": {\n        \"equals\": \"<string>\"\n      },\n      \"includeAllBranches\": true,\n      \"excludeBaseBranch\": false,\n      \"timeZone\": \"UTC\",\n      \"textSearchDepth\": 0\n    }\n  ],\n  \"businessIntroducers\": [\n    \"<string>\"\n  ],\n  \"startedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"stoppedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"endedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"createdAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"hasAcknowledgedAlerts\": true,\n  \"awaitingFirstPayment\": true,\n  \"expandCustomers\": true,\n  \"expandAssets\": true,\n  \"expandBrokerageFirm\": true,\n  \"expandDerogations\": true,\n  \"queryString\": \"<string>\",\n  \"brokerageFirmName\": \"<string>\",\n  \"derogationStatuses\": [],\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"stopReasons\": [\n    \"<string>\"\n  ],\n  \"authorUserIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["tenant"] = '<tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pageInfo\": {\n    \"count\": 10,\n    \"page\": 1\n  },\n  \"statuses\": [],\n  \"customStatuses\": [\n    \"<string>\"\n  ],\n  \"onSameBranch\": [\n    {\n      \"property\": \"<string>\",\n      \"value\": {\n        \"equals\": \"<string>\"\n      },\n      \"includeAllBranches\": true,\n      \"excludeBaseBranch\": false,\n      \"timeZone\": \"UTC\",\n      \"textSearchDepth\": 0\n    }\n  ],\n  \"businessIntroducers\": [\n    \"<string>\"\n  ],\n  \"startedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"stoppedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"endedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"createdAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"hasAcknowledgedAlerts\": true,\n  \"awaitingFirstPayment\": true,\n  \"expandCustomers\": true,\n  \"expandAssets\": true,\n  \"expandBrokerageFirm\": true,\n  \"expandDerogations\": true,\n  \"queryString\": \"<string>\",\n  \"brokerageFirmName\": \"<string>\",\n  \"derogationStatuses\": [],\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"stopReasons\": [\n    \"<string>\"\n  ],\n  \"authorUserIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "customerIds": [
        "<string>"
      ],
      "policyId": "<string>",
      "branches": [
        {
          "policy": {
            "id": "<string>",
            "productId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "lastModifiedAt": "2023-11-07T05:31:56Z",
            "hasOpenedClientAccount": true,
            "customFields": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ],
            "externalId": "<string>",
            "author": {
              "firstName": "<string>",
              "lastName": "<string>",
              "userId": "<string>",
              "email": "jsmith@example.com",
              "brokerRole": "<string>"
            },
            "signedAt": "2023-11-07T05:31:56Z",
            "startedAt": "2023-11-07T05:31:56Z",
            "isAwaitingFirstPayment": true,
            "endedAt": "2023-11-07T05:31:56Z",
            "stoppedAt": "2023-11-07T05:31:56Z",
            "stop": {
              "reason": "<string>",
              "details": [
                {
                  "key": "<string>",
                  "value": "<string>"
                }
              ],
              "createdAt": "<string>"
            },
            "totalPremium": {
              "amountPreFeesAndTaxes": 123,
              "totalFees": 123,
              "amountWithFeesPreTaxes": 123,
              "totalTaxes": 123,
              "amountWithFeesAndTaxes": 123
            }
          },
          "branch": {
            "branchId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "mergedAt": "2023-11-07T05:31:56Z",
            "derogations": [
              {
                "derogationId": "<string>",
                "createdAt": "2023-11-07T05:31:56Z"
              }
            ]
          },
          "customers": [
            {
              "type": "<string>",
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "lastModifiedAt": "2023-11-07T05:31:56Z",
              "role": "<string>",
              "customFields": [
                {
                  "key": "<string>",
                  "value": "<string>"
                }
              ],
              "name": "<string>"
            }
          ],
          "assets": [
            {
              "id": "<string>",
              "lastModifiedAt": "2023-11-07T05:31:56Z",
              "createdAt": "2023-11-07T05:31:56Z",
              "customFields": [
                {
                  "key": "<string>",
                  "value": "<string>"
                }
              ],
              "startedAt": "2023-11-07T05:31:56Z",
              "stoppedAt": "2023-11-07T05:31:56Z",
              "totalPremium": {
                "amountPreFeesAndTaxes": 123,
                "totalFees": 123,
                "amountWithFeesPreTaxes": 123,
                "totalTaxes": 123,
                "amountWithFeesAndTaxes": 123
              }
            }
          ],
          "brokerageFirm": {
            "id": "<string>",
            "companyInfo": {
              "siret": "<string>",
              "siren": "<string>",
              "nafCode": "<string>",
              "nafLabel": "<string>",
              "name": "<string>",
              "creationDate": "2023-11-07T05:31:56Z",
              "location": {
                "city": "<string>",
                "country": "<string>",
                "address": "<string>",
                "postCode": "<string>"
              },
              "legalStatus": {
                "1": "<string>",
                "2": "<string>",
                "3": "<string>"
              },
              "headcount": "<string>",
              "isActive": true
            },
            "customFields": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ]
          },
          "parentBrokerageFirm": {
            "id": "<string>",
            "companyInfo": {
              "siret": "<string>",
              "siren": "<string>",
              "nafCode": "<string>",
              "nafLabel": "<string>",
              "name": "<string>",
              "creationDate": "2023-11-07T05:31:56Z",
              "location": {
                "city": "<string>",
                "country": "<string>",
                "address": "<string>",
                "postCode": "<string>"
              },
              "legalStatus": {
                "1": "<string>",
                "2": "<string>",
                "3": "<string>"
              },
              "headcount": "<string>",
              "isActive": true
            },
            "customFields": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ]
          },
          "derogations": [
            {
              "id": "<string>",
              "policyId": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

POST

brokerage-firms

{brokerageFirmId}

policies

Search a brokerage firm's policies

curl --request POST \
  --url https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'tenant: <tenant>' \
  --data '
{
  "pageInfo": {
    "count": 10,
    "page": 1
  },
  "statuses": [],
  "customStatuses": [
    "<string>"
  ],
  "onSameBranch": [
    {
      "property": "<string>",
      "value": {
        "equals": "<string>"
      },
      "includeAllBranches": true,
      "excludeBaseBranch": false,
      "timeZone": "UTC",
      "textSearchDepth": 0
    }
  ],
  "businessIntroducers": [
    "<string>"
  ],
  "startedAt": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "stoppedAt": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "endedAt": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "createdAt": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "hasAcknowledgedAlerts": true,
  "awaitingFirstPayment": true,
  "expandCustomers": true,
  "expandAssets": true,
  "expandBrokerageFirm": true,
  "expandDerogations": true,
  "queryString": "<string>",
  "brokerageFirmName": "<string>",
  "derogationStatuses": [],
  "productIds": [
    "<string>"
  ],
  "stopReasons": [
    "<string>"
  ],
  "authorUserIds": [
    "<string>"
  ]
}
'

import requests

url = "https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search"

payload = {
    "pageInfo": {
        "count": 10,
        "page": 1
    },
    "statuses": [],
    "customStatuses": ["<string>"],
    "onSameBranch": [
        {
            "property": "<string>",
            "value": { "equals": "<string>" },
            "includeAllBranches": True,
            "excludeBaseBranch": False,
            "timeZone": "UTC",
            "textSearchDepth": 0
        }
    ],
    "businessIntroducers": ["<string>"],
    "startedAt": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
    },
    "stoppedAt": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
    },
    "endedAt": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
    },
    "createdAt": {
        "start": "2023-11-07T05:31:56Z",
        "end": "2023-11-07T05:31:56Z"
    },
    "hasAcknowledgedAlerts": True,
    "awaitingFirstPayment": True,
    "expandCustomers": True,
    "expandAssets": True,
    "expandBrokerageFirm": True,
    "expandDerogations": True,
    "queryString": "<string>",
    "brokerageFirmName": "<string>",
    "derogationStatuses": [],
    "productIds": ["<string>"],
    "stopReasons": ["<string>"],
    "authorUserIds": ["<string>"]
}
headers = {
    "tenant": "<tenant>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    tenant: '<tenant>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    pageInfo: {count: 10, page: 1},
    statuses: [],
    customStatuses: ['<string>'],
    onSameBranch: [
      {
        property: '<string>',
        value: {equals: '<string>'},
        includeAllBranches: true,
        excludeBaseBranch: false,
        timeZone: 'UTC',
        textSearchDepth: 0
      }
    ],
    businessIntroducers: ['<string>'],
    startedAt: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
    stoppedAt: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
    endedAt: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
    createdAt: {start: '2023-11-07T05:31:56Z', end: '2023-11-07T05:31:56Z'},
    hasAcknowledgedAlerts: true,
    awaitingFirstPayment: true,
    expandCustomers: true,
    expandAssets: true,
    expandBrokerageFirm: true,
    expandDerogations: true,
    queryString: '<string>',
    brokerageFirmName: '<string>',
    derogationStatuses: [],
    productIds: ['<string>'],
    stopReasons: ['<string>'],
    authorUserIds: ['<string>']
  })
};

fetch('https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'pageInfo' => [
        'count' => 10,
        'page' => 1
    ],
    'statuses' => [
        
    ],
    'customStatuses' => [
        '<string>'
    ],
    'onSameBranch' => [
        [
                'property' => '<string>',
                'value' => [
                                'equals' => '<string>'
                ],
                'includeAllBranches' => true,
                'excludeBaseBranch' => false,
                'timeZone' => 'UTC',
                'textSearchDepth' => 0
        ]
    ],
    'businessIntroducers' => [
        '<string>'
    ],
    'startedAt' => [
        'start' => '2023-11-07T05:31:56Z',
        'end' => '2023-11-07T05:31:56Z'
    ],
    'stoppedAt' => [
        'start' => '2023-11-07T05:31:56Z',
        'end' => '2023-11-07T05:31:56Z'
    ],
    'endedAt' => [
        'start' => '2023-11-07T05:31:56Z',
        'end' => '2023-11-07T05:31:56Z'
    ],
    'createdAt' => [
        'start' => '2023-11-07T05:31:56Z',
        'end' => '2023-11-07T05:31:56Z'
    ],
    'hasAcknowledgedAlerts' => true,
    'awaitingFirstPayment' => true,
    'expandCustomers' => true,
    'expandAssets' => true,
    'expandBrokerageFirm' => true,
    'expandDerogations' => true,
    'queryString' => '<string>',
    'brokerageFirmName' => '<string>',
    'derogationStatuses' => [
        
    ],
    'productIds' => [
        '<string>'
    ],
    'stopReasons' => [
        '<string>'
    ],
    'authorUserIds' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "tenant: <tenant>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search"

	payload := strings.NewReader("{\n  \"pageInfo\": {\n    \"count\": 10,\n    \"page\": 1\n  },\n  \"statuses\": [],\n  \"customStatuses\": [\n    \"<string>\"\n  ],\n  \"onSameBranch\": [\n    {\n      \"property\": \"<string>\",\n      \"value\": {\n        \"equals\": \"<string>\"\n      },\n      \"includeAllBranches\": true,\n      \"excludeBaseBranch\": false,\n      \"timeZone\": \"UTC\",\n      \"textSearchDepth\": 0\n    }\n  ],\n  \"businessIntroducers\": [\n    \"<string>\"\n  ],\n  \"startedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"stoppedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"endedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"createdAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"hasAcknowledgedAlerts\": true,\n  \"awaitingFirstPayment\": true,\n  \"expandCustomers\": true,\n  \"expandAssets\": true,\n  \"expandBrokerageFirm\": true,\n  \"expandDerogations\": true,\n  \"queryString\": \"<string>\",\n  \"brokerageFirmName\": \"<string>\",\n  \"derogationStatuses\": [],\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"stopReasons\": [\n    \"<string>\"\n  ],\n  \"authorUserIds\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("tenant", "<tenant>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search")
  .header("tenant", "<tenant>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pageInfo\": {\n    \"count\": 10,\n    \"page\": 1\n  },\n  \"statuses\": [],\n  \"customStatuses\": [\n    \"<string>\"\n  ],\n  \"onSameBranch\": [\n    {\n      \"property\": \"<string>\",\n      \"value\": {\n        \"equals\": \"<string>\"\n      },\n      \"includeAllBranches\": true,\n      \"excludeBaseBranch\": false,\n      \"timeZone\": \"UTC\",\n      \"textSearchDepth\": 0\n    }\n  ],\n  \"businessIntroducers\": [\n    \"<string>\"\n  ],\n  \"startedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"stoppedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"endedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"createdAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"hasAcknowledgedAlerts\": true,\n  \"awaitingFirstPayment\": true,\n  \"expandCustomers\": true,\n  \"expandAssets\": true,\n  \"expandBrokerageFirm\": true,\n  \"expandDerogations\": true,\n  \"queryString\": \"<string>\",\n  \"brokerageFirmName\": \"<string>\",\n  \"derogationStatuses\": [],\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"stopReasons\": [\n    \"<string>\"\n  ],\n  \"authorUserIds\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.korint.io/brokerage-firms/{brokerageFirmId}/policies/search")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["tenant"] = '<tenant>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"pageInfo\": {\n    \"count\": 10,\n    \"page\": 1\n  },\n  \"statuses\": [],\n  \"customStatuses\": [\n    \"<string>\"\n  ],\n  \"onSameBranch\": [\n    {\n      \"property\": \"<string>\",\n      \"value\": {\n        \"equals\": \"<string>\"\n      },\n      \"includeAllBranches\": true,\n      \"excludeBaseBranch\": false,\n      \"timeZone\": \"UTC\",\n      \"textSearchDepth\": 0\n    }\n  ],\n  \"businessIntroducers\": [\n    \"<string>\"\n  ],\n  \"startedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"stoppedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"endedAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"createdAt\": {\n    \"start\": \"2023-11-07T05:31:56Z\",\n    \"end\": \"2023-11-07T05:31:56Z\"\n  },\n  \"hasAcknowledgedAlerts\": true,\n  \"awaitingFirstPayment\": true,\n  \"expandCustomers\": true,\n  \"expandAssets\": true,\n  \"expandBrokerageFirm\": true,\n  \"expandDerogations\": true,\n  \"queryString\": \"<string>\",\n  \"brokerageFirmName\": \"<string>\",\n  \"derogationStatuses\": [],\n  \"productIds\": [\n    \"<string>\"\n  ],\n  \"stopReasons\": [\n    \"<string>\"\n  ],\n  \"authorUserIds\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "customerIds": [
        "<string>"
      ],
      "policyId": "<string>",
      "branches": [
        {
          "policy": {
            "id": "<string>",
            "productId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "lastModifiedAt": "2023-11-07T05:31:56Z",
            "hasOpenedClientAccount": true,
            "customFields": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ],
            "externalId": "<string>",
            "author": {
              "firstName": "<string>",
              "lastName": "<string>",
              "userId": "<string>",
              "email": "jsmith@example.com",
              "brokerRole": "<string>"
            },
            "signedAt": "2023-11-07T05:31:56Z",
            "startedAt": "2023-11-07T05:31:56Z",
            "isAwaitingFirstPayment": true,
            "endedAt": "2023-11-07T05:31:56Z",
            "stoppedAt": "2023-11-07T05:31:56Z",
            "stop": {
              "reason": "<string>",
              "details": [
                {
                  "key": "<string>",
                  "value": "<string>"
                }
              ],
              "createdAt": "<string>"
            },
            "totalPremium": {
              "amountPreFeesAndTaxes": 123,
              "totalFees": 123,
              "amountWithFeesPreTaxes": 123,
              "totalTaxes": 123,
              "amountWithFeesAndTaxes": 123
            }
          },
          "branch": {
            "branchId": "<string>",
            "createdAt": "2023-11-07T05:31:56Z",
            "mergedAt": "2023-11-07T05:31:56Z",
            "derogations": [
              {
                "derogationId": "<string>",
                "createdAt": "2023-11-07T05:31:56Z"
              }
            ]
          },
          "customers": [
            {
              "type": "<string>",
              "id": "<string>",
              "createdAt": "2023-11-07T05:31:56Z",
              "lastModifiedAt": "2023-11-07T05:31:56Z",
              "role": "<string>",
              "customFields": [
                {
                  "key": "<string>",
                  "value": "<string>"
                }
              ],
              "name": "<string>"
            }
          ],
          "assets": [
            {
              "id": "<string>",
              "lastModifiedAt": "2023-11-07T05:31:56Z",
              "createdAt": "2023-11-07T05:31:56Z",
              "customFields": [
                {
                  "key": "<string>",
                  "value": "<string>"
                }
              ],
              "startedAt": "2023-11-07T05:31:56Z",
              "stoppedAt": "2023-11-07T05:31:56Z",
              "totalPremium": {
                "amountPreFeesAndTaxes": 123,
                "totalFees": 123,
                "amountWithFeesPreTaxes": 123,
                "totalTaxes": 123,
                "amountWithFeesAndTaxes": 123
              }
            }
          ],
          "brokerageFirm": {
            "id": "<string>",
            "companyInfo": {
              "siret": "<string>",
              "siren": "<string>",
              "nafCode": "<string>",
              "nafLabel": "<string>",
              "name": "<string>",
              "creationDate": "2023-11-07T05:31:56Z",
              "location": {
                "city": "<string>",
                "country": "<string>",
                "address": "<string>",
                "postCode": "<string>"
              },
              "legalStatus": {
                "1": "<string>",
                "2": "<string>",
                "3": "<string>"
              },
              "headcount": "<string>",
              "isActive": true
            },
            "customFields": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ]
          },
          "parentBrokerageFirm": {
            "id": "<string>",
            "companyInfo": {
              "siret": "<string>",
              "siren": "<string>",
              "nafCode": "<string>",
              "nafLabel": "<string>",
              "name": "<string>",
              "creationDate": "2023-11-07T05:31:56Z",
              "location": {
                "city": "<string>",
                "country": "<string>",
                "address": "<string>",
                "postCode": "<string>"
              },
              "legalStatus": {
                "1": "<string>",
                "2": "<string>",
                "3": "<string>"
              },
              "headcount": "<string>",
              "isActive": true
            },
            "customFields": [
              {
                "key": "<string>",
                "value": "<string>"
              }
            ]
          },
          "derogations": [
            {
              "id": "<string>",
              "policyId": "<string>"
            }
          ]
        }
      ]
    }
  ],
  "pageInfo": {
    "first": true,
    "last": true
  },
  "totalCount": 123,
  "currentPage": 123,
  "totalPages": 123
}

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.

Path Parameters

brokerageFirmId

string

required

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

Body

application/json

viewType

enum<string>

required

View type

Available options:

newBusiness,

archivedNewBusiness,

derogation,

live

pageInfo

object

the page info

Show child attributes

order

object

the sort options

Show child attributes

statuses

enum<string>[]

Statuses to filter by

Available options:

POLICY_CREATED,

POLICY_QUOTED,

POLICY_CONFIRMED,

POLICY_SIGNED,

POLICY_STARTED,

POLICY_STOPPED,

POLICY_SUSPENDED

customStatuses

string[]

Custom statuses to filter by

onSameBranch

object[]

Conditions that must be satisfied on the same branch simultaneously

Show child attributes

businessIntroducers

string[]

Business introducers to filter by

startedAt

object

Started at range

Show child attributes

stoppedAt

object

Stopped at range

Show child attributes

endedAt

object

Ended at range (contract end date / due date)

Show child attributes

createdAt

object

Created at range

Show child attributes

hasAcknowledgedAlerts

boolean

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

awaitingFirstPayment

boolean

Signed but awaiting first payment: CONFIRMED, signed, start date passed, on a product that gates activation on first payment.

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

stopReasons

string[]

List of stop reasons to filter by

authorUserIds

string[]

Filter by assigned broker (policy author) user 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