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": [
"POLICY_CREATED"
],
"customStatuses": [
"<string>"
],
"businessIntroducers": [
"<string>"
],
"startedAt": {
"start": "<string>",
"end": "<string>"
},
"stoppedAt": {
"start": "<string>",
"end": "<string>"
},
"createdAt": {
"start": "<string>",
"end": "<string>"
},
"hasAcknowledgedAlerts": true,
"expandCustomers": true,
"expandAssets": true,
"expandBrokerageFirm": true,
"expandDerogations": true,
"queryString": "<string>",
"brokerageFirmName": "<string>",
"derogationStatuses": [
"PENDING"
],
"productIds": [
"<string>"
],
"stopReasons": [
"<string>"
]
}
'{
"data": [
{
"customerIds": [
"<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>",
"author": {
"firstName": "<string>",
"lastName": "<string>",
"userId": "<string>",
"email": "<string>",
"brokerRole": "<string>"
},
"startedAt": "<string>",
"stoppedAt": "<string>",
"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": "<string>",
"branchType": "BASE",
"renewalStatus": "RENEWAL_ACCEPTED",
"branchSubType": "CREATE_ADDITIONAL_COMPONENTS",
"availability": "BRANCH_OPEN",
"closeReason": "BROKER_REQUEST",
"mergedAt": "<string>",
"derogations": [
{
"derogationId": "<string>",
"action": "QUOTE",
"status": "CREATED",
"createdAt": "<string>"
}
]
},
"customers": [
{
"type": "<string>",
"id": "<string>",
"createdAt": "<string>",
"lastModifiedAt": "<string>",
"status": "CUSTOMER_CREATED",
"role": "<string>",
"paymentMode": "DIRECT_DEBIT",
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"name": "<string>"
}
],
"assets": [
{
"id": "<string>",
"lastModifiedAt": "<string>",
"createdAt": "<string>",
"status": "ASSET_CREATED",
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"startedAt": "<string>",
"stoppedAt": "<string>",
"totalPremium": {
"amountPreFeesAndTaxes": 123,
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
}
}
],
"brokerageFirm": {
"firmType": "WHOLESALE",
"id": "<string>",
"companyInfo": {
"siret": "<string>",
"siren": "<string>",
"nafCode": "<string>",
"nafLabel": "<string>",
"name": "<string>",
"creationDate": "<string>",
"location": {
"city": "<string>",
"country": "<string>",
"address": "<string>",
"postCode": "<string>"
},
"legalStatus": {
"1": "<string>",
"2": "<string>",
"3": "<string>"
},
"headcount": "<string>"
},
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"parentBrokerageFirm": {
"firmType": "WHOLESALE",
"id": "<string>",
"companyInfo": {
"siret": "<string>",
"siren": "<string>",
"nafCode": "<string>",
"nafLabel": "<string>",
"name": "<string>",
"creationDate": "<string>",
"location": {
"city": "<string>",
"country": "<string>",
"address": "<string>",
"postCode": "<string>"
},
"legalStatus": {
"1": "<string>",
"2": "<string>",
"3": "<string>"
},
"headcount": "<string>"
},
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"derogations": [
{
"id": "<string>",
"status": "PENDING",
"policyId": "<string>"
}
]
}
]
}
],
"pageInfo": {
"first": true,
"last": true
},
"totalCount": 123,
"currentPage": 123,
"totalPages": 123
}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": [
"POLICY_CREATED"
],
"customStatuses": [
"<string>"
],
"businessIntroducers": [
"<string>"
],
"startedAt": {
"start": "<string>",
"end": "<string>"
},
"stoppedAt": {
"start": "<string>",
"end": "<string>"
},
"createdAt": {
"start": "<string>",
"end": "<string>"
},
"hasAcknowledgedAlerts": true,
"expandCustomers": true,
"expandAssets": true,
"expandBrokerageFirm": true,
"expandDerogations": true,
"queryString": "<string>",
"brokerageFirmName": "<string>",
"derogationStatuses": [
"PENDING"
],
"productIds": [
"<string>"
],
"stopReasons": [
"<string>"
]
}
'{
"data": [
{
"customerIds": [
"<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>",
"author": {
"firstName": "<string>",
"lastName": "<string>",
"userId": "<string>",
"email": "<string>",
"brokerRole": "<string>"
},
"startedAt": "<string>",
"stoppedAt": "<string>",
"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": "<string>",
"branchType": "BASE",
"renewalStatus": "RENEWAL_ACCEPTED",
"branchSubType": "CREATE_ADDITIONAL_COMPONENTS",
"availability": "BRANCH_OPEN",
"closeReason": "BROKER_REQUEST",
"mergedAt": "<string>",
"derogations": [
{
"derogationId": "<string>",
"action": "QUOTE",
"status": "CREATED",
"createdAt": "<string>"
}
]
},
"customers": [
{
"type": "<string>",
"id": "<string>",
"createdAt": "<string>",
"lastModifiedAt": "<string>",
"status": "CUSTOMER_CREATED",
"role": "<string>",
"paymentMode": "DIRECT_DEBIT",
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"name": "<string>"
}
],
"assets": [
{
"id": "<string>",
"lastModifiedAt": "<string>",
"createdAt": "<string>",
"status": "ASSET_CREATED",
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
],
"startedAt": "<string>",
"stoppedAt": "<string>",
"totalPremium": {
"amountPreFeesAndTaxes": 123,
"totalFees": 123,
"amountWithFeesPreTaxes": 123,
"totalTaxes": 123,
"amountWithFeesAndTaxes": 123
}
}
],
"brokerageFirm": {
"firmType": "WHOLESALE",
"id": "<string>",
"companyInfo": {
"siret": "<string>",
"siren": "<string>",
"nafCode": "<string>",
"nafLabel": "<string>",
"name": "<string>",
"creationDate": "<string>",
"location": {
"city": "<string>",
"country": "<string>",
"address": "<string>",
"postCode": "<string>"
},
"legalStatus": {
"1": "<string>",
"2": "<string>",
"3": "<string>"
},
"headcount": "<string>"
},
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"parentBrokerageFirm": {
"firmType": "WHOLESALE",
"id": "<string>",
"companyInfo": {
"siret": "<string>",
"siren": "<string>",
"nafCode": "<string>",
"nafLabel": "<string>",
"name": "<string>",
"creationDate": "<string>",
"location": {
"city": "<string>",
"country": "<string>",
"address": "<string>",
"postCode": "<string>"
},
"legalStatus": {
"1": "<string>",
"2": "<string>",
"3": "<string>"
},
"headcount": "<string>"
},
"customFields": [
{
"key": "<string>",
"value": "<string>"
}
]
},
"derogations": [
{
"id": "<string>",
"status": "PENDING",
"policyId": "<string>"
}
]
}
]
}
],
"pageInfo": {
"first": true,
"last": true
},
"totalCount": 123,
"currentPage": 123,
"totalPages": 123
}View type
newBusiness, derogation, live the page info
Show child attributes
the sort options
Show child attributes
Statuses to filter by
POLICY_CREATED, POLICY_QUOTED, POLICY_CONFIRMED, POLICY_STARTED, POLICY_STOPPED, POLICY_SUSPENDED Custom statuses to filter by
Business introducers to filter by
Started at range
Show child attributes
Stopped at range
Show child attributes
Created at range
Show child attributes
Optional: if filled, returns policies with at least one alert which acknowledgement matches this attribute
Full text search
Brokerage firm name
Filter by derogation status
PENDING, DECLINED, APPROVED List of product ids
List of stop reasons to filter by
Was this page helpful?