Topics on this page

Retrieve and display policy information

BriteCore offers a policy administration system used to execute core processes like rating, underwriting, binding, issuing, endorsing, canceling/rescinding cancellation, reinstating, and renewing policies. It is the system of record for all policies written by an insurance carrier.

The BritePolicies API allows you to track the state of a policy and insurable risks at any point in time and offers BriteCore applications, clients, and third-party partners a secure way to read policy data.

BritePolicies interacts with other products in BriteCore such as BriteLines, BriteQuote, BriteRules, and BriteDocs to allow you to:

  • View policy information, including contacts, insurable risk, coverages, limits, and premiums.
  • View policy transaction history, including when, what, and by whom.
  • Compare transactions; you can view what was changed and the previous endorsement.

BritePolicies API functionality includes:

  • Accepting data from BriteQuote.
  • Reporting facts about policies and how those facts change over time.
  • Accessing/searching quotes, apps, and policies.
  • Handling underwriting decisioning tools through BriteRules and BriteLines.
  • Communicating with agents and insureds.
  • Initiating endorsements through BriteQuote. Endorsements in BriteCore are referred to as revisions.
  • Handling cancellations, reinstatements, revisions, and renewals through BriteQuote.

This tutorial will guide you through retrieving and displaying policy information with BritePolicies APIs and the relevant endpoints to include. It will also cover the key concepts needed to understand policies in BriteCore, including policies process flow, policy revisions, and status. We included a sample Policies UI screen to illustrate how different BriteCore products can be pulled into a single portal.

Note: BriteQuote handles all policies transaction services, such as binding a quote/creating a policy, creating or updating endorsements, cancellations, reinstatements, rewrites, and renewals. BritePolicies acts like a hub for all policy-related information.

Key concepts

  • Coverage: A guarantee of financial restoration in the event of a loss.
  • Endorsement transactions: Revisions to the in-force policies.
  • Inception to Date (ITD): ITD includes historical policy data and in-force data.
  • In-force policies: Insurance policies that are currently under contract.
  • Policy: A contract that guarantees insurance coverage for a given duration of time.
  • Premium: Money paid by a policyholder to an insurance carrier in exchange for insurance.
  • Risk: An asset protected by insurance.

Policies process flow

Quotes are submitted to BritePolicies when they are ready to become bound, in-force policies. In BriteCore, a policy’s status depends on where it is in the policy lifecycle.

Figure 1: A policy’s flow from the policy application submission to active policies, including possible transactions on an active policy.

Policy status in BriteCore

Policy status indicates the current state of the policy and appears on each revision. See Table 1 below for a summary of policy statuses and descriptions.

Table 1: BriteCore’s policy statuses and their descriptions.

BriteCore ProductPolicy Status
Description
BriteQuoteUnsubmittedQuote or application hasn't been submitted by the agent from the Agent portal.
BriteQuoteSubmittedApplication is submitted but pending processing by an underwriter.
BriteQuoteRejectedApplication was rejected by an underwriter.
BritePoliciesActiveOnce a quote is committed/bound, a policy is considered in-force and active in BriteCore.
BritePoliciesCanceledPolicy isn't in effect.
BritePoliciesCancellation PendingPolicy is currently in effect but won't be as of a future date.
BritePoliciesExpiredPolicy was non-renewed and isn't in effect.

Policy revisions in BriteCore

A revision is the foundation of a policy and tracks the changes made to a policy over time, including written premium. The following revision states indicate whether the revision’s information is in effect:

  • Committed: The data associated with the revision is in effect and can be reported on.
  • Open: The data associated with the revision is in progress and, therefore, isn’t in effect and can’t be reported on.
  • Pending: The data associated with the revision is in progress and, therefore, isn’t in effect and can’t be reported on.
  • Archived: The data associated with the revision was at one time in effect and can be reported on.

Sample Policies dashboard

Figure 2 shows a sample UI screen that illustrates how data from different BriteCore products can be pulled into a Policies screen.

Figure 2: Sample Policies dashboard.

Use BritePolicies API to set up a Policies dashboard

This section will walk you through specific BritePolicies API endpoints to select for your Policies dashboard.

Step 1: Get a security token

You will need to request an ID and Secret to use OAuth 2.0.

For more information, refer to How do I get started?

Note: Blocks of code are hidden by default to make the page more navigable. Select View code and Hide code to view or hide these sections as needed.

Step 2: List all policies

Use ListPolicy endpoint (/policies/policies/) to get a list of all policies. You will use the Policy ID from this list to retrieve policy details in the next step.

Sample request

View code

curl --request GET \
--url /policies/policies/ \
--header 'authorization: Bearer ' \
--cookie XSRF-TOKEN=11d50576-ef36-4e31-a985-c19ab0c3895e

Sample response

View code

"data": [
{
"type": "policies",
"id": "00005395-6166-409a-9b52-b90788b4e27a",
"attributes": {
"policy_number": "4032412",
"policy_number_origin": "v1",
"policy_number_normalized": "4032412",
"active": 1,
"rewritten": 0,
"show_app": 1,
"date_added": "2017-05-22T21:16:01Z",
"copied_from_rev_id": null,
"copied_to_rev_id": null,
"flag": "white",
"inception_date": "2008-08-14",
"system_tags": "{}",
"submit_bound": 0,
"submit_receipt_email": null,
"submit_receipt_name": null,
"submit_confirm_email": null,
"submit_confirm_name": null,
"date_updated": "2017-06-09T01:08:28Z",
"do_not_automatically_rewrite": 0
},
"relationships": {
"policy_terms": {
"data": [
{
"type": "policy-terms",
"id": "1ecc062f-2342-43d1-8506-d0bd295b1afa"
},
{
"type": "policy-terms",
"id": "36b04976-b103-4632-9fdd-09004415a794"
}
],
"meta": {
"count": 2
}
}
}
},
{
"type": "policies",
"id": "0002cc78-3589-402d-9379-31a98ce1295a",
"attributes": {
"policy_number": "10-2018-4080",
"policy_number_origin": "v1",
"policy_number_normalized": "1020184080",
"active": 0,
"rewritten": 0,
"show_app": 1,
"date_added": "2018-06-18T19:36:15Z",
"copied_from_rev_id": null,
"copied_to_rev_id": null,
"flag": "white",
"inception_date": "2018-06-18",
"system_tags": null,
"submit_bound": 0,
"submit_receipt_email": "",
"submit_receipt_name": "",
"submit_confirm_email": "",
"submit_confirm_name": "",
"date_updated": "2018-06-18T19:46:21Z",
"do_not_automatically_rewrite": 0
},
"relationships": {
"policy_terms": {
"data": [
{
"type": "policy-terms",
"id": "fcbad197-73ad-41cb-9af9-ea0d33a57ed0"
}
],
"meta": {
"count": 1
}
}
}
},
{
"type": "policies",
"id": "0007b158-0cae-4299-a0e0-2827ee37fc1f",
"attributes": {
"policy_number": "4030130",
"policy_number_origin": "v1",
"policy_number_normalized": "4030130",
"active": 0,
"rewritten": 0,
"show_app": 1,
"date_added": "2016-12-08T23:07:41Z",
"copied_from_rev_id": null,
"copied_to_rev_id": null,
"flag": "white",
"inception_date": "2006-02-27",
"system_tags": "{}",
"submit_bound": 0,
"submit_receipt_email": null,
"submit_receipt_name": null,
"submit_confirm_email": null,
"submit_confirm_name": null,
"date_updated": "2017-06-09T01:08:28Z",
"do_not_automatically_rewrite": 0
},
"relationships": {
"policy_terms": {
"data": [
{
"type": "policy-terms",
"id": "73b99e86-6c24-4ea9-911c-8ec89c7f09cd"
}
],
"meta": {
"count": 1
}
}
}
},
{
"type": "policies",
"id": "0009e01d-e3cd-43a1-a941-7e9c2247e6fe",
"attributes": {
"policy_number": "4034945",
"policy_number_origin": "manual",
"policy_number_normalized": "",
"active": 1,
"rewritten": 0,
"show_app": 1,
"date_added": "2017-09-20T22:59:42Z",
"copied_from_rev_id": null,
"copied_to_rev_id": null,
"flag": "white",
"inception_date": "2012-12-07",
"system_tags": "{}",
"submit_bound": 0,
"submit_receipt_email": null,
"submit_receipt_name": null,
"submit_confirm_email": null,
"submit_confirm_name": null,
"date_updated": "2017-09-20T22:59:42Z",
"do_not_automatically_rewrite": 0
},
"relationships": {
"policy_terms": {
"data": [
{
"type": "policy-terms",
"id": "63346360-8936-44f6-b26d-c2d372e8ae6a"
},
{
"type": "policy-terms",
"id": "edcde7d4-7fa9-4d83-b2d5-30ce3f46ce5c"
}
],
"meta": {
"count": 2
}
}
}
},
{
"type": "policies",
"id": "000c1989-5bc1-45bc-8c77-77186def1ebf",
"attributes": {
"policy_number": "4025420",
"policy_number_origin": "manual",
"policy_number_normalized": "",
"active": 1,
"rewritten": 0,
"show_app": 1,
"date_added": "2017-08-10T22:32:45Z",
"copied_from_rev_id": null,
"copied_to_rev_id": null,
"flag": "white",
"inception_date": "2003-11-24",
"system_tags": "{}",
"submit_bound": 0,
"submit_receipt_email": "",
"submit_receipt_name": "",
"submit_confirm_email": "ninad8@yahoo.com",
"submit_confirm_name": "Nina",
"date_updated": "2018-11-15T19:45:37Z",
"do_not_automatically_rewrite": 0
},
"relationships": {
"policy_terms": {
"data": [
{
"type": "policy-terms",
"id": "4ac2950c-d6f4-4e4a-8e9f-60b55b94b053"
},
{
"type": "policy-terms",
"id": "2fcd1da9-611a-459c-8378-3cc2a8314a8c"
}
],
"meta": {
"count": 2
}
}
}
}

Step 3: Retrieve policy details

Use retrievePolicy endpoint (/policies/policies/{policy_id}) to retrieve policy details. You must pass the policy_id from the request above.

Sample request

View code

curl --request GET \
--url https://api.policies-sandbox.britecore.com/policies/policies/d4b94c2b-81e7-42f3-8ec0-62e4ac0bdbef \
--header 'authorization: \
--cookie XSRF-TOKEN=11d50576-ef36-4e31-a985-c19ab0c3895e

Sample response

View code

{
"data": {
"type": "policies",
"id": "d4b94c2b-81e7-42f3-8ec0-62e4ac0bdbef",
"attributes": {
"policy_number": "10-2020-192",
"policy_number_origin": "v1",
"policy_number_normalized": "102020192",
"active": 1,
"rewritten": 0,
"show_app": 1,
"date_added": "2020-07-09T12:36:50Z",
"copied_from_rev_id": null,
"copied_to_rev_id": null,
"flag": "white",
"inception_date": "2020-07-09",
"system_tags": null,
"submit_bound": 0,
"submit_receipt_email": null,
"submit_receipt_name": null,
"submit_confirm_email": null,
"submit_confirm_name": null,
"date_updated": "2020-07-09T12:36:50Z",
"do_not_automatically_rewrite": 0
},
"relationships": {
"policy_terms": {
"data": [
{
"type": "policy-terms",
"id": "726072c5-58ae-44ed-9857-453204d57bf9"
}
],
"meta": {
"count": 1
}
}
}
},
"included": [
{
"type": "policy-terms",
"id": "726072c5-58ae-44ed-9857-453204d57bf9",
"attributes": {
"effective_date": "2020-07-09",
"expiration_date": "2021-07-09",
"term_type": "1 Year"
},
"relationships": {
"policy": {
"data": {
"type": "policies",
"id": "d4b94c2b-81e7-42f3-8ec0-62e4ac0bdbef"
}
}
}
}
]
}

Step 4: List all policy revisions (endorsements)

Use listRevision (policies/revisions/) to obtain all the revision IDs and details for your policies. You will need the revision ID for step 5.

Sample request

View code


curl --request GET \
--url https://api.policies-sandbox.britecore.com/policies/revisions/ \
--header 'authorization: enter your access token here' \
--cookie XSRF-TOKEN=11d50576-ef36-4e31-a985-c19ab0c3895e

Sample response

View code

"data": [
{
"type": "revisions",
"id": "492cbd84-11f6-4322-a26e-4ea40f927738",
"attributes": {
"britelines_product_name": "",
"cancel_date": null,
"commission_rate": "0.0000",
"commit_date": null,
"create_date": "2018-08-14T15:42:14Z",
"date_archived": null,
"dec_description": null,
"description": null,
"written_fee": "0.00",
"grant_mortgagee_extension": 0,
"override_commission": 0,
"policy_status": "Active",
"policy_status_reason_id": null,
"written_premium": "380.00",
"written_premium_delta": "0.00",
"print_dec": 1,
"reinstate_at_commit": 0,
"revision_date": "2051-02-01",
"revision_state": "open",
"annual_fee": "0.00",
"annual_premium": "380.00",
"underwriting_questions": null,
"underwriting_contacted": 0,
"underwriting_contact_date": null,
"builder_pending": 0,
"deleted": 0,
"credit_report_permissions": null,
"date_updated": "2018-08-14T15:42:14Z",
"last_visited": null,
"builder_ready_to_rate": 0,
"review_workflow_state": "NOT_STARTED",
"review_workflow_request_reason": null,
"underwriting_options": null
},
"relationships": {
"policy": {
"data": {
"type": "policies",
"id": "88fb78ef-740f-4a57-bae5-512d5dc66c66"
}
},
"policy_type": {
"data": {
"type": "policy-types",
"id": "c091db52-151a-4fb7-9fc0-1b21e4a952c0"
}
},
"policy_term": {
"data": {
"type": "policy-terms",
"id": "2a0eea55-0b2f-4972-9bcf-886dbc39b9e4"
}
}
}
},
{
"type": "revisions",
"id": "b55aa96d-82d2-4e2d-aea1-cda712d9c143",
"attributes": {
"britelines_product_name": "",
"cancel_date": null,
"commission_rate": "0.0000",
"commit_date": null,
"create_date": "2018-07-18T15:12:50Z",
"date_archived": "2018-08-14T10:42:14Z",
"dec_description": null,
"description": null,
"written_fee": "0.00",
"grant_mortgagee_extension": 0,
"override_commission": 0,
"policy_status": "Active",
"policy_status_reason_id": null,
"written_premium": "380.00",
"written_premium_delta": "0.00",
"print_dec": 1,
"reinstate_at_commit": 0,
"revision_date": "2051-02-01",
"revision_state": "archived",
"annual_fee": "0.00",
"annual_premium": "380.00",
"underwriting_questions": null,
"underwriting_contacted": 0,
"underwriting_contact_date": null,
"builder_pending": 0,
"deleted": 0,
"credit_report_permissions": null,
"date_updated": "2018-08-14T15:42:14Z",
"last_visited": null,
"builder_ready_to_rate": 0,
"review_workflow_state": "NOT_STARTED",
"review_workflow_request_reason": null,
"underwriting_options": null
},
"relationships": {
"policy": {
"data": {
"type": "policies",
"id": "88fb78ef-740f-4a57-bae5-512d5dc66c66"
}
},
"policy_type": {
"data": {
"type": "policy-types",
"id": "c091db52-151a-4fb7-9fc0-1b21e4a952c0"
}
},
"policy_term": {
"data": {
"type": "policy-terms",
"id": "2a0eea55-0b2f-4972-9bcf-886dbc39b9e4"
}
}
}
},
{
"type": "revisions",
"id": "88cc04f2-c5ee-4313-a67c-9a86dfd101e3",
"attributes": {
"britelines_product_name": "",
"cancel_date": null,
"commission_rate": "0.0000",
"commit_date": null,
"create_date": "2018-07-17T19:34:56Z",
"date_archived": "2018-07-18T10:12:50Z",
"dec_description": null,
"description": null,
"written_fee": "0.00",
"grant_mortgagee_extension": 0,
"override_commission": 0,
"policy_status": "Active",
"policy_status_reason_id": null,
"written_premium": "380.00",
"written_premium_delta": "0.00",
"print_dec": 1,
"reinstate_at_commit": 0,
"revision_date": "2051-02-01",
"revision_state": "archived",
"annual_fee": "0.00",
"annual_premium": "380.00",
"underwriting_questions": null,
"underwriting_contacted": 0,
"underwriting_contact_date": null,
"builder_pending": 0,
"deleted": 0,
"credit_report_permissions": null,
"date_updated": "2018-07-18T15:12:50Z",
"last_visited": null,
"builder_ready_to_rate": 0,
"review_workflow_state": "NOT_STARTED",
"review_workflow_request_reason": null,
"underwriting_options": null
},
"relationships": {
"policy": {
"data": {
"type": "policies",
"id": "88fb78ef-740f-4a57-bae5-512d5dc66c66"
}
},
"policy_type": {
"data": {
"type": "policy-types",
"id": "c091db52-151a-4fb7-9fc0-1b21e4a952c0"
}
},
"policy_term": {
"data": {
"type": "policy-terms",
"id": "2a0eea55-0b2f-4972-9bcf-886dbc39b9e4"
}
}
}
},
{
"type": "revisions",
"id": "f878836d-6bdf-4716-b27f-c4f0b3695711",
"attributes": {
"britelines_product_name": "",
"cancel_date": null,
"commission_rate": "0.0000",
"commit_date": null,
"create_date": "2018-07-17T19:31:51Z",
"date_archived": "2018-07-17T14:34:56Z",
"dec_description": null,
"description": null,
"written_fee": "0.00",
"grant_mortgagee_extension": 0,
"override_commission": 0,
"policy_status": "Active",
"policy_status_reason_id": null,
"written_premium": "380.00",
"written_premium_delta": "0.00",
"print_dec": 1,
"reinstate_at_commit": 0,
"revision_date": "2051-02-01",
"revision_state": "archived",
"annual_fee": "0.00",
"annual_premium": "380.00",
"underwriting_questions": null,
"underwriting_contacted": 0,
"underwriting_contact_date": null,
"builder_pending": 0,
"deleted": 0,
"credit_report_permissions": null,
"date_updated": "2018-07-17T19:34:56Z",
"last_visited": null,
"builder_ready_to_rate": 0,
"review_workflow_state": "NOT_STARTED",
"review_workflow_request_reason": null,
"underwriting_options": null
},
"relationships": {
"policy": {
"data": {
"type": "policies",
"id": "88fb78ef-740f-4a57-bae5-512d5dc66c66"
}
},
"policy_type": {
"data": {
"type": "policy-types",
"id": "c091db52-151a-4fb7-9fc0-1b21e4a952c0"
}
},
"policy_term": {
"data": {
"type": "policy-terms",
"id": "2a0eea55-0b2f-4972-9bcf-886dbc39b9e4"
}
}
}
}

Step 5: Display policy revisions (endorsements)

Use retrieveRevision (/policies/revisions/{id}/) to get the policy revisions (endorsements) for your policy. Select a revision ID from step 4.

Sample request

View code
curl --request GET \
--url https://api.policies-sandbox.britecore.com/policies/revisions/492cbd84-11f6-4322-a26e-4ea40f927738 \
--header 'authorization: enter your access token here' \
--cookie XSRF-TOKEN=11d50576-ef36-4e31-a985-c19ab0c3895e

Sample response

View code
{
"data": {
"type": "revisions",
"id": "492cbd84-11f6-4322-a26e-4ea40f927738",
"attributes": {
"britelines_product_name": "",
"cancel_date": null,
"commission_rate": "0.0000",
"commit_date": null,
"create_date": "2018-08-14T15:42:14Z",
"date_archived": null,
"dec_description": null,
"description": null,
"written_fee": "0.00",
"grant_mortgagee_extension": 0,
"override_commission": 0,
"policy_status": "Active",
"policy_status_reason_id": null,
"written_premium": "380.00",
"written_premium_delta": "0.00",
"print_dec": 1,
"reinstate_at_commit": 0,
"revision_date": "2051-02-01",
"revision_state": "open",
"annual_fee": "0.00",
"annual_premium": "380.00",
"underwriting_questions": null,
"underwriting_contacted": 0,
"underwriting_contact_date": null,
"builder_pending": 0,
"deleted": 0,
"credit_report_permissions": null,
"date_updated": "2018-08-14T15:42:14Z",
"last_visited": null,
"builder_ready_to_rate": 0,
"review_workflow_state": "NOT_STARTED",
"review_workflow_request_reason": null,
"underwriting_options": null
},
"relationships": {
"policy": {
"data": {
"type": "policies",
"id": "88fb78ef-740f-4a57-bae5-512d5dc66c66"
}
},
"policy_type": {
"data": {
"type": "policy-types",
"id": "c091db52-151a-4fb7-9fc0-1b21e4a952c0"
}
},
"policy_term": {
"data": {
"type": "policy-terms",
"id": "2a0eea55-0b2f-4972-9bcf-886dbc39b9e4"
}
}
}
}

Step 6: List assets covered by this policy

Use retrieveRiskDatum (/policies/risk-data/{id}/) to get the policy risk data. This endpoint returns a list of all the assets listed under this policy. You must pass the revision ID.

Sample request

View code
curl --request GET \
--url https://{{url}}/policies/risk-data/bc913332-d73f-464f-a544-686cdb9f36f9 \
--header 'authorization : ' \
--cookie XSRF-TOKEN=11d50576-ef36-4e31-a985-c19ab0c3895e

Sample response

View code
{
"data": {
"type": "risk-data",
"id": "bc913332-d73f-464f-a544-686cdb9f36f9",
"attributes": {
"risk_state": {
"field_overrides": {
"otherPolicyNumberId": {
"visible": false
},
"otherAutoPolicyNumberId": {
"visible": false
}
},
"pro_rata": {
"value": 0.0
},
"number": 1,
"rate_tables": {},
"name": "Policy 1",
"children": [
{
"field_overrides": {
"drivingSchool": {
"visible": false
},
"isNamedInsured": {
"visible": true
},
"goodGrades": {
"visible": false
},
"accidentPreventionCourseCompleted": {
"visible": false
},
"actualPoints": {
"read_only": true
}
},
"pro_rata": {
"value": 0.0
},
"number": 1,
"rate_tables": {
"pleasureCode": 8881.0,
"pleasureFactor": 1.15
},
"name": "Driver 1",
"children": [],
"detached_answers": {},
"field_answers": {
"lastName": "",
"licenseNumber": "3328906",
"pleasure": 1.15,
"suffix": "",
"accidentPreventionCourseCompleted": false,
"dateLicensed": "2014-06-02",
"governmentEmployee": "governmentEmployee_no",
"licenseState": "licenseState_vAVirginia",
"socialSecurityNumber": "3N6CM0KN0EK690890",
"mvrMismatch": false,
"actualPoints": "actualPoints_0",
"securityFreezeDriver": false,
"goodGrades": false,
"driverNumber": "",
"firstName": "Matheus",
"gender": "gender_male",
"married": false,
"middleInitial": "",
"drivingSchool": false,
"dateOfBirth": "1987-11-18",
"driverPointsOverride": "driverPointsOverride_nA",
"isNamedInsured": false,
"deceased": false
},
"total_premium": 0.0,
"detached_items": [],
"items": {},
"item_overrides": {},
"schema_version": "1.1",
"id": "456b1fc3-6e81-4dfd-823d-453c854fc106",
"calculations": {
"driverAge": 32.0,
"pleasureComputedFieldCalculation": 1.15
},
"type": {
"id": "79346361-0a8c-4e71-b83d-470a8099b3d4",
"name": "drivers",
"label": "Driver"
}
},
{
"field_overrides": {
"jointOwner": {
"visible": false
},
"lessor": {
"options": []
},
"assignedOwnerPrincipalOperator": {
"options": [
{
"value": "456b1fc3-6e81-4dfd-823d-453c854fc106",
"label": "Driver 1"
}
]
},
"vehiclePoints": {
"required": false
},
"additionalDriver": {
"read_only": true,
"required": false,
"options": [
{
"value": "456b1fc3-6e81-4dfd-823d-453c854fc106",
"label": "Driver 1"
}
]
},
"payee": {
"options": []
},
"modelYear": {
"required": false
},
"performance": {
"required": false
},
"comprehensiveDeductible": {
"options": [
{
"display_label": "$100",
"name": "comprehensiveDeductible_100",
"value": "$100",
"label": "$100"
},
{
"display_label": "$200",
"name": "comprehensiveDeductible_200",
"value": "$200",
"label": "$200"
},
{
"display_label": "$250",
"name": "comprehensiveDeductible_250",
"value": "$250",
"label": "$250"
},
{
"display_label": "$500",
"name": "comprehensiveDeductible_500",
"value": "$500",
"label": "$500"
},
{
"display_label": "$1,000",
"name": "comprehensiveDeductible_1000",
"value": "$1,000",
"label": "$1,000"
},
{
"display_label": "$2,500",
"name": "comprehensiveDeductible_2500",
"value": "$2,500",
"label": "$2,500"
}
]
},
"trust": {
"options": []
},
"collisionDeductible": {
"options": [
{
"display_label": "$250",
"name": "collisionDeductible_250",
"value": "$250",
"label": "$250"
},
{
"display_label": "$500",
"name": "collisionDeductible_500",
"value": "$500",
"label": "$500"
},
{
"display_label": "$1,000",
"name": "collisionDeductible_1000",
"value": "$1,000",
"label": "$1,000"
},
{
"display_label": "$2,500",
"name": "collisionDeductible_2500",
"value": "$2,500",
"label": "$2,500"
}
]
}
},
"pro_rata": {
"value": 55.0
},
"number": 1,
"rate_tables": {
"bodilyInjuryPerPersonLimit": 100000.0,
"primaryCodeOwner": 8883.0,
"uninsuredMotoristBiPerPersonLimit": 100000.0,
"uninsuredMotoristBiPerOccurrenceLimit": 300000.0,
"bodilyInjuryIncreasedLimitFactor": 1.47,
"bodilyInjuryPerOccurrenceLimit": 300000.0,
"primaryFactorOwner": 1.35,
"propertyDamageIncreasedLimitFactor": 1.1,
"increasedPropertyDamageCharge": 5.0,
"propertyDamageDisplayLimit": 100000.0,
"increasedBodilyInjuryCharge": 10.0,
"uninsuredMotoristPdLimit": 100000.0,
"vehicleUseValue": "More than 15 miles to work"
},
"name": "Private Passenger Auto 1",
"children": [],
"detached_answers": {},
"field_answers": {
"assignedOwnerPrincipalOperator": "456b1fc3-6e81-4dfd-823d-453c854fc106",
"additionalFactor": 0.5,
"garagingState": "garagingState_vAVirginia",
"additionalDriver": "",
"zipCode5DigitsOnly": "20121",
"bodyStyle": "",
"ownerFactor": 1.35,
"modelYear": null,
"vehicleUse": "vehicleUse_1530milestowork",
"uninsuredMotoristPropertyDamageLimit": "uninsuredMotoristPropertyDamageLimit_100000",
"propertyDamageLimit": "propertyDamageLimit_100000",
"grossWeight": null,
"jointOwner": "",
"vehiclePoints": null,
"make": "GM",
"registrationState": "registrationState_VA",
"uninsuredMotoristFormRequired": false,
"hasAntiLock": false,
"garagingAddress": "Main St 123",
"bodilyInjuryLimit": "bodilyInjuryLimit_100000300000",
"program": "program_standard",
"multiCarChargeME": false,
"uninsuredMotoristBodilyInjuryLimit": "uninsuredMotoristBodilyInjuryLimit_100000300000",
"performance": "performance_standard",
"model": "Onix",
"serialVin": "3N6CM0KN0EK690890",
"garagingTown": "Centreville",
"jointOwned": false
},
"total_premium": 55.0,
"detached_items": [
"autoLoanLease",
"autoLoanLease",
"towingAndLaborCosts",
"towingAndLaborCosts",
"rentalReimbursementOptionalLimits",
"rentalReimbursementOptionalLimits",
"autoLoanLease",
"autoLoanLease",
"towingAndLaborCosts",
"towingAndLaborCosts",
"rentalReimbursementOptionalLimits",
"rentalReimbursementOptionalLimits",
"autoLoanLease",
"autoLoanLease",
"towingAndLaborCosts",
"towingAndLaborCosts",
"rentalReimbursementOptionalLimits",
"rentalReimbursementOptionalLimits"
],
"items": {
"propertyDamage": {
"meta": {
"resolved_refs": [],
"unresolved_refs": []
},
"premium": null,
"pro_rata": {
"value": null
},
"limits": {
"PDLimit": 100000.0
}
},
"bodilyInjury": {
"meta": {
"resolved_refs": [],
"unresolved_refs": []
},
"premium": null,
"pro_rata": {
"value": null
},
"limits": {
"BIPerPersonLimit": 100000.0,
"BIPerOccurrenceLimit": 300000.0
}
},
"uninsuredMotorist": {
"meta": {
"resolved_refs": [],
"unresolved_refs": []
},
"premium": 55.0,
"pro_rata": {
"value": 55.0
},
"limits": {
"UMBIPerOccurrenceLimit": 300000.0,
"UMBIPerPersonLimit": 100000.0,
"UMPDLimit": 100000.0
}
}
},
"item_overrides": {
"comprehensive": {
"read_only": false
},
"towingAndLaborCosts": {
"visible": false
},
"rentalReimbursementOptionalLimits": {
"visible": false
},
"tapesRecordsDiscsAndOtherMedia": {
"visible": true
},
"autoLoanLease": {
"visible": false
}
},
"schema_version": "1.1",
"id": "98c70a7e-178e-4bf9-9cfb-f3df210c5a6b",
"calculations": {
"otherAutoPolicy": 0.0,
"primaryDriverFactor": 1.35,
"seniorFactor": 1.0,
"ownerFactorComputedFieldCalculation": 1.35,
"multiCarFactor": 0.0,
"assignedOwnerAge": 32.0,
"additionalFactorComputedFieldCalculation": 0.5,
"antiLockFactor": 1.0,
"termFactor": 1.0
},
"type": {
"id": "6e3bc876-9912-41ed-9a26-4429d414ff3b",
"name": "privatePassengerAutos",
"label": "Private Passenger Auto"
}
}
],
"detached_answers": {},
"field_answers": {
"uber": false,
"middleInitialNI": "",
"deliveryUse": false,
"lastNameNI": "Silva",
"coverageDeclinedInThree": false,
"currentCarrierInceptionDate": "",
"loanedToOthers": false,
"streetAddressNI": "Main St 123",
"cityNI": "Centreville",
"damage": false,
"securityFreeze": false,
"parkedElsewhere": false,
"currentCarrierPolicyStatus": "",
"otherAmicAutoPolicy": false,
"socialSecurityNumberNI": "550-01-8573",
"otherAutoInsurance": false,
"impairment": false,
"otherAutoPolicyNumberId": "",
"firstNameNI": "Matheus",
"businessUse": null,
"nonDriverResident": false,
"licenseSuspended": false,
"licenseStateNI": "licenseStateNI_cACalifornia",
"underwritingRemarks": "",
"otherPolicy": "otherPolicy_none",
"accidentForgivenessDate": "",
"insuranceScoreLastRetrieved": "",
"insuranceScoreNI": "insuranceScoreNI_24",
"stateOfNI": "stateOfNI_vAVirginia",
"conversionPolicy": false,
"military": false,
"clue": false,
"currentCarrierName": "",
"rentedToOthers": false,
"mvr": false,
"otherPolicyNumberId": "",
"dateOfBirthNI": "1987-11-18",
"otherLosses": false,
"driverAge75": null,
"atSchool": false,
"modified": false,
"zipCodeNI": "20121",
"licenseNumberNI": "",
"nameOfAdditionalInsured": "",
"financialFilings": false,
"suffixNI": "",
"emailNI": "",
"accidentForgiveness": false,
"notSolelyOwned": false
},
"total_premium": 0.0,
"detached_items": [],
"items": {},
"item_overrides": {},
"schema_version": "1.1",
"id": "9d3205fd-7ae7-4e83-b999-36342d05bf7b",
"calculations": {},
"type": {
"id": "7b55bdc5-de7b-4fef-9f66-b7de6e886658",
"name": "policy",
"label": "Policy"
}
},
"product_version": "eb3f81ce-3550-4a4d-93c3-47679834239d",
"quote_number": "Q-personalAutoCW-2020-63"
}
}
}

Step 7: Display all policy transaction history

Use listPolicyTransaction (/policies/policy-transactions/) to display the policy transaction histories. You will need the policy ID from the response to use in step 8.

Sample request

View code

curl --request GET \
--url https://api.policies-sandbox.britecore.com/policies/policy-transactions/ \
--header 'authorization: enter your access token here' \
--cookie XSRF-TOKEN=11d50576-ef36-4e31-a985-c19ab0c3895e

Sample response

View code

"data": [
{
"type": "policy-transactions",
"id": "e2d4697d-9a1d-47ef-b4c9-e20ba28a1c75",
"attributes": {
"type": "reinstatement",
"transaction_date_time": "2020-08-15T00:00:00Z",
"date_created": "2020-06-30T17:06:26Z",
"username": "britecore_wes.stclair@britecore.com"
},
"relationships": {
"policy": {
"data": {
"type": "policies",
"id": "557af753-8a1e-4a32-9aed-e730f0da9088"
}
},
"policy_term": {
"data": {
"type": "policy-terms",
"id": "c043db9b-2532-41b0-a6a1-38d2e357506a"
}
},
"revision": {
"data": {
"type": "revisions",
"id": "31ff573d-f91a-48f2-a7de-2ae74d277f21"
}
}
}
},
{
"type": "policy-transactions",
"id": "9a263824-94d0-4c65-a4bd-1b26f6e72847",
"attributes": {
"type": "cancellation",
"transaction_date_time": "2020-08-15T00:00:00Z",
"date_created": "2020-06-30T16:41:49Z",
"username": "britecore_wes.stclair@britecore.com"
},
"relationships": {
"policy": {
"data": {
"type": "policies",
"id": "557af753-8a1e-4a32-9aed-e730f0da9088"
}
},
"policy_term": {
"data": {
"type": "policy-terms",
"id": "c043db9b-2532-41b0-a6a1-38d2e357506a"
}
},
"revision": {
"data": {
"type": "revisions",
"id": "2e2cdc8e-d8f4-4b2d-b922-e77cc685a29c"
}
}
}
},
{
"type": "policy-transactions",
"id": "ecab1dbf-bd69-4095-b910-d8b1c4595aa6",
"attributes": {
"type": "endorsement",
"transaction_date_time": "2020-08-01T00:00:00Z",
"date_created": "2020-07-08T15:24:17Z",
"username": "britecore_wes.stclair@britecore.com"
},
"relationships": {
"policy": {
"data": {
"type": "policies",
"id": "f1475df4-e35d-4e81-8649-10a311b34452"
}
},
"policy_term": {
"data": {
"type": "policy-terms",
"id": "ce29ce99-2b89-4047-8f67-1b8a542d1511"
}
},
"revision": {
"data": {
"type": "revisions",
"id": "f932ff1a-f86a-460f-9c0d-15d0e4701da7"
}
}
}
},

Step 8: Display policy transaction history

Use retrievePolicyTransaction (/policies/policy-transactions/{id}) to get transaction details on a single policy. Pass the policy transaction ID from Step 7.

Sample request

View code
curl --request GET \
--url https://api.policies-sandbox.britecore.com/policies/policy-transactions/e2d4697d-9a1d-47ef-b4c9-e20ba28a1c75 \
--header 'authorization: enter your access token' \
--cookie XSRF-TOKEN=11d50576-ef36-4e31-a985-c19ab0c3895e

Sample response

View code
"data": {
"type": "policy-transactions",
"id": "e2d4697d-9a1d-47ef-b4c9-e20ba28a1c75",
"attributes": {
"type": "reinstatement",
"transaction_date_time": "2020-08-15T00:00:00Z",
"date_created": "2020-06-30T17:06:26Z",
"username": "britecore_wes.stclair@britecore.com"
},
"relationships": {
"policy": {
"data": {
"type": "policies",
"id": "557af753-8a1e-4a32-9aed-e730f0da9088"
}
},
"policy_term": {
"data": {
"type": "policy-terms",
"id": "c043db9b-2532-41b0-a6a1-38d2e357506a"
}
},
"revision": {
"data": {
"type": "revisions",
"id": "31ff573d-f91a-48f2-a7de-2ae74d277f21"
}
}
}
}
}

Step 9: Display billing information

Use the listBillingInfo endpoint (/policies/billing-info/) to display the billing information. You will need the policy ID and policy term ID to get the correct billing information.

Sample request

View code
curl --location --request GET 'https://{url}/api/policies/billing-info/?policyId=f5cf8f61-1dc2-469c-a749-7cdb2a49c0ba&policyTermId=f6ca561c-3359-49af-b06a-49f6c6c9fd36' \
--header 'Authorization: '

Sample response

View code
{
"data": {
"currentlyDue": "2,635.30",
"billingSchedule": "Annual",
"premiumDueDate": "07/25/2020",
"nonPayCancelDate": "08/11/2020",
"termNonPay": 0,
"totalNonPay": 0
}
}

Step 10: Display changes between policy revisions

You can use createCompareTransaction (/policies/compare-transactions/) to display changes in revisions. The createCompareTransaction endpoint evaluates the following:

  • For each risk: Compare field answers, total premium, and pro-rata value.
  • For each item: Compare premium and pro-rata value.

In your header, include the following:

View code
headers: {
'X-Request': 'JSON',
'Content-Type': 'application/vnd.api+json'
}

Include a JSON payload of:

View code
{
'data': {
'type': 'compare-transactions',
'attributes': {
'before': previousTransactionId,
'after': currentTransactionId
}
}
}

Note: before and after can be either revisions IDs or entire quote objects.

Sample response

View code

{
"changes": [
{
"static_id": "guid1",
"risk_type": "policy",
"operation": "change",
"fields":
{
"streetAddressNI":
{
"after": "456 Main St",
"before": "123 Main St"
},
"stateOfNI":
{
"after": "CO",
"before": "VA"
}
}
},
{
"static_id": "guid2",
"risk_type": "vehicle",
"operation": "change",
"fields":
{
"garagingAddress":
{
"after": "456 Main St",
"before": "123 Main St"
},
"garagingState":
{
"after": "CO",
"before": "VA"
},
},
"items":
{
"comprehensive":
{
"operation": "add"
},
"collision":
{
"operation": "add"
},
"lossPayee":
{
"operation": "remove"
},
},
{
"static_id": "guid3",
"risk_type": "vehicle",
"operation": "add",
"fields":
{
...
},
"items":
{
...
}
}
]
}

You have successfully retrieved and displayed policy information.