POST api/Insured/InsuredPolicies
Insured policies list endpoint.
Request Information
URI Parameters
None.
Body Parameters
List of insured database Ids.
InsuredDataBaseIds| Name | Description | Type | Additional information |
|---|---|---|---|
| InsuredDataBaseId | Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"insuredDataBaseId": [
"e28e367c-5dd9-462f-b6f9-e5e4514639c1",
"408b24c7-a172-4d74-b8dc-ea91bf1c9971"
]
}
application/xml, text/xml
Sample:
<InsuredDataBaseIds xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData">
<InsuredDataBaseId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:guid>e28e367c-5dd9-462f-b6f9-e5e4514639c1</d2p1:guid>
<d2p1:guid>408b24c7-a172-4d74-b8dc-ea91bf1c9971</d2p1:guid>
</InsuredDataBaseId>
</InsuredDataBaseIds>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
List of InsuredPolicies against given insured database Ids.
InsuredPolicies| Name | Description | Type | Additional information |
|---|---|---|---|
| DatabaseId | globally unique identifier |
None. |
|
| Number | string |
None. |
|
| IsQuote | boolean |
None. |
|
| EffectiveDate | date |
None. |
|
| ExpirationDate | date |
None. |
|
| BindDate | date |
None. |
|
| BusinessType | PolicyBusinessType |
None. |
|
| BusinessSubType | PolicyBusinessSubType |
None. |
|
| Description | string |
None. |
|
| BillingType | PolicyBillingType |
None. |
|
| LinesOfBusiness | Collection of string |
None. |
|
| CarrierName | string |
None. |
|
| MgaName | string |
None. |
|
| TotalPremium | decimal number |
None. |
|
| TotalNonPremium | decimal number |
None. |
|
| TotalAgencyCommission | decimal number |
None. |
|
| ChangeDate | date |
None. |
|
| CreateDate | date |
None. |
|
| CancellationDate | date |
None. |
|
| ReinstatementDate | date |
None. |
|
| Active | boolean |
None. |
|
| RenewedPolicyId | globally unique identifier |
None. |
|
| RenewedPolicyNumber | string |
None. |
|
| InsuredDatabaseId | globally unique identifier |
None. |
|
| Status | string |
None. |
|
| PolicyTermInMonths | integer |
None. |
|
| BillingCompanyId | globally unique identifier |
None. |
|
| BillingCompanyName | string |
None. |
|
| CurrentTermAmount | decimal number |
None. |
Response Formats
application/json, text/json
Sample:
{
"databaseId": "6f2b873d-2135-4565-8535-3b24896b40e3",
"number": "sample string 2",
"isQuote": true,
"effectiveDate": "2025-05-30T22:09:03.3012869-05:00",
"expirationDate": "2025-05-30T22:09:03.3012869-05:00",
"bindDate": "2025-05-30T22:09:03.3012869-05:00",
"businessType": 0,
"businessSubType": 0,
"description": "sample string 4",
"billingType": 0,
"linesOfBusiness": [
"sample string 1",
"sample string 2"
],
"carrierName": "sample string 5",
"mgaName": "sample string 6",
"totalPremium": 1.0,
"totalNonPremium": 1.0,
"totalAgencyCommission": 1.0,
"changeDate": "2025-05-30T22:09:03.3169377-05:00",
"createDate": "2025-05-30T22:09:03.3169377-05:00",
"cancellationDate": "2025-05-30T22:09:03.3169377-05:00",
"reinstatementDate": "2025-05-30T22:09:03.3169377-05:00",
"active": true,
"renewedPolicyId": "0581bce8-65aa-4cfa-a8be-b75331de0d24",
"renewedPolicyNumber": "sample string 10",
"insuredDatabaseId": "dfeff9b2-08f6-47bf-a088-0f1c9b892155",
"status": "sample string 12",
"policyTermInMonths": 13,
"billingCompanyId": "470711ea-3e3f-4cd4-94d6-8d9f1db3f932",
"billingCompanyName": "sample string 14",
"currentTermAmount": 15.0
}
application/xml, text/xml
Sample:
<InsuredPolicies xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
<Active>true</Active>
<BillingCompanyId>470711ea-3e3f-4cd4-94d6-8d9f1db3f932</BillingCompanyId>
<BillingCompanyName>sample string 14</BillingCompanyName>
<BillingType>Direct_Bill_100</BillingType>
<BindDate>2025-05-30T22:09:03.3012869-05:00</BindDate>
<BusinessSubType>AgentOfRecord</BusinessSubType>
<BusinessType>New_Business</BusinessType>
<CancellationDate>2025-05-30T22:09:03.3169377-05:00</CancellationDate>
<CarrierName>sample string 5</CarrierName>
<ChangeDate>2025-05-30T22:09:03.3169377-05:00</ChangeDate>
<CreateDate>2025-05-30T22:09:03.3169377-05:00</CreateDate>
<CurrentTermAmount>15</CurrentTermAmount>
<DatabaseId>6f2b873d-2135-4565-8535-3b24896b40e3</DatabaseId>
<Description>sample string 4</Description>
<EffectiveDate>2025-05-30T22:09:03.3012869-05:00</EffectiveDate>
<ExpirationDate>2025-05-30T22:09:03.3012869-05:00</ExpirationDate>
<InsuredDatabaseId>dfeff9b2-08f6-47bf-a088-0f1c9b892155</InsuredDatabaseId>
<IsQuote>true</IsQuote>
<LinesOfBusiness xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:string>sample string 1</d2p1:string>
<d2p1:string>sample string 2</d2p1:string>
</LinesOfBusiness>
<MgaName>sample string 6</MgaName>
<Number>sample string 2</Number>
<PolicyTermInMonths>13</PolicyTermInMonths>
<ReinstatementDate>2025-05-30T22:09:03.3169377-05:00</ReinstatementDate>
<RenewedPolicyId>0581bce8-65aa-4cfa-a8be-b75331de0d24</RenewedPolicyId>
<RenewedPolicyNumber>sample string 10</RenewedPolicyNumber>
<Status>sample string 12</Status>
<TotalAgencyCommission>1</TotalAgencyCommission>
<TotalNonPremium>1</TotalNonPremium>
<TotalPremium>1</TotalPremium>
</InsuredPolicies>