Topics on this page

Retrieve and display claims and statuses and update claim status

BriteClaims enables organizations to manage the full life cycle of property and casualty (P&C) insurance claims from first notice of loss (FNOL) to settlement.

BriteClaims’s features allow you to:

  • Manage claims at the claim or exposure file level.
  • Manage parties, including associated party and vendor management workflows.
  • Create and manage documents and attachments.
  • Manage injury-related claims, including the tracking of multiple diagnosis codes, medical providers, and facilities.
  • Manage auto claims, including owner, driver, passenger, and pedestrian relationships.
  • Manage damaged property.
  • Manage coverages, including filtering coverages based on relationship role.
  • Keep track of accounting, including:
    • A detailed claims summary with transaction filtering.
    • Managing exposure level for reserves/payments for standard and recovery transactions.
    • Automatic transaction referencing to support financial audits.
  • Enact policy limit enforcement through configurable business rules.

This tutorial will guide you through searching for claims, retrieving claims and exposures and their respective statuses, and updating the claim status and exposures using BriteAPIs.

Key concepts

  • Additional interest: A person or company that owns a portion of the risk, such as a mortgagor for a home or building or a lessor for a vehicle.
  • Adjuster – primary: The initial adjuster assigned to manage the claim file after FNOL, and who is ultimately responsible for the overall management of the claim. These adjusters are usually internal adjusters.
  • Agent (producer, broker, MGA, GA): The party that represents the insurance company in the sale of an insurance policy to an insured.
  • Allocated loss adjustment expenses (ALAE): ALAE are part of an insurer’s expense reserves that are attributed to the processing of a specific insurance claim.
  • Attorney – defense: Represents the insurance carrier.
  • Attorney – plaintiff: Represents the insured or claimant.
  • Batch processing: Batch processing is typically performed by the accounting/finance team. This process batches, validates, and releases eligible payments for issuance (check printing or other payment delivery methods). From a business standpoint, a processed payment is an official financial transaction recorded on the claim.
  • Bifurcation: When a court requires a claim to be separated into two parts.
  • Carrier/insurance company: The financially responsible party to compensate a claimant for their loss by repairing/restoring, replacing, or healing the claimant’s property or person.
  • Catastrophe (CAT): A catastrophe is a large-magnitude loss that affects a broad region, causing property damage and/or loss of life. Perils often include earthquakes, tornadoes, wind, hurricanes, floods, tsunamis, hailstorms, fires, etc. A catastrophe can include multiple perils. Local or federal government will issue a CAT number or code to define the affected geographic region and period of time (duration) that caused the damage. Claims are associated with this CAT and an insurer may submit damages to their reinsurance policy.
  • Claim: The reporting of an occurrence of an accident that damaged property or injured people listed on an insurance policy.
  • Claim number: The number given to the claim file at the time of FNOL.
  • Claimant: Every involved party with an exposure on a claim requesting compensation from the insurance company by virtue of the insurance policy to repair/restore, replace, property or heal a person; can include named persons listed on the policy (insureds).
  • Claimant – first party: People who aren’t listed on the policy, but can claim first party coverages; in some cases, they can also be considered insureds, such as a passenger in the insured vehicle who isn’t listed on the policy.
  • Claimant – third party: People or organizations taht make claims against an insured under liability coverage types.
  • Coverage: The name of the specific type of insurance placed on a risk if it is damaged/injured by certain perils, including the maximum financial benefit to be paid to the claimant to repair/restore, replace, or heal the risk.
  • Estimate: The amount provided by a vendor that they need to repair/restore damaged property.
  • Exposure: The combination of a claimant, risk, and coverage that has emerged as a result of a claim.
  • Feature: Another term for exposure.
  • First notice of loss (FNOL): FNOL is the initial reporting of the claim to the insurance company by the insured, third-party claimant, or agent.
  • Indemnification: A contractual agreement in which one party (the insurer or insurance carrier) guarantees compensation for actual or potential losses or damages sustained by another party (the insured or claimant).
  • Insureds: Named persons or organizations listed on the policy.
  • Limits: The claims system will need to enforce limits provided from the policy so payments don’t exceed the limits, unless approved by a supervisor. Limits coming from the policy will vary by line of business, but often include limits by policy, coverage, and risk.
  • Loss:The basis of a claim for damages under the terms of an insurance policy.
  • Payee: Payments are made to a payee. A payee can be an insured, claimant, vendor, representative of a claimant, or additional interest
  • Payment: Money that is paid to the Insured, third-party claimant, or vendors to repair/restore, replace, or heal the risk.
  • Peril: Causes of the claim. Examples include wind, fire, water, earthquake, etc.
  • Risk: The item listed on the insurance policy for which insurance has been purchased (vehicle, house, equipment, business, personal injury). Risks can also be third party, property, or person.
  • Salvage: When an item such as a vehicle is declared a total loss, the item may be sold for parts. Monies recovered from the salvage of the vehicle will be applied to the claim financials to reduce the net incurred.
  • Settlement: The total amount of money an insurer is willing to pay for damages to property or recovery/restitution of health and loss of wages for an injured party.
  • Subrogation: If there are persons or companies that are partially or fully at fault for the occurrence or accident, the adjuster will attempt to recover funds from those parties.
  • Total loss: Total loss may be declared when the estimated damages to repair an item such as a car are above a designated percentage of the replacement value for the item.
  • Unallocated loss adjustment expenses (ULAE): Expenses associated with ULAE are more general than ALAE and may include overhead, investigations, and salaries. Insurers that use in-house employees for field adjustments would report that expense as a ULAE.
  • Vendor: A party that is paid for services provided associated with a claim.

Product dependencies

BriteClaims works closely with the BriteCore services below.

BriteLines

Product configuration and changes are managed in BriteLines and will be pulled into BriteClaims to minimize configuration in BriteClaims for the support of new product versions. BriteClaims takes a feed from any product configured in BriteLines. If the client publishes a new version of a product, BriteClaims can be configured to recognize that version and can manage unique data elements that may come from that version.

BriteClaims Financial Modal

The Claims financial modal maps any product in Lines to the reserve, payment, and transaction set up in Claims. Financial Modal can be configured to the unique needs of each coverage in a product.

BritePolicy

BritePolicy gives a snapshot of policy, coverage, limit, and insured details at FNOL. A policy is attached to a claim at FNOL and imports all information needed to support claims processing.

Mock Policy Modal

The policy information retrieved by BritePolicy is displayed in the claims system during policy validation at FNOL. The policy information is a snapshot of that policy as of the loss date. This module will provide adjusters with the information they need for coverage investigations without having to go to BritePolicy directly.

BriteRules

Any claim event can trigger a rule, which defines the workflow. You can configure rules to be simple or complex depending on your processes.

BriteAuth

Role-based permissions will dictate what a user can see and do in the system.

Claims status workflow

BriteClaims is highly configurable. Figure 1 shows claim statuses.

Figure 1: Sample claim status workflow.

Table 1 summarizes the

Table 1: Claim statuses, transitions, and available actions.

Claim StatusDescription and possible actionsPossible transitions
NewWhen a claim is first submitted through the FNOL, it enters investigation. The adjuster has a specific time period based on line of business and jurisdiction to accept or deny the claim. At this point, the financials aren't active. The user can:
• Manage parties.
• Manage vehicles and third-party property damage.
• Add notes.
• Add attachments, including electronic files and document templates.
• Send outbound email messages from the claim file.
New to Open
New to Closed

To change from New to Closed, you must provide a reason. Reasons include:
• Record only
• Void/Opened in error
OpenWhen the adjuster completes the coverage investigation and wants to set up exposures so reserves and payments can be made against the claim, the status is changed from New to Open. When the claim status is Open, the user can:
• Add an exposure to the claim (combining of the claimant, risk/injury, and coverage).
• Set reserves.
• Make a payment against an exposure.
• Manage parties.
• Manage vehicles and third-party property damage.
• Add notes.
• Add attachments, including electronic files and document templates.
• Send outbound messages from the claim file.
Open to Closed

To transition from Open to Closed, you must close all Open exposures. When closing an exposure, the system will prompt the user to select a closed reason of Without Pay or Record Only. A status of Closed With Pay is automatically selected if payments have been made on the claim.
ClosedWhen a claim is closed, there can be no activities against the claim except clearing a check, if relevant.Closed to Reopen

You must provide a Reopen reason. Reasons include:
• Closed by mistake
• Additional payments
ReopenThe only option provided for a claim in Closed status is Reopen. If you reopen a claim, you can take the same actions as for a claim in Open status. However, a client may opt to restrict permissions of certain roles from doing certain actions. For example, the system may be configured to allow a claim assistant to edit the loss date when claim is in Open status, but prevents the claim assistant from doing the same regarding Reopen status.Reopen to Closed

To transition to Reopen to Close, you must close all Open exposures.

Retrieve claim and status and update status using BriteClaims

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?

Step 2: Search for and display claims by policy

To retrieve a list of claims by policy, use the endpoint claims_search (/claims/search/). Claims_search returns a list of all claims that are found from the given query. Retrieve the claim number (called “number”) for step 3. You can query by the following string parameters:

  • Name
  • phoneNumber
  • adjusterName
  • lossCause
  • street1
  • street2
  • city
  • state
  • zip
  • contact_id
  • policy number
  • status
  • lossDateFrom
  • lossDateTo
  • hasAdjuster
  • orderBy
  • lossCity
  • lossZip

Sample request

View code
 curl --location --request GET 'https:// /api/claims/search/?page=1&page_size=10&policy=P-41' 
--header 'Authorization: '

Sample response

View code
{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "c2a580d2-cd2d-4ba8-96df-f3c83841500e",
"number": "C-91-2020",
"status": {
"id": "b5d3ad76-4ade-496b-bb6b-d125e268a413",
"name": "new",
"label": "New",
"type": "system",
"meta": {}
},
"reporter_id": "75e8c8cb-8bc6-4e5f-b93f-54ecaca5774c",
"primary_insured": {
"party_id": "75e8c8cb-8bc6-4e5f-b93f-54ecaca5774c",
"contact": {
"id": "39d3b734-1931-46c2-948a-8a56340f098d",
"dbs": null,
"dob": null,
"dba": "",
"ssn": "123-45-6777",
"name": "Madeline Schamberger",
"type": "individual",
"fein_tax": null,
"position": null,
"addresses": [],
"phones": [
{
"id": "ce3324ed-1d8a-497a-ba4b-71b8147178ef",
"type": "home",
"phone": "+1044375176"
},
{
"id": "d6b3e6bd-725b-4fa4-87a0-af86ba3ed34c",
"type": "work",
"phone": "+1123456"
},
{
"id": "141ef676-7409-47cd-beb0-2f0035c687a7",
"type": "other",
"phone": "+123123123232"
},
{
"id": "769aebc5-03d4-4bf8-8f7a-01c3ed3aba46",
"type": "other",
"phone": "+123123123232"
},
{
"id": "357f7507-1ac0-4e40-b92d-d57da6e138c7",
"type": "mobile",
"phone": "+1111111"
},
{
"id": "44046ec3-ea6d-4700-8744-fb2884f27b86",
"type": "mobile",
"phone": "+123321312321"
},
{
"id": "9821dcaf-9b1f-4745-a757-dc749a6d9f4f",
"type": "mobile",
"phone": "+12333333333"
},
{
"id": "f832d337-dab6-4690-a743-1b6309d127bb",
"type": "mobile",
"phone": "+111111111"
}
],
"emails": [
{
"id": "4bb032ba-4831-4f08-9bdf-c3ebff8f17e3",
"type": "personal",
"email": "test123@hotmail.com"
},
{
"id": "9358668b-86ce-4e68-86b1-67293025a344",
"type": "personal",
"email": "test2222@gmail.com"
},
{
"id": "a1493b1f-06f1-461c-b479-2790b38b4b54",
"type": "personal",
"email": "test12345666gmail.com"
},
{
"id": "c5a254e5-c0c2-4c56-92aa-1983a5a1b6ef",
"type": "notifications",
"email": "test222222@hotmail.com"
},
{
"id": "dd13238e-2add-4f58-9227-675525a58dc5",
"type": "personal",
"email": "email@email.com"
}
],
"primary_address": {
"id": "ddf288f6-f910-414a-b581-5ca579b90ae3",
"zip": "12345",
"city": "Schenectady",
"type": "Mailing/Billing",
"line1": "Preferred NOW",
"line2": "hello joe",
"state": "NY",
"county": "Schenectady",
"country": "USA"
},
"primary_phone": {
"id": "2460fca7-bed9-424d-964f-57a1e659bfab",
"type": "home",
"phone": "+123123123123"
},
"primary_email": {
"id": "d8dc8e36-5127-4ce5-99af-e049c70454a5",
"type": "work",
"email": "email@email.com"
},
"is_approved_vendor": false
}
},
"primary_adjuster": null,
"complexity": {
"id": "7dbfc881-7a76-4fe8-aee9-d49642171dfe",
"label": "Medium",
"name": "medium"
},
"reported_method": "b9c6e81b-aa92-48d4-9f87-9309ad679772",
"reported_date": "2020-07-16",
"reported_time": "10:43:01.759478",
"policy_id": "42992a92-aa30-4c83-b30e-52fc8a917e7e",
"policy_type_id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"policy_revision_id": "9faacf42-ca80-4ceb-8f50-4b0840eacc95",
"policy_number": "P-41-2019",
"external_data": {
"policy": {
"data": {
"id": "42992a92-aa30-4c83-b30e-52fc8a917e7e",
"number": "P-41-2019"
}
},
"policy_type": {
"data": {
"id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"name": "personal_auto",
"label": "Personal auto"
}
},
"policy_revision": {
"data": {
"id": "9faacf42-ca80-4ceb-8f50-4b0840eacc95",
"policy": {
"id": "42992a92-aa30-4c83-b30e-52fc8a917e7e",
"number": "P-41-2019"
},
"policy_type": {
"id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"name": "personal_auto",
"label": "Personal auto"
}
}
}
},
"perils": [
"a0c5492e-67f5-4b24-b487-3aeb7ad94e58",
"29c03810-8e93-440f-8a36-7568e4cc3f34"
],
"policy": {
"id": "42992a92-aa30-4c83-b30e-52fc8a917e7e",
"number": "P-41-2019"
},
"policy_type": {
"id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"name": "personal_auto",
"label": "Personal auto"
},
"policy_revision": {
"id": "9faacf42-ca80-4ceb-8f50-4b0840eacc95",
"policy": {
"id": "42992a92-aa30-4c83-b30e-52fc8a917e7e",
"number": "P-41-2019"
},
"policy_type": {
"id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"name": "personal_auto",
"label": "Personal auto"
}
},
"fnol_note": null,
"product": "ce84d72f-5a19-4f40-b8d3-4593df72cfa4",
"fnol_data": {
"other_risks": [
{
"fields": {
"property_type": "Building Structure (housing, fencing, garages, stores)",
"property_location": "Insured's Location",
"property_damage_details": "Fences and garage are destroyed"
},
"risk_type": {
"name": "damage_property"
},
"party_relations": {
"owner": {
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d"
}
}
}
],
"added_parties": [
{
"roles": [
{
"name": "primary_insured"
}
],
"injury": {
"fields": {
"prior_injuries": "Unknown",
"medicare_eligible": "Unknown",
"loss_of_consciousness": "Unknown",
"transported_to_hospital_from_scene": "Unknown"
},
"injury_type": {
"name": "person_injury"
},
"injury_nature_id": "ab2b37beb7324055905a79325d299e92"
},
"contact": {
"id": "39d3b734-1931-46c2-948a-8a56340f098d",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Madeline Schamberger",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": null,
"primary_phone": null,
"primary_address": {
"id": "5634925d-d35b-4130-87bd-245ba4b3e737",
"zip": "02210",
"city": "Boston",
"type": "Mailing/Billing",
"line1": "123 High St",
"line2": "",
"state": "MA",
"county": "Suffolk",
"country": "USA",
"full_address": "Boston, MA, 02210"
}
},
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d",
"party_type": {
"name": "individual"
},
"preferred_email_id": null,
"preferred_phone_id": null,
"preferred_address_id": "5634925d-d35b-4130-87bd-245ba4b3e737"
},
{
"roles": [
{
"name": "insured"
}
],
"contact": {
"id": "93bc6a59-4932-4752-a3e7-4788365544de",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Joe Insured",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [
{
"id": "7b715784-ddeb-11e9-8a34-2a2ae2dbcce4",
"zip": "12345",
"city": "Schenectady",
"type": "Mailing/Billing",
"line1": "456 Low St",
"line2": "",
"state": "NY",
"county": "Schenectady",
"country": "USA",
"full_address": "Schenectady, NY, 12345"
}
],
"primary_email": {
"id": "c3468365-ed68-4a0c-ba98-b1b800116bd5",
"type": "Home",
"email": "faker89154@gmail.com"
},
"primary_phone": {
"id": "33fea6ef-0220-4545-9c52-4b15dc2d7e65",
"type": "Home",
"phone": "(712) 447-5281"
},
"primary_address": {
"id": "0751608a-abf1-480b-92cc-9895cdad5c16",
"zip": "02210",
"city": "Boston",
"type": "Mailing/Billing",
"line1": "123 High St",
"line2": "",
"state": "MA",
"county": "Suffolk",
"country": "USA",
"full_address": "Boston, MA, 02210"
}
},
"contact_id": "93bc6a59-4932-4752-a3e7-4788365544de",
"party_type": {
"name": "individual"
},
"preferred_email_id": "c3468365-ed68-4a0c-ba98-b1b800116bd5",
"preferred_phone_id": "33fea6ef-0220-4545-9c52-4b15dc2d7e65",
"preferred_address_id": "0751608a-abf1-480b-92cc-9895cdad5c16"
},
{
"roles": [],
"injury": {
"fields": {
"prior_injuries": "Unknown",
"medicare_eligible": "Unknown",
"loss_of_consciousness": "Unknown",
"transported_to_hospital_from_scene": "Unknown"
},
"injury_type": {
"name": "person_injury"
},
"injury_nature_id": "ab2b37beb7324055905a79325d299e92"
},
"contact": {
"id": "996f936b-d025-48be-83ff-41f7232bb566",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Sarah Hughes",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": {
"id": "16699dbd-b00e-45e8-9635-f49744ffd12c",
"type": "Work",
"email": "faker81739@gmail.com"
},
"primary_phone": {
"id": "3bb720d3-d940-40b3-9a8d-d0241270e2d3",
"type": "Work",
"phone": "(494) 886-8073"
},
"primary_address": {
"id": "4905dd37-0c1b-4023-8052-6980acce4494",
"zip": "02340",
"city": "Hopkinton",
"type": "Mailing/Billing",
"line1": "972 Ryan Radial",
"line2": "",
"state": "MA",
"county": "Middlesex",
"country": "USA",
"full_address": "Hopkinton, MA, 02340"
}
},
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566",
"party_type": {
"name": "individual"
},
"preferred_email_id": "16699dbd-b00e-45e8-9635-f49744ffd12c",
"preferred_phone_id": "3bb720d3-d940-40b3-9a8d-d0241270e2d3",
"preferred_address_id": "4905dd37-0c1b-4023-8052-6980acce4494"
},
{
"roles": [],
"contact": {
"id": "5bd48c61-9801-4329-afda-2e0ee04fe7cb",
"dbs": null,
"dob": null,
"ssn": null,
"name": "BriteCore Writing Co",
"type": "organization",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": {
"id": "b81845bd-dd81-4f5b-81b5-733bbf16f691",
"type": "Work",
"email": "faker81862@gmail.com"
},
"primary_phone": {
"id": "ed1b2c5d-afa7-4899-a2a6-913f25f567d1",
"type": "Work",
"phone": "(676) 586-0564"
},
"primary_address": {
"id": "1e908f0d-ea26-470e-9d89-7b17349bae20",
"zip": "02145",
"city": "Somerville",
"type": "Mailing/Billing",
"line1": "100 Main St",
"line2": "",
"state": "MA",
"county": "Middlesex",
"country": "USA",
"full_address": "Somerville, MA, 02145"
}
},
"contact_id": "5bd48c61-9801-4329-afda-2e0ee04fe7cb",
"party_type": {
"name": "organization"
},
"preferred_email_id": "b81845bd-dd81-4f5b-81b5-733bbf16f691",
"preferred_phone_id": "ed1b2c5d-afa7-4899-a2a6-913f25f567d1",
"preferred_address_id": "1e908f0d-ea26-470e-9d89-7b17349bae20"
}
],
"reported_date": "2020-07-16",
"reported_time": "10:40:47.293188",
"party_relations": {
"agent": {
"contact_id": "5bd48c61-9801-4329-afda-2e0ee04fe7cb"
},
"insured": {
"contact_id": "93bc6a59-4932-4752-a3e7-4788365544de"
},
"reporter": {
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d"
},
"primary_insured": {
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d"
}
},
"policy_revision": {
"id": "9faacf42-ca80-4ceb-8f50-4b0840eacc95",
"policy": {
"id": "42992a92-aa30-4c83-b30e-52fc8a917e7e",
"number": "P-41-2019"
},
"policy_type": {
"id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"name": "personal_auto",
"label": "Personal auto"
}
},
"reported_method": {
"name": "other"
},
"first_party_risk": {
"damage": {
"fields": {
"damage_locations": [
"Unknown"
],
"vehicle_drivable": "Unknown",
"car_seat_involved": "Unknown",
"first_point_impact": "Unknown",
"damage_details_known": "No",
"vehicle_towed_from_scene": "Unknown"
},
"damage_type": {
"name": "damage_vehicle"
}
},
"fields": {
"vin": "JH4NA1150NT000040",
"make": "Honda",
"year": "1997",
"color": "Grey",
"model": "Civic",
"license_plate": "AHS 1102",
"license_state": "VA"
},
"coverages": [
{
"name": "private_passenger_auto_property_damage_liability",
"type": "per_person",
"label": "Property Damage Liability",
"value": 100000
},
{
"name": "private_passenger_auto_bodily_injury_liability",
"type": "per_occurrence",
"label": "Bodily Injury Liability",
"value": 300000
},
{
"name": "private_passenger_auto_uninsured_motorist_property_damage",
"type": "deductible",
"label": "Uninsured Motorist Property Damage",
"value": 250
},
{
"name": "private_passenger_auto_underinsured_motorist_property_damage",
"type": "deductible",
"label": "Underinsured Motorist Property Damage",
"value": 100
},
{
"name": "private_passenger_auto_towing_and_labor_costs",
"type": "per_person",
"label": "Towing and Labor Costs",
"value": 7000
},
{
"name": "private_passenger_auto_tapes_records_discs_and_other_media",
"type": "per_person",
"label": "Tapes, Records, Discs and Other Media",
"value": 100000
},
{
"name": "private_passenger_auto_rental_reimbursement_optional_limits",
"type": "per_occurrence",
"label": "Rental Reimbursement - Optional Limits",
"value": 300000
},
{
"name": "private_passenger_auto_customized_equipment_coverage",
"type": "per_occurrence",
"label": "Customized Equipment Coverage",
"value": 100000
},
{
"name": "private_passenger_auto_auto_loan_lease",
"type": "per_occurrence",
"label": "Auto Loan Lease",
"value": 1000
},
{
"name": "private_passenger_auto_audio_visual_and_data_electronic_equipment",
"type": "per_occurrence",
"label": "Audio, Visual and Data Electronic Equipment",
"value": 1000
},
{
"name": "private_passenger_auto_comprehensive",
"type": "per_occurrence",
"label": "Comprehensive",
"value": 1000
},
{
"name": "private_passenger_auto_collision",
"type": "per_occurrence",
"label": "Collision",
"value": 1000
},
{
"name": "private_passenger_auto_uninsured_motorist_bodily_injury",
"type": "per_occurrence",
"label": "Uninsured Motorist Bodily Injury",
"value": 1000
},
{
"name": "private_passenger_auto_underinsured_motorist_bodily_injury_coverage",
"type": "per_occurrence",
"label": "Underinsured Motorist Bodily Injury Coverage",
"value": 1000
},
{
"name": "private_passenger_auto_medical_expense",
"type": "per_occurrence",
"label": "Medical Expense (Stackable in Virginia up to four vehicles)",
"value": 1000
}
],
"risk_type": {
"name": "private_passenger_auto"
},
"party_relations": {
"owner": {
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d"
},
"driver": {
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d"
},
"passenger": {
"contact_id": "93bc6a59-4932-4752-a3e7-4788365544de"
}
}
},
"loss_information": {
"fields": {
"is_there_a_police_report": "No",
"number_of_vehicles_involved": "4",
"loss_occurred_at_the_insured_residence": "No"
},
"date_of_loss": "2020-07-16",
"time_of_loss": "10:40:47.293188",
"loss_category": {
"name": "vandalism"
},
"loss_location": {
"zip": "04326",
"city": "Leehaven",
"line1": "686 Schmidt Freeway",
"line2": "Apt. 328",
"state": "ND",
"county": "",
"country": "USA",
"latitude": "-59.512082",
"longitude": "157.100281"
}
},
"third_party_risks": [
{
"damage": {
"fields": {
"damage_locations": [
"Unknown"
],
"vehicle_drivable": "Unknown",
"car_seat_involved": "Unknown",
"first_point_impact": "Unknown",
"damage_details_known": "No",
"vehicle_towed_from_scene": "Unknown"
},
"damage_type": {
"name": "damage_vehicle"
}
},
"fields": {
"vin": "1GNGC26RXXJ407648",
"make": "Ford",
"year": "2012",
"color": "Black",
"model": "Edge",
"license_plate": "AHS 2503",
"license_state": "NY"
},
"risk_type": {
"name": "private_passenger_auto"
},
"party_relations": {
"owner": {
"contact_id": "5bd48c61-9801-4329-afda-2e0ee04fe7cb"
},
"driver": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
}
}
}
]
},
"loss_information": {
"id": "6b51ade4-26c1-491b-8e1c-b3629a913c2b",
"loss_category": {
"id": "ac3ec1b5-2e4d-4ed0-a905-2b4d725f060d",
"name": "vandalism",
"label": "Vandalism",
"order": 7
},
"loss_location": {
"id": "81583443-9312-49ef-8ac4-0d7bd9e74f0d",
"line1": "686 Schmidt Freeway",
"line2": "Apt. 328",
"city": "Leehaven",
"country": "USA",
"county": "",
"state": "ND",
"zip": "04326",
"latitude": -59.512082,
"longitude": 157.100281,
"full_address": "686 Schmidt Freeway, Apt. 328, Leehaven, ND, 04326",
"other_details": null,
"type": null
},
"date_of_loss": "2020-07-16",
"time_of_loss": "10:40:47.293188",
"description": null,
"fields": {
"number_of_vehicles_involved": "4",
"loss_occurred_at_the_insured_residence": "No",
"is_there_a_police_report": "No"
}
},
"exposures_folder_id": null
}
]
}

(Alternative) Step 2: Search for and display claims by claimant and policy

To narrow your search by claimant and policy, add the claimant name to the query using the same endpoint, claims_search (/claims/search/). Retrieve the claim number (called “number”) for step 3.

Sample request

View code


curl --location --request GET 'https://engineering-dev.britecore.com/api/claims/search/?page=1&page_size=10&name=sarah' \
--header 'Authorization: '

Sample response

View code

{
"id": "86dd49fa-9919-44f8-b3fd-7903bf864c2b",
"number": "C-99-2020",
"status": {
"id": "b5d3ad76-4ade-496b-bb6b-d125e268a413",
"name": "new",
"label": "New",
"type": "system",
"meta": {}
},
"reporter_id": "b52fa46a-8468-4d80-8d3b-9f376eca0de4",
"primary_insured": {
"party_id": "b52fa46a-8468-4d80-8d3b-9f376eca0de4",
"contact": {
"id": "996f936b-d025-48be-83ff-41f7232bb566",
"name": "Sarah Hughes",
"type": "individual",
"position": null,
"ssn": null,
"dbs": null,
"dob": null,
"fein_tax": null,
"addresses": [],
"emails": [],
"phones": [],
"primary_address": {
"city": "Hopkinton",
"country": "USA",
"county": "Middlesex",
"full_address": "Hopkinton, MA, 02340",
"id": "4905dd37-0c1b-4023-8052-6980acce4494",
"line1": "972 Ryan Radial",
"line2": "",
"state": "MA",
"type": "Mailing/Billing",
"zip": "02340"
},
"primary_email": {
"id": "16699dbd-b00e-45e8-9635-f49744ffd12c",
"email": "faker81739@gmail.com",
"type": "Work"
},
"primary_phone": {
"id": "3bb720d3-d940-40b3-9a8d-d0241270e2d3",
"phone": "(494) 886-8073",
"type": "Work"
}
}
},
"primary_adjuster": null,
"complexity": {
"id": "7dbfc881-7a76-4fe8-aee9-d49642171dfe",
"label": "Medium",
"name": "medium"
},
"reported_method": "aea7733f-ee48-48fb-825b-8b7cae8ed676",
"reported_date": "2020-07-16",
"reported_time": "10:43:28.767559",
"policy_id": "e3acc591-7546-4c7b-9da8-4a3ee073c7f5",
"policy_type_id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"policy_revision_id": "452adc44-08a5-4b59-beaa-14dda66fe791",
"policy_number": "P-49-2019",
"external_data": {
"policy": {
"data": {
"id": "e3acc591-7546-4c7b-9da8-4a3ee073c7f5",
"number": "P-49-2019"
}
},
"policy_type": {
"data": {
"id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"name": "personal_auto",
"label": "Personal auto"
}
},
"policy_revision": {
"data": {
"id": "452adc44-08a5-4b59-beaa-14dda66fe791",
"policy": {
"id": "e3acc591-7546-4c7b-9da8-4a3ee073c7f5",
"number": "P-49-2019"
},
"policy_type": {
"id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"name": "personal_auto",
"label": "Personal auto"
}
}
}
},
"perils": [
"a0c5492e-67f5-4b24-b487-3aeb7ad94e58",
"29c03810-8e93-440f-8a36-7568e4cc3f34"
],
"policy": {
"id": "e3acc591-7546-4c7b-9da8-4a3ee073c7f5",
"number": "P-49-2019"
},
"policy_type": {
"id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"name": "personal_auto",
"label": "Personal auto"
},
"policy_revision": {
"id": "452adc44-08a5-4b59-beaa-14dda66fe791",
"policy": {
"id": "e3acc591-7546-4c7b-9da8-4a3ee073c7f5",
"number": "P-49-2019"
},
"policy_type": {
"id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"name": "personal_auto",
"label": "Personal auto"
}
},
"fnol_note": null,
"product": "ce84d72f-5a19-4f40-b8d3-4593df72cfa4",
"fnol_data": {
"other_risks": [
{
"fields": {
"property_type": "Building Structure (housing, fencing, garages, stores)",
"property_location": "Insured's Location",
"property_damage_details": "Fences and garage are destroyed"
},
"risk_type": {
"name": "damage_property"
},
"party_relations": {
"owner": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
}
}
}
],
"added_parties": [
{
"roles": [
{
"name": "primary_insured"
}
],
"injury": {
"fields": {
"prior_injuries": "Unknown",
"medicare_eligible": "Unknown",
"loss_of_consciousness": "Unknown",
"transported_to_hospital_from_scene": "Unknown"
},
"injury_type": {
"name": "person_injury"
},
"injury_nature_id": "ab2b37beb7324055905a79325d299e92"
},
"contact": {
"id": "996f936b-d025-48be-83ff-41f7232bb566",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Sarah Hughes",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": {
"id": "16699dbd-b00e-45e8-9635-f49744ffd12c",
"type": "Work",
"email": "faker81739@gmail.com"
},
"primary_phone": {
"id": "3bb720d3-d940-40b3-9a8d-d0241270e2d3",
"type": "Work",
"phone": "(494) 886-8073"
},
"primary_address": {
"id": "4905dd37-0c1b-4023-8052-6980acce4494",
"zip": "02340",
"city": "Hopkinton",
"type": "Mailing/Billing",
"line1": "972 Ryan Radial",
"line2": "",
"state": "MA",
"county": "Middlesex",
"country": "USA",
"full_address": "Hopkinton, MA, 02340"
}
},
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566",
"party_type": {
"name": "individual"
},
"preferred_email_id": "16699dbd-b00e-45e8-9635-f49744ffd12c",
"preferred_phone_id": "3bb720d3-d940-40b3-9a8d-d0241270e2d3",
"preferred_address_id": "4905dd37-0c1b-4023-8052-6980acce4494"
},
{
"roles": [
{
"name": "insured"
}
],
"contact": {
"id": "39d3b734-1931-46c2-948a-8a56340f098d",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Madeline Schamberger",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": null,
"primary_phone": null,
"primary_address": {
"id": "5634925d-d35b-4130-87bd-245ba4b3e737",
"zip": "02210",
"city": "Boston",
"type": "Mailing/Billing",
"line1": "123 High St",
"line2": "",
"state": "MA",
"county": "Suffolk",
"country": "USA",
"full_address": "Boston, MA, 02210"
}
},
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d",
"party_type": {
"name": "individual"
},
"preferred_email_id": null,
"preferred_phone_id": null,
"preferred_address_id": "5634925d-d35b-4130-87bd-245ba4b3e737"
},
{
"roles": [],
"injury": {
"fields": {
"prior_injuries": "Unknown",
"medicare_eligible": "Unknown",
"loss_of_consciousness": "Unknown",
"transported_to_hospital_from_scene": "Unknown"
},
"injury_type": {
"name": "person_injury"
},
"injury_nature_id": "ab2b37beb7324055905a79325d299e92"
},
"contact": {
"id": "93bc6a59-4932-4752-a3e7-4788365544de",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Joe Insured",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [
{
"id": "7b715784-ddeb-11e9-8a34-2a2ae2dbcce4",
"zip": "12345",
"city": "Schenectady",
"type": "Mailing/Billing",
"line1": "456 Low St",
"line2": "",
"state": "NY",
"county": "Schenectady",
"country": "USA",
"full_address": "Schenectady, NY, 12345"
}
],
"primary_email": {
"id": "c3468365-ed68-4a0c-ba98-b1b800116bd5",
"type": "Home",
"email": "faker89154@gmail.com"
},
"primary_phone": {
"id": "33fea6ef-0220-4545-9c52-4b15dc2d7e65",
"type": "Home",
"phone": "(712) 447-5281"
},
"primary_address": {
"id": "0751608a-abf1-480b-92cc-9895cdad5c16",
"zip": "02210",
"city": "Boston",
"type": "Mailing/Billing",
"line1": "123 High St",
"line2": "",
"state": "MA",
"county": "Suffolk",
"country": "USA",
"full_address": "Boston, MA, 02210"
}
},
"contact_id": "93bc6a59-4932-4752-a3e7-4788365544de",
"party_type": {
"name": "individual"
},
"preferred_email_id": "c3468365-ed68-4a0c-ba98-b1b800116bd5",
"preferred_phone_id": "33fea6ef-0220-4545-9c52-4b15dc2d7e65",
"preferred_address_id": "0751608a-abf1-480b-92cc-9895cdad5c16"
},
],
"reported_date": "2020-07-16",
"reported_time": "10:40:47.293188",
"party_relations": {
"agent": {
"contact_id": "5bd48c61-9801-4329-afda-2e0ee04fe7cb"
},
"insured": {
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d"
},
"reporter": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
},
"primary_insured": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
}
},
"policy_revision": {
"id": "452adc44-08a5-4b59-beaa-14dda66fe791",
"policy": {
"id": "e3acc591-7546-4c7b-9da8-4a3ee073c7f5",
"number": "P-49-2019"
},
"policy_type": {
"id": "5d954b26-51ef-4a52-a2a7-c8e747599c64",
"name": "personal_auto",
"label": "Personal auto"
}
},
"reported_method": {
"name": "police_report"
},
"first_party_risk": {
"damage": {
"fields": {
"damage_locations": [
"Unknown"
],
"vehicle_drivable": "Unknown",
"car_seat_involved": "Unknown",
"first_point_impact": "Unknown",
"damage_details_known": "No",
"vehicle_towed_from_scene": "Unknown"
},
"damage_type": {
"name": "damage_vehicle"
}
},
"fields": {
"vin": "JH4NA1150NT000040",
"make": "Honda",
"year": "1997",
"color": "Grey",
"model": "Civic",
"license_plate": "AHS 1102",
"license_state": "VA"
},
"coverages": [
{
"name": "private_passenger_auto_property_damage_liability",
"type": "per_person",
"label": "Property Damage Liability",
"value": 100000
},
{
"name": "private_passenger_auto_bodily_injury_liability",
"type": "per_occurrence",
"label": "Bodily Injury Liability",
"value": 300000
},
{
"name": "private_passenger_auto_uninsured_motorist_property_damage",
"type": "deductible",
"label": "Uninsured Motorist Property Damage",
"value": 250
},
{
"name": "private_passenger_auto_underinsured_motorist_property_damage",
"type": "deductible",
"label": "Underinsured Motorist Property Damage",
"value": 100
},
{
"name": "private_passenger_auto_towing_and_labor_costs",
"type": "per_person",
"label": "Towing and Labor Costs",
"value": 7000
},
{
"name": "private_passenger_auto_tapes_records_discs_and_other_media",
"type": "per_person",
"label": "Tapes, Records, Discs and Other Media",
"value": 100000
},
{
"name": "private_passenger_auto_rental_reimbursement_optional_limits",
"type": "per_occurrence",
"label": "Rental Reimbursement - Optional Limits",
"value": 300000
},
{
"name": "private_passenger_auto_customized_equipment_coverage",
"type": "per_occurrence",
"label": "Customized Equipment Coverage",
"value": 100000
},
{
"name": "private_passenger_auto_auto_loan_lease",
"type": "per_occurrence",
"label": "Auto Loan Lease",
"value": 1000
},
{
"name": "private_passenger_auto_audio_visual_and_data_electronic_equipment",
"type": "per_occurrence",
"label": "Audio, Visual and Data Electronic Equipment",
"value": 1000
},
{
"name": "private_passenger_auto_comprehensive",
"type": "per_occurrence",
"label": "Comprehensive",
"value": 1000
},
{
"name": "private_passenger_auto_collision",
"type": "per_occurrence",
"label": "Collision",
"value": 1000
},
{
"name": "private_passenger_auto_uninsured_motorist_bodily_injury",
"type": "per_occurrence",
"label": "Uninsured Motorist Bodily Injury",
"value": 1000
},
{
"name": "private_passenger_auto_underinsured_motorist_bodily_injury_coverage",
"type": "per_occurrence",
"label": "Underinsured Motorist Bodily Injury Coverage",
"value": 1000
},
{
"name": "private_passenger_auto_medical_expense",
"type": "per_occurrence",
"label": "Medical Expense (Stackable in Virginia up to four vehicles)",
"value": 1000
}
],
"risk_type": {
"name": "private_passenger_auto"
},
"party_relations": {
"owner": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
},
"driver": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
},
"passenger": {
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d"
}
}
}

Step 3: Retrieve claim by claim number

You can use the claims_read endpoint (/claims/{claims_id}) with the claim number retrieved from step 2 to the query to retrieve the claim status. Retrieve the status_id for step 4.

Sample request

View code

curl --location --request GET '/api/claims/C-50-2020/' \
--header 'Authorization: '

Sample response

View code

{
"id": "6e452784-3d72-437b-907e-1942aead722a",
"number": "C-50-2020",
"status": {
"id": "b5d3ad76-4ade-496b-bb6b-d125e268a413",
"name": "new",
"label": "New",
"type": "system",
"meta": {}
},
"complexity": {
"id": "7dbfc881-7a76-4fe8-aee9-d49642171dfe",
"label": "Medium",
"name": "medium"
},
"reported_method": {
"id": "aea7733f-ee48-48fb-825b-8b7cae8ed676",
"name": "police_report",
"label": "Police Report"
},
"reported_date": "2020-07-24",
"reported_time": "13:07:22.064143",
"policy_id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"policy_type_id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"policy_revision_id": "595320df-d6ca-4348-8b3e-d0ebc45366a8",
"policy_number": "P-50-2019",
"external_data": {
"policy": {
"data": {
"id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"number": "P-50-2019"
}
},
"policy_type": {
"data": {
"id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"name": "personal_auto",
"label": "Personal auto"
}
},
"policy_revision": {
"data": {
"id": "595320df-d6ca-4348-8b3e-d0ebc45366a8",
"policy": {
"id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"number": "P-50-2019"
},
"policy_type": {
"id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"name": "personal_auto",
"label": "Personal auto"
}
}
}
},
"policy": {
"id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"number": "P-50-2019"
},
"policy_type": {
"id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"name": "personal_auto",
"label": "Personal auto"
},
"policy_revision": {
"id": "595320df-d6ca-4348-8b3e-d0ebc45366a8",
"policy": {
"id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"number": "P-50-2019"
},
"policy_type": {
"id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"name": "personal_auto",
"label": "Personal auto"
}
},
"perils": [
"c72a2bb3-4d5b-44cf-858d-ea6e5ad98981",
"bb23160b-cffe-404f-9092-43fa6de2443b"
],
"primary_adjuster": null,
"reporter_id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c",
"primary_insured": {
"party_id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c",
"contact": {
"id": "996f936b-d025-48be-83ff-41f7232bb566",
"name": "Sarah Hughes",
"type": "individual",
"position": null,
"ssn": null,
"dbs": null,
"dob": null,
"fein_tax": null,
"addresses": [],
"emails": [],
"phones": [],
"primary_address": {
"city": "Hopkinton",
"country": "USA",
"county": "Middlesex",
"full_address": "Hopkinton, MA, 02340",
"id": "4905dd37-0c1b-4023-8052-6980acce4494",
"line1": "972 Ryan Radial",
"line2": "",
"state": "MA",
"type": "Mailing/Billing",
"zip": "02340"
},
"primary_email": {
"id": "16699dbd-b00e-45e8-9635-f49744ffd12c",
"email": "faker81739@gmail.com",
"type": "Work"
},
"primary_phone": {
"id": "3bb720d3-d940-40b3-9a8d-d0241270e2d3",
"phone": "(494) 886-8073",
"type": "Work"
}
}
},
"additional_insureds": [
{
"party_id": "c6855f49-b2d1-4227-b5ca-3abde9b6ef0f",
"contact": {
"id": "39d3b734-1931-46c2-948a-8a56340f098d",
"name": "Madeline Schamberger",
"type": "individual",
"position": null,
"ssn": null,
"dbs": null,
"dob": null,
"fein_tax": null,
"addresses": [],
"emails": [],
"phones": [],
"primary_address": {
"city": "Boston",
"country": "USA",
"county": "Suffolk",
"full_address": "Boston, MA, 02210",
"id": "5634925d-d35b-4130-87bd-245ba4b3e737",
"line1": "123 High St",
"line2": "",
"state": "MA",
"type": "Mailing/Billing",
"zip": "02210"
},
"primary_email": null,
"primary_phone": null
}
}
],
"claimants": [
{
"id": "e0ca51fc-5510-4a14-9f3b-0b3eb20a3112",
"number": "C-50-2020-P01",
"contact": {
"id": "996f936b-d025-48be-83ff-41f7232bb566",
"name": "Sarah Hughes",
"type": "individual",
"position": null,
"ssn": null,
"dbs": null,
"dob": null,
"fein_tax": null,
"addresses": [],
"emails": [],
"phones": [],
"primary_address": {
"city": "Hopkinton",
"country": "USA",
"county": "Middlesex",
"full_address": "Hopkinton, MA, 02340",
"id": "4905dd37-0c1b-4023-8052-6980acce4494",
"line1": "972 Ryan Radial",
"line2": "",
"state": "MA",
"type": "Mailing/Billing",
"zip": "02340"
},
"primary_email": {
"id": "16699dbd-b00e-45e8-9635-f49744ffd12c",
"email": "faker81739@gmail.com",
"type": "Work"
},
"primary_phone": {
"id": "3bb720d3-d940-40b3-9a8d-d0241270e2d3",
"phone": "(494) 886-8073",
"type": "Work"
}
},
"display_number": "P01",
"party_id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c",
"injury_id": "50fe0706-8317-46d0-baad-5921d3efd899"
}
],
"labels": [],
"fnol_note": null,
"product": "ce84d72f-5a19-4f40-b8d3-4593df72cfa4",
"fnol_data": {
"other_risks": [
{
"fields": {
"property_type": "Building Structure (housing, fencing, garages, stores)",
"property_location": "Insured's Location",
"property_damage_details": "Fences and garage are destroyed"
},
"risk_type": {
"name": "damage_property"
},
"party_relations": {
"owner": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
}
}
}
],
"added_parties": [
{
"roles": [
{
"name": "primary_insured"
}
],
"injury": {
"fields": {
"prior_injuries": "Unknown",
"medicare_eligible": "Unknown",
"loss_of_consciousness": "Unknown",
"transported_to_hospital_from_scene": "Unknown"
},
"injury_type": {
"name": "person_injury"
},
"injury_nature_id": "ab2b37beb7324055905a79325d299e92"
},
"contact": {
"id": "996f936b-d025-48be-83ff-41f7232bb566",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Sarah Hughes",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": {
"id": "16699dbd-b00e-45e8-9635-f49744ffd12c",
"type": "Work",
"email": "faker81739@gmail.com"
},
"primary_phone": {
"id": "3bb720d3-d940-40b3-9a8d-d0241270e2d3",
"type": "Work",
"phone": "(494) 886-8073"
},
"primary_address": {
"id": "4905dd37-0c1b-4023-8052-6980acce4494",
"zip": "02340",
"city": "Hopkinton",
"type": "Mailing/Billing",
"line1": "972 Ryan Radial",
"line2": "",
"state": "MA",
"county": "Middlesex",
"country": "USA",
"full_address": "Hopkinton, MA, 02340"
}
},
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566",
"party_type": {
"name": "individual"
},
"preferred_email_id": "16699dbd-b00e-45e8-9635-f49744ffd12c",
"preferred_phone_id": "3bb720d3-d940-40b3-9a8d-d0241270e2d3",
"preferred_address_id": "4905dd37-0c1b-4023-8052-6980acce4494"
},
{
"roles": [
{
"name": "insured"
}
],
"contact": {
"id": "39d3b734-1931-46c2-948a-8a56340f098d",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Madeline Schamberger",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": null,
"primary_phone": null,
"primary_address": {
"id": "5634925d-d35b-4130-87bd-245ba4b3e737",
"zip": "02210",
"city": "Boston",
"type": "Mailing/Billing",
"line1": "123 High St",
"line2": "",
"state": "MA",
"county": "Suffolk",
"country": "USA",
"full_address": "Boston, MA, 02210"
}
},
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d",
"party_type": {
"name": "individual"
},
"preferred_email_id": null,
"preferred_phone_id": null,
"preferred_address_id": "5634925d-d35b-4130-87bd-245ba4b3e737"
},
{
"roles": [],
"injury": {
"fields": {
"prior_injuries": "Unknown",
"medicare_eligible": "Unknown",
"loss_of_consciousness": "Unknown",
"transported_to_hospital_from_scene": "Unknown"
},
"injury_type": {
"name": "person_injury"
},
"injury_nature_id": "ab2b37beb7324055905a79325d299e92"
},
"contact": {
"id": "93bc6a59-4932-4752-a3e7-4788365544de",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Joe Insured",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [
{
"id": "7b715784-ddeb-11e9-8a34-2a2ae2dbcce4",
"zip": "12345",
"city": "Schenectady",
"type": "Mailing/Billing",
"line1": "456 Low St",
"line2": "",
"state": "NY",
"county": "Schenectady",
"country": "USA",
"full_address": "Schenectady, NY, 12345"
}
],
"primary_email": {
"id": "c3468365-ed68-4a0c-ba98-b1b800116bd5",
"type": "Home",
"email": "faker89154@gmail.com"
},
"primary_phone": {
"id": "33fea6ef-0220-4545-9c52-4b15dc2d7e65",
"type": "Home",
"phone": "(712) 447-5281"
},
"primary_address": {
"id": "0751608a-abf1-480b-92cc-9895cdad5c16",
"zip": "02210",
"city": "Boston",
"type": "Mailing/Billing",
"line1": "123 High St",
"line2": "",
"state": "MA",
"county": "Suffolk",
"country": "USA",
"full_address": "Boston, MA, 02210"
}
},
"contact_id": "93bc6a59-4932-4752-a3e7-4788365544de",
"party_type": {
"name": "individual"
},
"preferred_email_id": "c3468365-ed68-4a0c-ba98-b1b800116bd5",
"preferred_phone_id": "33fea6ef-0220-4545-9c52-4b15dc2d7e65",
"preferred_address_id": "0751608a-abf1-480b-92cc-9895cdad5c16"
},
{
"roles": [],
"contact": {
"id": "56d5901f-715f-47c7-b997-e500647d43d1",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Premium Finance Co",
"type": "organization",
"emails": [],
"phones": [],
"fein_tax": "18-2747843",
"position": null,
"addresses": [],
"primary_email": {
"id": "55367a36-fe5b-4a13-bfec-5c53f0200302",
"type": "Work",
"email": "faker35706@gmail.com"
},
"primary_phone": {
"id": "90cd5828-7bcd-49ec-9989-c3d0982588da",
"type": "Work",
"phone": "(417) 875-6948"
},
"primary_address": {
"id": "e288df88-ddea-11e9-9d36-2a2ae2dbcce4",
"zip": "04110",
"city": "Cumberland Foreside",
"type": "Mailing/Billing",
"line1": "208 Labadie Circle",
"line2": "",
"state": "ME",
"county": "Cumberland",
"country": "USA",
"full_address": "Cumberland Foreside, ME, 04110"
}
},
"contact_id": "56d5901f-715f-47c7-b997-e500647d43d1",
"party_type": {
"name": "organization"
},
"preferred_email_id": "55367a36-fe5b-4a13-bfec-5c53f0200302",
"preferred_phone_id": "90cd5828-7bcd-49ec-9989-c3d0982588da",
"preferred_address_id": "e288df88-ddea-11e9-9d36-2a2ae2dbcce4"
}
],
"reported_date": "2020-07-24",
"reported_time": "13:04:27.293574",
"party_relations": {
"agent": {
"contact_id": "56d5901f-715f-47c7-b997-e500647d43d1"
},
"insured": {
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d"
},
"reporter": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
},
"primary_insured": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
}
},
"policy_revision": {
"id": "595320df-d6ca-4348-8b3e-d0ebc45366a8",
"policy": {
"id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"number": "P-50-2019"
},
"policy_type": {
"id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"name": "personal_auto",
"label": "Personal auto"
}
},
"reported_method": {
"name": "police_report"
},
"first_party_risk": {
"damage": {
"fields": {
"damage_locations": [
"Unknown"
],
"vehicle_drivable": "Unknown",
"car_seat_involved": "Unknown",
"first_point_impact": "Unknown",
"damage_details_known": "No",
"vehicle_towed_from_scene": "Unknown"
},
"damage_type": {
"name": "damage_vehicle"
}
},
"fields": {
"vin": "1GNGC26RXXJ407648",
"make": "Ford",
"year": "2012",
"color": "Black",
"model": "Edge",
"license_plate": "AHS 2503",
"license_state": "NY"
},
"coverages": [
{
"name": "private_passenger_auto_property_damage_liability",
"type": "per_person",
"label": "Property Damage Liability",
"value": 100000
},
{
"name": "private_passenger_auto_bodily_injury_liability",
"type": "per_occurrence",
"label": "Bodily Injury Liability",
"value": 300000
},
{
"name": "private_passenger_auto_uninsured_motorist_property_damage",
"type": "deductible",
"label": "Uninsured Motorist Property Damage",
"value": 250
},
{
"name": "private_passenger_auto_underinsured_motorist_property_damage",
"type": "deductible",
"label": "Underinsured Motorist Property Damage",
"value": 100
},
{
"name": "private_passenger_auto_towing_and_labor_costs",
"type": "per_person",
"label": "Towing and Labor Costs",
"value": 7000
},
{
"name": "private_passenger_auto_tapes_records_discs_and_other_media",
"type": "per_person",
"label": "Tapes, Records, Discs and Other Media",
"value": 100000
},
{
"name": "private_passenger_auto_rental_reimbursement_optional_limits",
"type": "per_occurrence",
"label": "Rental Reimbursement - Optional Limits",
"value": 300000
},
{
"name": "private_passenger_auto_customized_equipment_coverage",
"type": "per_occurrence",
"label": "Customized Equipment Coverage",
"value": 100000
},
{
"name": "private_passenger_auto_auto_loan_lease",
"type": "per_occurrence",
"label": "Auto Loan Lease",
"value": 1000
},
{
"name": "private_passenger_auto_audio_visual_and_data_electronic_equipment",
"type": "per_occurrence",
"label": "Audio, Visual and Data Electronic Equipment",
"value": 1000
},
{
"name": "private_passenger_auto_comprehensive",
"type": "per_occurrence",
"label": "Comprehensive",
"value": 1000
},
{
"name": "private_passenger_auto_collision",
"type": "per_occurrence",
"label": "Collision",
"value": 1000
},
{
"name": "private_passenger_auto_uninsured_motorist_bodily_injury",
"type": "per_occurrence",
"label": "Uninsured Motorist Bodily Injury",
"value": 1000
},
{
"name": "private_passenger_auto_underinsured_motorist_bodily_injury_coverage",
"type": "per_occurrence",
"label": "Underinsured Motorist Bodily Injury Coverage",
"value": 1000
},
{
"name": "private_passenger_auto_medical_expense",
"type": "per_occurrence",
"label": "Medical Expense (Stackable in Virginia up to four vehicles)",
"value": 1000
}
],
"risk_type": {
"name": "private_passenger_auto"
},
"party_relations": {
"owner": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
},
"driver": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
},
"passenger": {
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d"
}
}
},
"loss_information": {
"fields": {
"is_there_a_police_report": "No",
"number_of_vehicles_involved": "2",
"loss_occurred_at_the_insured_residence": "No"
},
"date_of_loss": "2020-07-24",
"time_of_loss": "13:04:27.293574",
"loss_category": {
"name": "other"
},
"loss_location": {
"zip": "84168",
"city": "Johnsonborough",
"line1": "6722 Stephens Summit Apt. 909",
"line2": "Apt. 286",
"state": "ME",
"county": "",
"country": "USA",
"latitude": "51.420814",
"longitude": "-14.226701"
}
},
"third_party_risks": [
{
"damage": {
"fields": {
"damage_locations": [
"Unknown"
],
"vehicle_drivable": "Unknown",
"car_seat_involved": "Unknown",
"first_point_impact": "Unknown",
"damage_details_known": "No",
"vehicle_towed_from_scene": "Unknown"
},
"damage_type": {
"name": "damage_vehicle"
}
},
"fields": {
"vin": "2C3CCAFJ2CH801561",
"make": "Chevy",
"year": "2005",
"color": "Blue",
"model": "Silverado",
"license_plate": "AHS 1502",
"license_state": "VA"
},
"risk_type": {
"name": "private_passenger_auto"
},
"party_relations": {
"owner": {
"contact_id": "56d5901f-715f-47c7-b997-e500647d43d1"
},
"driver": {
"contact_id": "93bc6a59-4932-4752-a3e7-4788365544de"
}
}
}
]
},
"status_change_reason": "",
"loss_information": {
"id": "58d69031-e24d-43c9-8404-b720dba6a5fd",
"loss_category": {
"id": "fa35d8aa-3ff2-4bc2-96de-bba76ec64226",
"name": "other",
"label": "Other",
"order": 9
},
"loss_location": {
"id": "7835a3aa-fe62-42b4-bc4c-58966fca908a",
"line1": "6722 Stephens Summit Apt. 909",
"line2": "Apt. 286",
"city": "Johnsonborough",
"country": "USA",
"county": "",
"state": "ME",
"zip": "84168",
"latitude": 51.420814,
"longitude": -14.226701,
"full_address": "6722 Stephens Summit Apt. 909, Apt. 286, Johnsonborough, ME, 84168",
"other_details": null,
"type": null
},
"date_of_loss": "2020-07-24",
"time_of_loss": "13:04:27.293574",
"description": null,
"fields": {
"number_of_vehicles_involved": "2",
"loss_occurred_at_the_insured_residence": "No",
"is_there_a_police_report": "No"
}
},
"exposures_folder_id": null
}

Step 4: Retrieve and display claim status

The endpoint claims_statuses_read (/claims/statuses/{status_id}/) allows you to display the claim status using status_id (you can retrieve the status_id from step 2 or step 3).

Sample request

View code

curl --location --request GET /api/claims/statuses/b5d3ad76-4ade-496b-bb6b-d125e268a413/' \
--header 'Authorization:

Sample response

View code

{
"id": "b5d3ad76-4ade-496b-bb6b-d125e268a413",
"name": "new",
"label": "New",
"type": "system",
"meta": {}
}

Step 5: Retrieve possible claim statuses

A claim can have the following statuses:

  • New
  • Open
  • Closed
  • Reopen
  • Archive

What a status can change to is conditional. You can change the status from:

  • New > Open
  • Open > Closed
  • Closed > Reopen

The claims_available_statuses endpoint (/claims/{claim_id}/available-statuses/) will list the available status of a particular claim. You need to pass the claim_id (from step 2 or step 3)

Sample request

View code

curl --location --request GET '/api/claims/6e452784-3d72-437b-907e-1942aead722a/available-statuses/' \
--header 'Authorization: '

Sample response

For this claim, your only available status is closed.

View code

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "eda50c8c-f6c5-41c1-9206-5b53930e94a9",
"name": "closed",
"label": "Closed",
"type": "system",
"meta": {}
}
]
}

Step 6: List all exposures (to close claim)

To close a claim, you must first close all the related exposures. To list all exposures linked to a claim, use the claims_exposures_create (/claims/{claim_id}/exposures/) to list all the exposures that belong to a given claim.

Sample request

View code

curl --location --request GET '/api/claims/6e452784-3d72-437b-907e-1942aead722a/exposures/' \
--header 'Authorization: '

Sample response

View code

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "35f69caf-897b-4c87-a0b0-6957f670c3f8",
"number": "C-50-2020-E001",
"coverage": {
"id": "d6b91de4-9509-47ce-932e-206ddc86df94",
"name": "private_passenger_auto_medical_expense",
"label": "Medical Expense (Stackable in Virginia up to four vehicles)",
"description": null,
"perils": [],
"item": {
"id": "ededc704-f3fe-4295-ad0a-158b72b5aabd",
"external_name": "medical_expense",
"item_type": {
"name": "first",
"label": "1st Party"
},
"risk_type": {
"id": "86e2d246-293e-412e-acc0-9976e36846a0",
"name": "private_passenger_auto",
"label": "Private Passenger Auto",
"name_template": "{{year}} {{make}} {{model}}",
"sub_name_template": "{{vin}}",
"external_name": "private_passenger_auto",
"attributes": [
{
"type": "attribute",
"id": "5"
},
{
"type": "attribute",
"id": "6"
},
{
"type": "attribute",
"id": "22"
},
{
"type": "attribute",
"id": "19"
},
{
"type": "attribute",
"id": "20"
},
{
"type": "attribute",
"id": "4"
},
{
"type": "attribute",
"id": "18"
}
],
"damage_type": {
"type": "damage-type",
"id": "d79688d3-5363-46e3-94ce-81ed72628dd7"
},
"risk_type_group": {
"type": "risk-type-group",
"id": "436fd274-ab63-4687-8539-f17c86c0eadf"
}
},
"coverage_type": {
"id": "a86ad5ab-69af-4dc4-947d-92a1daaee02d",
"name": "medical_expense",
"label": "Medical Expense (Stackable in Virginia up to four vehicles)"
},
"coverage_group": {
"id": "2a883a5e-72a3-4ec9-8042-6b721cdee171",
"name": "injury",
"label": "Injury"
}
},
"reason_for_manual_coverage": null,
"is_manual": false,
"limits": [],
"deductible_amount": 0.0
},
"coverage_id": "d6b91de4-9509-47ce-932e-206ddc86df94",
"claimant": {
"id": "e0ca51fc-5510-4a14-9f3b-0b3eb20a3112",
"number": "C-50-2020-P01",
"contact": {
"id": "996f936b-d025-48be-83ff-41f7232bb566",
"dbs": null,
"dob": null,
"dba": "",
"ssn": "771-23-4567",
"name": "Sarah Hughes",
"type": "individual",
"fein_tax": null,
"position": null,
"addresses": [],
"phones": [
{
"id": "56b2d7a2-2c16-48fe-b646-a64fb7fa0515",
"type": "home",
"phone": "+15555555555"
},
{
"id": "88bf5c2e-f1b6-4ca1-b8ea-656d63bf6dc9",
"type": "home",
"phone": "+12222222222"
},
{
"id": "dbdb6e8f-35e5-406f-a596-2e05e8b8c66d",
"type": "home",
"phone": "+19999999999"
}
],
"emails": [
{
"id": "80cf9eda-c777-4b40-bcc8-d48c14865fc2",
"type": "home",
"email": "222@gmail.com"
}
],
"primary_address": {
"id": "e38ba6ec-3d39-4918-b957-771ae02e7a54",
"zip": "10000",
"city": "New York",
"type": "Mailing/Billing",
"line1": "plp",
"line2": "plp2",
"state": "NY",
"county": "New York",
"country": "USA"
},
"primary_phone": {
"id": "2082b98d-2168-414b-9a6c-6217c84a360b",
"type": "home",
"phone": "+17777777777"
},
"primary_email": {
"id": "181f765a-11ef-484a-811b-c8542f2fc6fd",
"type": "home",
"email": "lol@dds.com"
},
"is_approved_vendor": true
},
"display_number": "P01",
"party_id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c",
"injury_id": "50fe0706-8317-46d0-baad-5921d3efd899"
},
"status": {
"id": "e3491b4a-b75d-11e8-96f8-529269fb1459",
"name": "open",
"label": "Open",
"type": "system",
"meta": {}
},
"adjuster": null,
"adjuster_id": null,
"display_number": "E001",
"accounting": {
"reserve_amount": 0.0,
"payments_amount": 0.0,
"total_incurred_amount": 0,
"recovered_amount": 0,
"net_incurred_amount": 0,
"coverage_limit": "--"
},
"status_change_reason": "",
"risks": [
{
"id": "cfbd0f2e-56b6-47df-869f-bdaad9663de7",
"name": "2012 Ford Edge",
"sub_name": "1GNGC26RXXJ407648",
"external_id": "",
"is_first_party_risk": true,
"risk_type": {
"type": "risk-type",
"id": "86e2d246-293e-412e-acc0-9976e36846a0"
},
"party_relations": [
{
"type": "party",
"id": "c6855f49-b2d1-4227-b5ca-3abde9b6ef0f"
},
{
"type": "party",
"id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c"
},
{
"type": "party",
"id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c"
}
],
"damage": {
"type": "damage",
"id": "aad39e23-e54b-422f-834b-8ec7dfa3d585"
},
"insurance_information": null,
"fields": {
"vin": "1GNGC26RXXJ407648",
"color": "Black",
"license_plate": "AHS 2503",
"year": 2012,
"make": "Ford",
"model": "Edge",
"license_state": "NY"
},
"party_relations_count": 3
}
],
"description": null,
"is_injury": false,
"deductible_override_amount": null,
"deductible_override_reason": null,
"folder_id": null,
"full_deductible_applied": false,
"deductible_applied_transactions_str": "Paid on Transaction(s): ",
"is_deletable": true
}
]
}

Step 7: Retrieve available exposure status

The claims_statuses_exposure_name_read (/claims/statuses/exposure/name/{exposure_status_name}/) lists the possible exposure statuses for a particular exposure_id. Retrieve the exposure_id from Step 6. You will need the status_id for step 8.

Sample request

View code

curl --location --request GET ' /api/claims/exposures/35f69caf-897b-4c87-a0b0-6957f670c3f8/available-statuses/' \
--header 'Authorization: '

Sample response

View code

{
"count": 1,
"next": null,
"previous": null,
"results": [
{
"id": "e3492a2c-b75d-11e8-96f8-529269fb1459",
"name": "closed",
"label": "Closed",
"type": "system",
"meta": {}
}
]
}

Step 8: Update exposure status

The claims_statuses_exposure_update endpoint (/claims/statuses/exposure/{exposure_status_id}/) will allow you to update the status using the status_id from step 7.

Sample request

View code

curl --location --request PATCH '/api/claims/exposures/35f69caf-897b-4c87-a0b0-6957f670c3f8/' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{"status_id": "e3492a2c-b75d-11e8-96f8-529269fb1459"
}'

Sample response

View code
{
"id": "35f69caf-897b-4c87-a0b0-6957f670c3f8",
"number": "C-50-2020-E001",
"coverage": {
"id": "d6b91de4-9509-47ce-932e-206ddc86df94",
"name": "private_passenger_auto_medical_expense",
"label": "Medical Expense (Stackable in Virginia up to four vehicles)",
"description": null,
"perils": [],
"item": {
"id": "ededc704-f3fe-4295-ad0a-158b72b5aabd",
"external_name": "medical_expense",
"item_type": {
"name": "first",
"label": "1st Party"
},
"risk_type": {
"id": "86e2d246-293e-412e-acc0-9976e36846a0",
"name": "private_passenger_auto",
"label": "Private Passenger Auto",
"name_template": "{{year}} {{make}} {{model}}",
"sub_name_template": "{{vin}}",
"external_name": "private_passenger_auto",
"attributes": [
{
"type": "attribute",
"id": "5"
},
{
"type": "attribute",
"id": "6"
},
{
"type": "attribute",
"id": "22"
},
{
"type": "attribute",
"id": "19"
},
{
"type": "attribute",
"id": "20"
},
{
"type": "attribute",
"id": "4"
},
{
"type": "attribute",
"id": "18"
}
],
"damage_type": {
"type": "damage-type",
"id": "d79688d3-5363-46e3-94ce-81ed72628dd7"
},
"risk_type_group": {
"type": "risk-type-group",
"id": "436fd274-ab63-4687-8539-f17c86c0eadf"
}
},
"coverage_type": {
"id": "a86ad5ab-69af-4dc4-947d-92a1daaee02d",
"name": "medical_expense",
"label": "Medical Expense (Stackable in Virginia up to four vehicles)"
},
"coverage_group": {
"id": "2a883a5e-72a3-4ec9-8042-6b721cdee171",
"name": "injury",
"label": "Injury"
}
},
"reason_for_manual_coverage": null,
"is_manual": false,
"limits": [],
"deductible_amount": 0.0
},
"coverage_id": "d6b91de4-9509-47ce-932e-206ddc86df94",
"claimant": {
"id": "e0ca51fc-5510-4a14-9f3b-0b3eb20a3112",
"number": "C-50-2020-P01",
"contact": {
"id": "996f936b-d025-48be-83ff-41f7232bb566",
"dbs": null,
"dob": null,
"dba": "",
"ssn": "771-23-4567",
"name": "Sarah Hughes",
"type": "individual",
"fein_tax": null,
"position": null,
"addresses": [],
"phones": [
{
"id": "56b2d7a2-2c16-48fe-b646-a64fb7fa0515",
"type": "home",
"phone": "+15555555555"
},
{
"id": "88bf5c2e-f1b6-4ca1-b8ea-656d63bf6dc9",
"type": "home",
"phone": "+12222222222"
},
{
"id": "dbdb6e8f-35e5-406f-a596-2e05e8b8c66d",
"type": "home",
"phone": "+19999999999"
}
],
"emails": [
{
"id": "80cf9eda-c777-4b40-bcc8-d48c14865fc2",
"type": "home",
"email": "222@gmail.com"
}
],
"primary_address": {
"id": "e38ba6ec-3d39-4918-b957-771ae02e7a54",
"zip": "10000",
"city": "New York",
"type": "Mailing/Billing",
"line1": "plp",
"line2": "plp2",
"state": "NY",
"county": "New York",
"country": "USA"
},
"primary_phone": {
"id": "2082b98d-2168-414b-9a6c-6217c84a360b",
"type": "home",
"phone": "+17777777777"
},
"primary_email": {
"id": "181f765a-11ef-484a-811b-c8542f2fc6fd",
"type": "home",
"email": "lol@dds.com"
},
"is_approved_vendor": true
},
"display_number": "P01",
"party_id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c",
"injury_id": "50fe0706-8317-46d0-baad-5921d3efd899"
},
"status": {
"id": "e3492a2c-b75d-11e8-96f8-529269fb1459",
"name": "closed",
"label": "Closed",
"type": "system",
"meta": {}
},
"adjuster": null,
"adjuster_id": null,
"display_number": "E001",
"accounting": {
"reserve_amount": 0.0,
"payments_amount": 0.0,
"total_incurred_amount": 0,
"recovered_amount": 0,
"net_incurred_amount": 0,
"coverage_limit": "--"
},
"status_change_reason": "",
"risks": [
{
"id": "cfbd0f2e-56b6-47df-869f-bdaad9663de7",
"name": "2012 Ford Edge",
"sub_name": "1GNGC26RXXJ407648",
"external_id": "",
"is_first_party_risk": true,
"risk_type": {
"type": "risk-type",
"id": "86e2d246-293e-412e-acc0-9976e36846a0"
},
"party_relations": [
{
"type": "party",
"id": "c6855f49-b2d1-4227-b5ca-3abde9b6ef0f"
},
{
"type": "party",
"id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c"
},
{
"type": "party",
"id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c"
}
],
"damage": {
"type": "damage",
"id": "aad39e23-e54b-422f-834b-8ec7dfa3d585"
},
"insurance_information": null,
"fields": {
"vin": "1GNGC26RXXJ407648",
"color": "Black",
"license_plate": "AHS 2503",
"year": 2012,
"make": "Ford",
"model": "Edge",
"license_state": "NY"
},
"party_relations_count": 3
}
],
"description": null,
"is_injury": false,
"deductible_override_amount": null,
"deductible_override_reason": null,
"folder_id": null,
"full_deductible_applied": false,
"deductible_applied_transactions_str": "Paid on Transaction(s): ",
"is_deletable": true
}

Step 9: Update claim status

To update the claim status to closed, you must make sure the exposures related to the claim are also set to close. Refer to steps 6, 7, and 8. Pass the possible status_id from step 5 to update the claim status. Use the claims_update endpoint (/claims/{claim_id}/) and pass the status_id.

Sample request

View code

curl --location --request PATCH 'https:///api/claims/6e452784-3d72-437b-907e-1942aead722a/' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
"status_id": "eda50c8c-f6c5-41c1-9206-5b53930e94a9"
}'

Sample response

View code

{
"id": "6e452784-3d72-437b-907e-1942aead722a",
"number": "C-50-2020",
"status": {
"id": "eda50c8c-f6c5-41c1-9206-5b53930e94a9",
"name": "closed",
"label": "Closed",
"type": "system",
"meta": {}
},
"complexity": "7dbfc881-7a76-4fe8-aee9-d49642171dfe",
"reported_method": {
"id": "aea7733f-ee48-48fb-825b-8b7cae8ed676",
"name": "police_report",
"label": "Police Report"
},
"reported_date": "2020-07-24",
"reported_time": "13:07:22.064143",
"policy_id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"policy_type_id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"policy_revision_id": "595320df-d6ca-4348-8b3e-d0ebc45366a8",
"policy_number": "P-50-2019",
"external_data": {
"policy": {
"data": {
"id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"number": "P-50-2019"
}
},
"policy_type": {
"data": {
"id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"name": "personal_auto",
"label": "Personal auto"
}
},
"policy_revision": {
"data": {
"id": "595320df-d6ca-4348-8b3e-d0ebc45366a8",
"policy": {
"id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"number": "P-50-2019"
},
"policy_type": {
"id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"name": "personal_auto",
"label": "Personal auto"
}
}
}
},
"policy": {
"id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"number": "P-50-2019"
},
"policy_type": {
"id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"name": "personal_auto",
"label": "Personal auto"
},
"policy_revision": {
"id": "595320df-d6ca-4348-8b3e-d0ebc45366a8",
"policy": {
"id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"number": "P-50-2019"
},
"policy_type": {
"id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"name": "personal_auto",
"label": "Personal auto"
}
},
"perils": [
"c72a2bb3-4d5b-44cf-858d-ea6e5ad98981",
"bb23160b-cffe-404f-9092-43fa6de2443b"
],
"primary_adjuster": null,
"reporter_id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c",
"primary_insured": {
"party_id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c",
"contact": {
"id": "996f936b-d025-48be-83ff-41f7232bb566",
"dbs": null,
"dob": null,
"dba": "",
"ssn": "771-23-4567",
"name": "Sarah Hughes",
"type": "individual",
"fein_tax": null,
"position": null,
"addresses": [],
"phones": [
{
"id": "56b2d7a2-2c16-48fe-b646-a64fb7fa0515",
"type": "home",
"phone": "+15555555555"
},
{
"id": "88bf5c2e-f1b6-4ca1-b8ea-656d63bf6dc9",
"type": "home",
"phone": "+12222222222"
},
{
"id": "dbdb6e8f-35e5-406f-a596-2e05e8b8c66d",
"type": "home",
"phone": "+19999999999"
}
],
"emails": [
{
"id": "80cf9eda-c777-4b40-bcc8-d48c14865fc2",
"type": "home",
"email": "222@gmail.com"
}
],
"primary_address": {
"id": "e38ba6ec-3d39-4918-b957-771ae02e7a54",
"zip": "10000",
"city": "New York",
"type": "Mailing/Billing",
"line1": "plp",
"line2": "plp2",
"state": "NY",
"county": "New York",
"country": "USA"
},
"primary_phone": {
"id": "2082b98d-2168-414b-9a6c-6217c84a360b",
"type": "home",
"phone": "+17777777777"
},
"primary_email": {
"id": "181f765a-11ef-484a-811b-c8542f2fc6fd",
"type": "home",
"email": "lol@dds.com"
},
"is_approved_vendor": true
}
},
"additional_insureds": [
{
"party_id": "c6855f49-b2d1-4227-b5ca-3abde9b6ef0f",
"contact": {
"id": "39d3b734-1931-46c2-948a-8a56340f098d",
"name": "Madeline Schamberger",
"type": "individual",
"position": null,
"ssn": null,
"dbs": null,
"dob": null,
"fein_tax": null,
"addresses": [],
"emails": [],
"phones": [],
"primary_address": {
"city": "Boston",
"country": "USA",
"county": "Suffolk",
"full_address": "Boston, MA, 02210",
"id": "5634925d-d35b-4130-87bd-245ba4b3e737",
"line1": "123 High St",
"line2": "",
"state": "MA",
"type": "Mailing/Billing",
"zip": "02210"
},
"primary_email": null,
"primary_phone": null
}
}
],
"claimants": [
{
"id": "e0ca51fc-5510-4a14-9f3b-0b3eb20a3112",
"number": "C-50-2020-P01",
"contact": {
"id": "996f936b-d025-48be-83ff-41f7232bb566",
"dbs": null,
"dob": null,
"dba": "",
"ssn": "771-23-4567",
"name": "Sarah Hughes",
"type": "individual",
"fein_tax": null,
"position": null,
"addresses": [],
"phones": [
{
"id": "56b2d7a2-2c16-48fe-b646-a64fb7fa0515",
"type": "home",
"phone": "+15555555555"
},
{
"id": "88bf5c2e-f1b6-4ca1-b8ea-656d63bf6dc9",
"type": "home",
"phone": "+12222222222"
},
{
"id": "dbdb6e8f-35e5-406f-a596-2e05e8b8c66d",
"type": "home",
"phone": "+19999999999"
}
],
"emails": [
{
"id": "80cf9eda-c777-4b40-bcc8-d48c14865fc2",
"type": "home",
"email": "222@gmail.com"
}
],
"primary_address": {
"id": "e38ba6ec-3d39-4918-b957-771ae02e7a54",
"zip": "10000",
"city": "New York",
"type": "Mailing/Billing",
"line1": "plp",
"line2": "plp2",
"state": "NY",
"county": "New York",
"country": "USA"
},
"primary_phone": {
"id": "2082b98d-2168-414b-9a6c-6217c84a360b",
"type": "home",
"phone": "+17777777777"
},
"primary_email": {
"id": "181f765a-11ef-484a-811b-c8542f2fc6fd",
"type": "home",
"email": "lol@dds.com"
},
"is_approved_vendor": true
},
"display_number": "P01",
"party_id": "269e65cd-095d-4b3f-ac3c-f1a65ba91a4c",
"injury_id": "50fe0706-8317-46d0-baad-5921d3efd899"
}
],
"labels": [],
"fnol_note": null,
"product": "ce84d72f-5a19-4f40-b8d3-4593df72cfa4",
"fnol_data": {
"other_risks": [
{
"fields": {
"property_type": "Building Structure (housing, fencing, garages, stores)",
"property_location": "Insured's Location",
"property_damage_details": "Fences and garage are destroyed"
},
"risk_type": {
"name": "damage_property"
},
"party_relations": {
"owner": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
}
}
}
],
"added_parties": [
{
"roles": [
{
"name": "primary_insured"
}
],
"injury": {
"fields": {
"prior_injuries": "Unknown",
"medicare_eligible": "Unknown",
"loss_of_consciousness": "Unknown",
"transported_to_hospital_from_scene": "Unknown"
},
"injury_type": {
"name": "person_injury"
},
"injury_nature_id": "ab2b37beb7324055905a79325d299e92"
},
"contact": {
"id": "996f936b-d025-48be-83ff-41f7232bb566",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Sarah Hughes",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": {
"id": "16699dbd-b00e-45e8-9635-f49744ffd12c",
"type": "Work",
"email": "faker81739@gmail.com"
},
"primary_phone": {
"id": "3bb720d3-d940-40b3-9a8d-d0241270e2d3",
"type": "Work",
"phone": "(494) 886-8073"
},
"primary_address": {
"id": "4905dd37-0c1b-4023-8052-6980acce4494",
"zip": "02340",
"city": "Hopkinton",
"type": "Mailing/Billing",
"line1": "972 Ryan Radial",
"line2": "",
"state": "MA",
"county": "Middlesex",
"country": "USA",
"full_address": "Hopkinton, MA, 02340"
}
},
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566",
"party_type": {
"name": "individual"
},
"preferred_email_id": "16699dbd-b00e-45e8-9635-f49744ffd12c",
"preferred_phone_id": "3bb720d3-d940-40b3-9a8d-d0241270e2d3",
"preferred_address_id": "4905dd37-0c1b-4023-8052-6980acce4494"
},
{
"roles": [
{
"name": "insured"
}
],
"contact": {
"id": "39d3b734-1931-46c2-948a-8a56340f098d",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Madeline Schamberger",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [],
"primary_email": null,
"primary_phone": null,
"primary_address": {
"id": "5634925d-d35b-4130-87bd-245ba4b3e737",
"zip": "02210",
"city": "Boston",
"type": "Mailing/Billing",
"line1": "123 High St",
"line2": "",
"state": "MA",
"county": "Suffolk",
"country": "USA",
"full_address": "Boston, MA, 02210"
}
},
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d",
"party_type": {
"name": "individual"
},
"preferred_email_id": null,
"preferred_phone_id": null,
"preferred_address_id": "5634925d-d35b-4130-87bd-245ba4b3e737"
},
{
"roles": [],
"injury": {
"fields": {
"prior_injuries": "Unknown",
"medicare_eligible": "Unknown",
"loss_of_consciousness": "Unknown",
"transported_to_hospital_from_scene": "Unknown"
},
"injury_type": {
"name": "person_injury"
},
"injury_nature_id": "ab2b37beb7324055905a79325d299e92"
},
"contact": {
"id": "93bc6a59-4932-4752-a3e7-4788365544de",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Joe Insured",
"type": "individual",
"emails": [],
"phones": [],
"fein_tax": null,
"position": null,
"addresses": [
{
"id": "7b715784-ddeb-11e9-8a34-2a2ae2dbcce4",
"zip": "12345",
"city": "Schenectady",
"type": "Mailing/Billing",
"line1": "456 Low St",
"line2": "",
"state": "NY",
"county": "Schenectady",
"country": "USA",
"full_address": "Schenectady, NY, 12345"
}
],
"primary_email": {
"id": "c3468365-ed68-4a0c-ba98-b1b800116bd5",
"type": "Home",
"email": "faker89154@gmail.com"
},
"primary_phone": {
"id": "33fea6ef-0220-4545-9c52-4b15dc2d7e65",
"type": "Home",
"phone": "(712) 447-5281"
},
"primary_address": {
"id": "0751608a-abf1-480b-92cc-9895cdad5c16",
"zip": "02210",
"city": "Boston",
"type": "Mailing/Billing",
"line1": "123 High St",
"line2": "",
"state": "MA",
"county": "Suffolk",
"country": "USA",
"full_address": "Boston, MA, 02210"
}
},
"contact_id": "93bc6a59-4932-4752-a3e7-4788365544de",
"party_type": {
"name": "individual"
},
"preferred_email_id": "c3468365-ed68-4a0c-ba98-b1b800116bd5",
"preferred_phone_id": "33fea6ef-0220-4545-9c52-4b15dc2d7e65",
"preferred_address_id": "0751608a-abf1-480b-92cc-9895cdad5c16"
},
{
"roles": [],
"contact": {
"id": "56d5901f-715f-47c7-b997-e500647d43d1",
"dbs": null,
"dob": null,
"ssn": null,
"name": "Premium Finance Co",
"type": "organization",
"emails": [],
"phones": [],
"fein_tax": "18-2747843",
"position": null,
"addresses": [],
"primary_email": {
"id": "55367a36-fe5b-4a13-bfec-5c53f0200302",
"type": "Work",
"email": "faker35706@gmail.com"
},
"primary_phone": {
"id": "90cd5828-7bcd-49ec-9989-c3d0982588da",
"type": "Work",
"phone": "(417) 875-6948"
},
"primary_address": {
"id": "e288df88-ddea-11e9-9d36-2a2ae2dbcce4",
"zip": "04110",
"city": "Cumberland Foreside",
"type": "Mailing/Billing",
"line1": "208 Labadie Circle",
"line2": "",
"state": "ME",
"county": "Cumberland",
"country": "USA",
"full_address": "Cumberland Foreside, ME, 04110"
}
},
"contact_id": "56d5901f-715f-47c7-b997-e500647d43d1",
"party_type": {
"name": "organization"
},
"preferred_email_id": "55367a36-fe5b-4a13-bfec-5c53f0200302",
"preferred_phone_id": "90cd5828-7bcd-49ec-9989-c3d0982588da",
"preferred_address_id": "e288df88-ddea-11e9-9d36-2a2ae2dbcce4"
}
],
"reported_date": "2020-07-24",
"reported_time": "13:04:27.293574",
"party_relations": {
"agent": {
"contact_id": "56d5901f-715f-47c7-b997-e500647d43d1"
},
"insured": {
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d"
},
"reporter": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
},
"primary_insured": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
}
},
"policy_revision": {
"id": "595320df-d6ca-4348-8b3e-d0ebc45366a8",
"policy": {
"id": "b75a540d-1583-4766-84a2-fad4982ee56c",
"number": "P-50-2019"
},
"policy_type": {
"id": "01879d3f-e035-4ed3-af6d-c59dade8b82c",
"name": "personal_auto",
"label": "Personal auto"
}
},
"reported_method": {
"name": "police_report"
},
"first_party_risk": {
"damage": {
"fields": {
"damage_locations": [
"Unknown"
],
"vehicle_drivable": "Unknown",
"car_seat_involved": "Unknown",
"first_point_impact": "Unknown",
"damage_details_known": "No",
"vehicle_towed_from_scene": "Unknown"
},
"damage_type": {
"name": "damage_vehicle"
}
},
"fields": {
"vin": "1GNGC26RXXJ407648",
"make": "Ford",
"year": "2012",
"color": "Black",
"model": "Edge",
"license_plate": "AHS 2503",
"license_state": "NY"
},
"coverages": [
{
"name": "private_passenger_auto_property_damage_liability",
"type": "per_person",
"label": "Property Damage Liability",
"value": 100000
},
{
"name": "private_passenger_auto_bodily_injury_liability",
"type": "per_occurrence",
"label": "Bodily Injury Liability",
"value": 300000
},
{
"name": "private_passenger_auto_uninsured_motorist_property_damage",
"type": "deductible",
"label": "Uninsured Motorist Property Damage",
"value": 250
},
{
"name": "private_passenger_auto_underinsured_motorist_property_damage",
"type": "deductible",
"label": "Underinsured Motorist Property Damage",
"value": 100
},
{
"name": "private_passenger_auto_towing_and_labor_costs",
"type": "per_person",
"label": "Towing and Labor Costs",
"value": 7000
},
{
"name": "private_passenger_auto_tapes_records_discs_and_other_media",
"type": "per_person",
"label": "Tapes, Records, Discs and Other Media",
"value": 100000
},
{
"name": "private_passenger_auto_rental_reimbursement_optional_limits",
"type": "per_occurrence",
"label": "Rental Reimbursement - Optional Limits",
"value": 300000
},
{
"name": "private_passenger_auto_customized_equipment_coverage",
"type": "per_occurrence",
"label": "Customized Equipment Coverage",
"value": 100000
},
{
"name": "private_passenger_auto_auto_loan_lease",
"type": "per_occurrence",
"label": "Auto Loan Lease",
"value": 1000
},
{
"name": "private_passenger_auto_audio_visual_and_data_electronic_equipment",
"type": "per_occurrence",
"label": "Audio, Visual and Data Electronic Equipment",
"value": 1000
},
{
"name": "private_passenger_auto_comprehensive",
"type": "per_occurrence",
"label": "Comprehensive",
"value": 1000
},
{
"name": "private_passenger_auto_collision",
"type": "per_occurrence",
"label": "Collision",
"value": 1000
},
{
"name": "private_passenger_auto_uninsured_motorist_bodily_injury",
"type": "per_occurrence",
"label": "Uninsured Motorist Bodily Injury",
"value": 1000
},
{
"name": "private_passenger_auto_underinsured_motorist_bodily_injury_coverage",
"type": "per_occurrence",
"label": "Underinsured Motorist Bodily Injury Coverage",
"value": 1000
},
{
"name": "private_passenger_auto_medical_expense",
"type": "per_occurrence",
"label": "Medical Expense (Stackable in Virginia up to four vehicles)",
"value": 1000
}
],
"risk_type": {
"name": "private_passenger_auto"
},
"party_relations": {
"owner": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
},
"driver": {
"contact_id": "996f936b-d025-48be-83ff-41f7232bb566"
},
"passenger": {
"contact_id": "39d3b734-1931-46c2-948a-8a56340f098d"
}
}
},
"loss_information": {
"fields": {
"is_there_a_police_report": "No",
"number_of_vehicles_involved": "2",
"loss_occurred_at_the_insured_residence": "No"
},
"date_of_loss": "2020-07-24",
"time_of_loss": "13:04:27.293574",
"loss_category": {
"name": "other"
},
"loss_location": {
"zip": "84168",
"city": "Johnsonborough",
"line1": "6722 Stephens Summit Apt. 909",
"line2": "Apt. 286",
"state": "ME",
"county": "",
"country": "USA",
"latitude": "51.420814",
"longitude": "-14.226701"
}
},
"third_party_risks": [
{
"damage": {
"fields": {
"damage_locations": [
"Unknown"
],
"vehicle_drivable": "Unknown",
"car_seat_involved": "Unknown",
"first_point_impact": "Unknown",
"damage_details_known": "No",
"vehicle_towed_from_scene": "Unknown"
},
"damage_type": {
"name": "damage_vehicle"
}
},
"fields": {
"vin": "2C3CCAFJ2CH801561",
"make": "Chevy",
"year": "2005",
"color": "Blue",
"model": "Silverado",
"license_plate": "AHS 1502",
"license_state": "VA"
},
"risk_type": {
"name": "private_passenger_auto"
},
"party_relations": {
"owner": {
"contact_id": "56d5901f-715f-47c7-b997-e500647d43d1"
},
"driver": {
"contact_id": "93bc6a59-4932-4752-a3e7-4788365544de"
}
}
}
]
},
"status_change_reason": "",
"loss_information": {
"id": "58d69031-e24d-43c9-8404-b720dba6a5fd",
"loss_category": {
"id": "fa35d8aa-3ff2-4bc2-96de-bba76ec64226",
"name": "other",
"label": "Other",
"order": 9
},
"loss_location": {
"id": "7835a3aa-fe62-42b4-bc4c-58966fca908a",
"line1": "6722 Stephens Summit Apt. 909",
"line2": "Apt. 286",
"city": "Johnsonborough",
"country": "USA",
"county": "",
"state": "ME",
"zip": "84168",
"latitude": 51.420814,
"longitude": -14.226701,
"full_address": "6722 Stephens Summit Apt. 909, Apt. 286, Johnsonborough, ME, 84168",
"other_details": null,
"type": null
},
"date_of_loss": "2020-07-24",
"time_of_loss": "13:04:27.293574",
"description": null,
"fields": {
"number_of_vehicles_involved": "2",
"loss_occurred_at_the_insured_residence": "No",
"is_there_a_police_report": "No"
}
},
"exposures_folder_id": null
}

You have successfully retrieved and displayed claims and statuses, as well as updated your claim status.