Topics on this page

BriteAPI Tutorial: File and update a new claim and retrieve related information (Classic)

BriteCore combines claims administration functionality and business process management (BPM) support for the entire claims process. From open to close, agents and adjusters work collaboratively and efficiently within BriteCore to process first notices of loss (FNOL), establish reserves, upload reports, issue payments, and settle claims.

This tutorial will guide you through filing and updating a new claim (creating and submitting an FNOL), as well as retrieving claims-related information.

Note: For auto-related policy information, refer to the BriteClaims tutorial.

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 first notice of loss (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 and 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 the FNOL is filled
  • 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 (the insureds).
  • Claimant – first party: People not listed on the policy but can claim first party coverages; in some cases can also be considered insureds such as a passenger in the insured vehicle who is not listed on the policy
  • Claimant – third party: People or organizations making claims against our insured under liability coverage types.
  • Coverage: The name of the specific type of insurance that is placed on a risk in the event 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 to a claim.

Create and update an FNOL and retrieve related information

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 policies

Pass a string to the Search endpoint to retrieve a list of matching policies.

Sample request

View code
curl --location --request POST '/api/v2/policies/search' \

--header 'Content-Type: application/json' \

--header 'Authorization: \

--header 'Cookie: webpy_session_id=50065e09d3fee0247ea293caba306ea8ae75b534' \

--data-raw '--data-raw '\''{

"search_string": "",

"sort_obj":{

"field":"effective_date",

"order":"asc"

},

"current_page":1,

"page_size":25

}'\''

'

Sample response

View code
"FlatCancel",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "f17925d1-f0b1-45fb-872f-fde748e6c201",

"expirationDate": "01/06/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "01/13/2019",

"policyNumber": "Endorse02",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "a5242cba-aebf-45f4-bcfd-4ded1ad40114",

"expirationDate": "01/13/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "01/15/2019",

"policyNumber": "Endorse01",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "60ec8a75-c1d0-43be-b601-ad79fc4d712b",

"expirationDate": "01/15/2020"

},

{

"status": "Unsubmitted",

"namedInsured": "Joe Insured",

"effectiveDate": "01/16/2019",

"policyNumber": "P-2019-7",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Commercial Umbrella",

"policyId": "783addab-072a-48bb-8e29-f44d4b6d2246",

"expirationDate": "01/16/2020"

},

{

"status": "Unsubmitted",

"namedInsured": "Joe Insured",

"effectiveDate": "01/17/2019",

"policyNumber": "P-2019-9",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Personal Inland Marine",

"policyId": "61ab60ad-c60a-42c6-85a9-834a7f3e8324",

"expirationDate": "01/17/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "01/17/2019",

"policyNumber": "Endorse03",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "ce94d4e1-d614-4cd3-aeb4-c0ddef4d1b52",

"expirationDate": "01/17/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "01/20/2019",

"policyNumber": "Endorse05",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "48c4bb13-f041-4663-b997-76b93353cba4",

"expirationDate": "01/20/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "01/21/2019",

"policyNumber": "Endorse06",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "ad46ac6c-53b0-4deb-9aac-05c75eb89947",

"expirationDate": "01/21/2020"

},

{

"status": "Active",

"namedInsured": "",

"effectiveDate": "01/24/2019",

"policyNumber": "P-2019-11",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners By Peril",

"policyId": "c972b20c-6a65-479a-b9e8-7cb8f6d4db2e",

"expirationDate": "01/24/2020"

},

{

"status": "Active",

"namedInsured": "Madeline Schamberger",

"effectiveDate": "01/24/2019",

"policyNumber": "P-2019-10",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners By Peril",

"policyId": "3b99c8d3-3841-43cd-8bed-9ad7673bbff1",

"expirationDate": "01/24/2020"

},

{

"status": "Unsubmitted",

"namedInsured": "Joe Insured",

"effectiveDate": "01/31/2019",

"policyNumber": "10-2019-1",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners By Peril",

"policyId": "29d7f944-6a80-4ae9-b7c1-1ea191ee7076",

"expirationDate": "01/31/2020"

},

{

"status": "Active",

"namedInsured": "Joe Insured",

"effectiveDate": "01/31/2019",

"policyNumber": "10-2019-2",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 2",

"policyId": "7db8b1c4-e3c1-44f8-9e14-2ed3c8115aab",

"expirationDate": "01/31/2020"

},

{

"status": "Active",

"namedInsured": "Joe Insured",

"effectiveDate": "01/31/2019",

"policyNumber": "P-2019-13",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 2",

"policyId": "9323da3f-6cb3-48b0-8ac4-6b739fd81542",

"expirationDate": "01/31/2020"

},

{

"status": "Active",

"namedInsured": "Joe Insured",

"effectiveDate": "01/31/2019",

"policyNumber": "P-2019-12",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 2",

"policyId": "478b0c48-207d-4666-8ba0-51900638f30f",

"expirationDate": "01/31/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "New_Business",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "bdcadea4-4aea-481b-a523-10a509d7a5ac",

"expirationDate": "02/01/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "OverPay",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "db638245-0eff-483d-b127-fe7ea1f2095f",

"expirationDate": "02/01/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "UnderPay",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "b5edd0f3-e0d1-49b1-af3a-3f50d5812dbd",

"expirationDate": "02/01/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "NSFPay",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "5eb7daf2-6c7b-4b83-946c-9949c8787580",

"expirationDate": "02/01/2020"

},

{

"status": "Canceled",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "MidCancel",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "aace7a72-3d81-4d5a-b19d-a7ee7e7be9c1",

"expirationDate": "02/01/2020"

},

{

"status": "Active",

"namedInsured": "Test Named Insured",

"effectiveDate": "02/01/2019",

"policyNumber": "AgencyBill",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Homeowners Form 3",

"policyId": "3994b493-e6c3-4790-881c-3cead217d904",

"expirationDate": "02/01/2020"

},

{

"status": "Active",

"namedInsured": "Joe Insured",

"effectiveDate": "02/05/2019",

"policyNumber": "Q-2019-4",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Commercial Package",

"policyId": "8b430839-e3a7-47be-85a0-893931509530",

"expirationDate": "02/05/2020"

},

{

"status": "Active",

"namedInsured": "Joe Insured",

"effectiveDate": "02/06/2019",

"policyNumber": "P-2019-14",

"reviewState": "NOT_STARTED",

"flag": "white",

"policyType": "Personal Inland Marine",

"policyId": "8380c653-c11c-4a6c-a16d-b9552806d3c1",

"expirationDate": "02/06/2020"

}

]

},

"messages": [],

"success": true

}

Step 3: Retrieve your policy summary

Use retrieve_policy_terms to obtain the details of your policy. policy_number and policy_id are required.

Sample request

View code
curl --location --request POST '/api/v2/policies/retrieve_policy_terms' \

--header 'Content-Type: application/json' \
--header 'authorization: enter your access token here' \
--data-raw '{

"policy_number": "P-2020-10",

"policy_id": "5f140437-11f9-45c5-a11b-34321d4e3801"

}'

Sample response

View code
{

"data": [

{

"manual_reason": "",

"renewal_status_reason_id": "c105440e-981e-11de-8406-000c2976c0ee",

"revisions": [

{

"commission_rate_adjustment": 0.0000,

"commit_date_time": null,

"last_visited": null,

"create_date": "2020-06-12 13:56:22",

"date_updated": "2020-06-12 13:56:22",

"cancellation_revision_id": null,

"review_workflow_state": "NOT_STARTED",

"underwriting_questions": null,

"previous_revision_state": null,

"policy_type_id": "63e5c1f3-4488-4762-96c4-f8b54a2e4345",

"revision_state": "open",

"id": "8194ed51-12ec-49cc-aafd-d087cb3b0662",

"builder_pending": false,

"primary_property_id": "0e54d4d2-8708-4605-b772-aad0ed110a4f",

"annual_fee": 35.00,

"policy_status_reason_id": null,

"grant_mortgagee_extension": false,

"written_fee": 35.00,

"revision_date": "2020-06-12",

"annual_premium": 25.00,

"print_dec": true,

"review_workflow_request_reason": null,

"underwriting_options": null,

"description": null,

"credit_report_permissions": null,

"override_commission": false,

"written_premium": 25.00,

"policy_status": "Active",

"date_archived": null,

"cancel_date": null,

"written_premium_delta": 0.00,

"dec_description": null,

"commission_rate": 0.0000,

"commit_date": null,

"policy_term_id": "994ea736-bbb3-4eb9-8557-f99032cd88be",

"underwriting_contact_date": null,

"builder_ready_to_rate": false,

"reinstate_at_commit": false,

"underwriting_contacted": false,

"policy_id": "5f140437-11f9-45c5-a11b-34321d4e3801"

},

{

"commission_rate_adjustment": 0.0000,

"commit_date_time": "2020-06-12 13:52:53",

"last_visited": null,

"create_date": "2020-06-12 13:51:31",

"date_updated": "2020-06-12 13:56:22",

"cancellation_revision_id": null,

"review_workflow_state": "NOT_STARTED",

"underwriting_questions": null,

"previous_revision_state": null,

"policy_type_id": "63e5c1f3-4488-4762-96c4-f8b54a2e4345",

"revision_state": "pending",

"id": "b70e73fe-a07d-4902-b923-027bc807c8a0",

"builder_pending": false,

"primary_property_id": "7a227ea3-003b-4cf0-9ca5-1599a4c9e215",

"annual_fee": 35.00,

"policy_status_reason_id": null,

"grant_mortgagee_extension": false,

"written_fee": 35.00,

"revision_date": "2020-06-12",

"annual_premium": 25.00,

"print_dec": true,

"review_workflow_request_reason": null,

"underwriting_options": null,

"description": null,

"credit_report_permissions": null,

"override_commission": false,

"written_premium": 25.00,

"policy_status": "Active",

"date_archived": null,

"cancel_date": null,

"written_premium_delta": 0.00,

"dec_description": "Testing",

"commission_rate": 0.0000,

"commit_date": "2020-06-12",

"policy_term_id": "994ea736-bbb3-4eb9-8557-f99032cd88be",

"underwriting_contact_date": null,

"builder_ready_to_rate": false,

"reinstate_at_commit": false,

"underwriting_contacted": false,

"policy_id": "5f140437-11f9-45c5-a11b-34321d4e3801"

},

{

"commission_rate_adjustment": 0.0000,

"commit_date_time": null,

"last_visited": null,

"create_date": "2020-06-12 13:04:59",

"date_updated": "2020-06-12 13:51:31",

"cancellation_revision_id": null,

"review_workflow_state": "NOT_STARTED",

"underwriting_questions": null,

"previous_revision_state": null,

"policy_type_id": "63e5c1f3-4488-4762-96c4-f8b54a2e4345",

"revision_state": "archived",

"id": "d4a5afca-557f-4bed-846d-bdcedc23ba58",

"builder_pending": false,

"primary_property_id": "4afbd01b-ac1e-474e-9bea-68058aeb4248",

"annual_fee": null,

"policy_status_reason_id": null,

"grant_mortgagee_extension": false,

"written_fee": null,

"revision_date": "2020-06-12",

"annual_premium": 0.00,

"print_dec": true,

"review_workflow_request_reason": null,

"underwriting_options": null,

"description": null,

"credit_report_permissions": null,

"override_commission": false,

"written_premium": 0.00,

"policy_status": "Active",

"date_archived": "2020-06-12 13:51:31",

"cancel_date": null,

"written_premium_delta": 0.00,

"dec_description": null,

"commission_rate": 0.0000,

"commit_date": null,

"policy_term_id": "994ea736-bbb3-4eb9-8557-f99032cd88be",

"underwriting_contact_date": null,

"builder_ready_to_rate": false,

"reinstate_at_commit": false,

"underwriting_contacted": false,

"policy_id": "5f140437-11f9-45c5-a11b-34321d4e3801"

}

],

"term_length": 365,

"expiration_date": "2021-06-12",

"renewal_type": null,

"renewal_status": "Non-Renewal",

"effective_date": "2020-06-12",

"is_renewal": false,

"term_type": "1 Year",

"id": "994ea736-bbb3-4eb9-8557-f99032cd88be",

"renewal_status_description": "Credit score is low.",

"policy_id": "5f140437-11f9-45c5-a11b-34321d4e3801"

}

],

"messages": [],

"success": true

}

Step 4: Retrieve property and photos

The get_property_information_and_photos retrieves the property data. You need the property_id parameter from step 3.

Sample request

View code
curl --location --request POST '/api/v2/insured/get_property_information_and_photos' \

--header 'Content-Type: application/json' \

--headers 'authorization: enter your access token here' \

--data-raw '{

"api_key": "",

"property_id": "64b052d7-c9ff-49d7-a52b-7804b9708785"

}'

Sample response

View code
{

"data": {

"photos": {

"insured": [

{

"caption": null,

"id": "8a473faf-3560-4ee3-a99e-fa880e219f16",

"date_added": "2019-10-01 22:01:36"

},

{

"caption": null,

"id": "c1244766-773a-48cb-8297-e0622f6ab8e8",

"date_added": "2019-10-01 22:01:36"

}

],

"carrier": [],

"preferred": {

"caption": null,

"id": "8a473faf-3560-4ee3-a99e-fa880e219f16",

"date_added": "2019-10-01 22:01:36"

}

},

"property": {

"replace_loss": null,

"property_val": null,

"date_updated": "2019-10-01 11:58:14",

"inspection_requested_date": null,

"county_specify": "",

"address_state": "LA",

"protection_class_id": null,

"hydrant_distance": 1000,

"id": "64b052d7-c9ff-49d7-a52b-7804b9708785",

"address_line2": null,

"annual_fee": 0,

"address_line1": "306 E Miller Ave",

"replacement_cost_value": null,

"copy_address": false,

"iso_pc_data": null,

"address_country": "USA",

"written_fee": 0,

"risk_data": null,

"loss_history_report_content": null,

"annual_premium": 523,

"latitude": 30.245912,

"type": null,

"replace_contents": null,

"address_accuracy": "great",

"deleted": false,

"address_county": "55dd70fe-e778-43e3-9171-ed804cf65d8b",

"written_premium": 523,

"approved_limits": null,

"flag": "white",

"fire_district_distance": 0,

"loss_history_report_number": null,

"date_added": "2019-09-26 06:59:55",

"revision_id": "3a0940db-23a5-4f23-9ad9-63c15c36cd7a",

"inspection_vendor": null,

"address_zip": "70647",

"county": {

"specifications": [],

"code": "019",

"checked": true,

"name": "Calcasieu Parish",

"id": "55dd70fe-e778-43e3-9171-ed804cf65d8b"

},

"address_city": "Iowa",

"prefill_services_data": null,

"year_built": null,

"name": "Property 1",

"gross_area": null,

"date_added_micro": 145470,

"longitude": -93.010953,

"next_inspection_date": null,

"stories": null,

"builder_ready_to_rate": false,

"replace_other": null

}

},

"messages": [],

"success": true

}

Step 5: File a new claim

Use the new_claim_information endpoint to file a new claim. You will need to pass the following parameters:

View code
'{
"policy_id": "{{policy_id}}",
"property_id": "{{property_id}}"
}'

Sample request

View code
curl --location --request POST '/api/v2/insured/new_claim_information' \
--header 'Content-Type: application/json' \--headers 'authorization: enter your access token here' \--data-raw '{
"policy_id": "{{policy_id}}",
"property_id": "{{property_id}}"
}'

Sample response

View code
{

"data": {

"claim": {

"status": "Pending, Unsubmitted",

"lossAddressListed": true,

"claimNumber": "20-2019-102",

"lossAddressId": "e5dc3449-42e2-4adf-b23b-ae63f104b034",

"perils": [],

"items": [],

"additionalInformation": {},

"lossDate": null,

"policyId": "28bfb528-0145-4bf2-a360-f46a1c1ddfcd",

"id": "2f1cba17-5104-4006-b670-4701fb4dc83d",

"description": null

},

"perils": [

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "01",

"id": "42cd7ffd-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "ACCDL",

"name": "Accidental Discharge/Leakage"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "39",

"id": "42cd8dca-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "OTHER",

"name": "All Other"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "02",

"id": "42cd8196-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "APPL",

"name": "Appliance Related Water"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "03",

"id": "42cd82ff-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "BINONAUTO",

"name": "Bodily Injury Liability - Non-Auto"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "04",

"id": "42cd836a-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "BOILER",

"name": "Boiler and Machinery"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "26",

"id": "42cd89d8-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "GLASS",

"name": "Broken Window"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "06",

"id": "42cd83f5-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "CLPS",

"name": "Building Collapse"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "05",

"id": "42cd83b0-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "BOP",

"name": "Business Owners Policy"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "07",

"id": "42cd8445-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "COLL",

"name": "Collision, Upset"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "08",

"id": "42cd8487-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "COMPOPS",

"name": "Completed Operations Liability"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "09",

"id": "42cd84d1-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "CONTA",

"name": "Contamination"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "11",

"id": "42cd8554-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "CREDIT",

"name": "Credit Card"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "12",

"id": "42cd8594-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "DAMAG",

"name": "Damage to Property of Others"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "15",

"id": "42cd8658-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "DOG",

"name": "Dog Bite (Liability)"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "38",

"id": "42cd8d3d-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "MOVE",

"name": "Earth Movement"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "49",

"id": "42cd905f-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "QUAKE",

"name": "Earthquake"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "16",

"id": "42cd8696-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "EMPLOYEE",

"name": "Employee Dishonesty"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "18",

"id": "42cd871a-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "EPLY",

"name": "Employment Practice Liability"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "17",

"id": "42cd86d8-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "EO",

"name": "Errors and Omissions"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "19",

"id": "42cd8757-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "EXPL",

"name": "Explosion"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "20",

"id": "42cd8795-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "EXTEN",

"name": "Extended Coverage Perils"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "21",

"id": "42cd87da-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "FIRE",

"name": "Fire"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "22",

"id": "42cd881f-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "FIREELL",

"name": "Fire Legal Liability"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "23",

"id": "42cd885e-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "FLOOD",

"name": "Flood"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "24",

"id": "42cd88a3-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "FOROB",

"name": "Foreign Object Intake"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "25",

"id": "42cd8910-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "FREEZE",

"name": "Freezing Water (including bursting pipes)"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "27",

"id": "42cd8a29-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "HAIL",

"name": "Hail"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "28",

"id": "42cd8a68-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "ICE",

"name": "Ice Damage"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "29",

"id": "42cd8adb-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "ID",

"name": "Identification Theft"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "30",

"id": "42cd8b22-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "LIABILITY",

"name": "Liability (all others)"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "31",

"id": "42cd8b60-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "LIGHT",

"name": "Lightning"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "33",

"id": "42cd8be6-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "LLL",

"name": "Liquor Law Liability"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "32",

"id": "42cd8ba8-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "LIVES",

"name": "Livestock"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "34",

"id": "42cd8c25-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "MEDICAL",

"name": "Medical Payments"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "35",

"id": "42cd8c70-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "MINE",

"name": "Mine Subsidence"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "36",

"id": "42cd8cb6-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "MOLD",

"name": "Mold"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "37",

"id": "42cd8cfd-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "MOLDL",

"name": "Mold Liability"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "13",

"id": "42cd85d6-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "DISAP",

"name": "Mysterious Disappearance"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "14",

"id": "42cd8614-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "DISSC",

"name": "Mysterious Disappearance Scheduled Property"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "43",

"id": "42cd8ee2-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "PINONAUTO",

"name": "Personal Injury - Non-Aut"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "42",

"id": "42cd8ea3-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "PHYDA",

"name": "Physical Damage"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "46",

"id": "42cd8fa4-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "PLIAB",

"name": "Pollution Liability"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "48",

"id": "42cd9027-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "POLLUTION",

"name": "Pollution Remediation"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "45",

"id": "42cd8f64-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "PLBI",

"name": "Premises Liability Bodily Injury"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "47",

"id": "42cd8fe6-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "PLPD",

"name": "Premises Liability Property Damage"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "41",

"id": "42cd8e58-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "PCOPD",

"name": "Produced and Completed Operations Property Damage"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "44",

"id": "42cd8f25-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "PL",

"name": "Product Liability"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "40",

"id": "42cd8e18-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "PCOBI",

"name": "Products and Completed Operations Bodily Injury"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "50",

"id": "42cd90a5-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "RIOT",

"name": "Riot or Civil Commotion"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "51",

"id": "42cd90e5-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "ROBBERY",

"name": "Robbery"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "52",

"id": "42cd9128-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "SINK",

"name": "Sinkhole"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "53",

"id": "42cd9165-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "SLIP",

"name": "Slip or Fall (liability)"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "54",

"id": "42cd91a8-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "SMOKE",

"name": "Smoke"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "55",

"id": "42cd91e3-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "SPOIL",

"name": "Spoilage"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "56",

"id": "42cd921b-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "SPRLE",

"name": "Sprinkler Leakage"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "57",

"id": "42cd925c-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "THEFT",

"name": "Theft or Burglary"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "58",

"id": "42cd92a0-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "THFSC",

"name": "Theft Scheduled Property"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "59",

"id": "42cd92d8-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "VMM",

"name": "Vandalism or Malicious Mischief"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "60",

"id": "42cd9322-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "VOLCANO",

"name": "Volcano"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "61",

"id": "42cd9361-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "WATER",

"name": "Water Damage"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "10",

"id": "42cd8510-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "CRAFT",

"name": "Watercraft"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "65",

"id": "42cd945f-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "WEATHER",

"name": "Weather Related"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "67",

"id": "42cd94d6-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "WSNOW",

"name": "Weight of Ice or Snow"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "66",

"id": "42cd9499-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "WIND",

"name": "Wind"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "62",

"id": "42cd939d-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "WC",

"name": "Workers Compensation"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "63",

"id": "42cd93e1-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "WCDEM",

"name": "Workers Compensation Indemnity"

},

{

"dateUpdated": "2019-07-08 15:02:06",

"code": "64",

"id": "42cd941c-a1bb-11e9-b3ca-121d960b34c0",

"aplusCode": "WCMED",

"name": "Workers Compensation Medical"

}

]

},

"messages": [],

"success": true

}

Step 6: Update the claim

The update_claim endpoint updates an existing claim. Pass a JSON object with the update details:

View code
{
"claim_id": "{{claim_id}}",
"loss_date": "2019-10-31",
"description": "The front fell off",
"additional_information": {
"Insured Contact Number": "+1 (650) 321-1234",
"arbitrary id": "0fe6a7bf-bca7-4757-825c-7cc9bf90cfc0"
}
}

Sample request

View code
curl --location --request POST '/api/v2/insured/update_claim' \

--header 'Content-Type: application/json' \

--header 'Authorization: \

--data-raw '{

"claim_id": "cd7bea1e-1ee2-4d50-9d2a-22cf84c50f84"

"loss_date": "2019-10-31",

"description": "The front fell off",

"additional_information": {

"Insured Contact Number": "+1 (650) 321-1234",

"arbitrary id": "0fe6a7bf-bca7-4757-825c-7cc9bf90cfc0"

}

}'

Sample response

View code
{

"data": [],

"messages": [],

"success": true

}

Step 7: Upload a claim photo

The upload_property_or_claim_photo endpoint uploads a claim/property user’s photo. Required parameters include:

View code
{
file_type : str, requiredeither one of 'properties' or 'claims'reference_id : str, requiredreference id pointing to claim or property id related to filephoto_as_base64 : basestring, requiredphoto as a data URI string -- ex: 'data:image/filename : str, requiredoriginal filename of uploaded file (include the extension, e.g. picture.jpg)mimetype : strmimetype of uploaded file

Sample request

View code
curl --location --request POST '/api/v2/insured/upload_property_or_claim_photo' \

--header 'Authorization: \

--header 'Content-Type: application/json' \

--header 'Cookie: webpy_session_id=75766d9e6a55941d61bd34b11df590cb1d8859ca' \

--data-raw '{

"file_type": "claims",

"photo_as_base64": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAASABIAAD/4QBARXhpZgAATU0AKgAAAAgAAYdpAAQAAAABAAAAGgAAAAAAAqACAAQAAAABAAAAqaADAAQAAAABAAAALwAAAAD/7QA4UGhvdG9zaG9wIDMuMAA4QklNBAQAAAAAAAA4QklNBCUAAAAAABDUHYzZjwCyBOmACZjs+EJ+/+IMWElDQ19QUk9GSUxFAAEBAAAMSExpbm8CEAAAbW50clJHQiBYWVogB84AAgAJAAYAMQAAYWNzcE1TRlQAAAAASUVDIHNSR0IAAAAAAAAAAAAAAAAAAPbWAAEAAAAA0y1IUCAgAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAARY3BydAAAAVAAAAAzZGVzYwAAAYQAAABsd3RwdAAAAfAAAAAUYmtwdAAAAgQAAAAUclhZWgAAAhgAAAAUZ1hZWgAAAiwAAAAUYlhZWgAAAkAAAAAUZG1uZAAAAlQAAABwZG1kZAAAAsQAAACIdnVlZAAAA0wAAACGdmlldwAAA9QAAAAkbHVtaQAAA/gAAAAUbWVhcwAABAwAAAAkdGVjaAAABDAAAAAMclRSQwAABDwAAAgMZ1RSQwAABDwAAAgMYlRSQwAABDwAAAgMdGV4dAAAAABDb3B5cmlnaHQgKGMpIDE5OTggSGV3bGV0dC1QYWNrYXJkIENvbXBhbnkAAGRlc2MAAAAAAAAAEnNSR0IgSUVDNjE5NjYtMi4xAAAAAAAAAAAAAAASc1JHQiBJRUM2MTk2Ni0yLjEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAFhZWiAAAAAAAADzUQABAAAAARbMWFlaIAAAAAAAAAAAAAAAAAAAAABYWVogAAAAAAAAb6IAADj1AAADkFhZWiAAAAAAAABimQAAt4UAABjaWFlaIAAAAAAAACSgAAAPhAAAts9kZXNjAAAAAAAAABZJRUMgaHR0cDovL3d3dy5pZWMuY2gAAAAAAAAAAAAAABZJRUMgaHR0cDovL3d3dy5pZWMuY2gAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZGVzYwAAAAAAAAAuSUVDIDYxOTY2LTIuMSBEZWZhdWx0IFJHQiBjb2xvdXIgc3BhY2UgLSBzUkdCAAAAAAAAAAAAAAAuSUVDIDYxOTY2LTIuMSBEZWZhdWx0IFJHQiBjb2xvdXIgc3BhY2UgLSBzUkdCAAAAAAAAAAAAAAAAAAAAAAAAAAAAAGRlc2MAAAAAAAAALFJlZmVyZW5jZSBWaWV3aW5nIENvbmRpdGlvbiBpbiBJRUM2MTk2Ni0yLjEAAAAAAAAAAAAAACxSZWZlcmVuY2UgVmlld2luZyBDb25kaXRpb24gaW4gSUVDNjE5NjYtMi4xAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAB2aWV3AAAAAAATpP4AFF8uABDPFAAD7cwABBMLAANcngAAAAFYWVogAAAAAABMCVYAUAAAAFcf521lYXMAAAAAAAAAAQAAAAAAAAAAAAAAAAAAAAAAAAKPAAAAAnNpZyAAAAAAQ1JUIGN1cnYAAAAAAAAEAAAAAAUACgAPABQAGQAeACMAKAAtADIANwA7AEAARQBKAE8AVABZAF4AYwBoAG0AcgB3AHwAgQCGAIsAkACVAJoAnwCkAKkArgCyALcAvADBAMYAywDQANUA2wDgAOUA6wDwAPYA+wEBAQcBDQETARkBHwElASsBMgE4AT4BRQFMAVIBWQFgAWcBbgF1AXwBgwGLAZIBmgGhAakBsQG5AcEByQHRAdkB4QHpAfIB+gIDAgwCFAIdAiYCLwI4AkECSwJUAl0CZwJxAnoChAKOApgCogKsArYCwQLLAtUC4ALrAvUDAAMLAxYDIQMtAzgDQwNPA1oDZgNyA34DigOWA6IDrgO6A8cD0wPgA+wD+QQGBBMEIAQtBDsESARVBGMEcQR+BIwEmgSoBLYExATTBOEE8AT+BQ0FHAUrBToFSQVYBWcFdwWGBZYFpgW1BcUF1QXlBfYGBgYWBicGNwZIBlkGagZ7BowGnQavBsAG0QbjBvUHBwcZBysHPQdPB2EHdAeGB5kHrAe/B9IH5Qf4CAsIHwgyCEYIWghuCIIIlgiqCL4I0gjnCPsJEAklCToJTwlkCXkJjwmkCboJzwnlCfsKEQonCj0KVApqCoEKmAquCsUK3ArzCwsLIgs5C1ELaQuAC5gLsAvIC+EL+QwSDCoMQwxcDHUMjgynDMAM2QzzDQ0NJg1ADVoNdA2ODakNww3eDfgOEw4uDkkOZA5/DpsOtg7SDu4PCQ8lD0EPXg96D5YPsw/PD+wQCRAmEEMQYRB+EJsQuRDXEPURExExEU8RbRGMEaoRyRHoEgcSJhJFEmQShBKjEsMS4xMDEyMTQxNjE4MTpBPFE+UUBhQnFEkUahSLFK0UzhTwFRIVNBVWFXgVmxW9FeAWAxYmFkkWbBaPFrIW1hb6Fx0XQRdlF4kXrhfSF/cYGxhAGGUYihivGNUY+hkgGUUZaxmRGbcZ3RoEGioaURp3Gp4axRrsGxQbOxtjG4obshvaHAIcKhxSHHscoxzMHPUdHh1HHXAdmR3DHeweFh5AHmoelB6+HukfEx8+H2kflB+/H+ogFSBBIGwgmCDEIPAhHCFIIXUhoSHOIfsiJyJVIoIiryLdIwojOCNmI5QjwiPwJB8kTSR8JKsk2iUJJTglaCWXJccl9yYnJlcmhya3JugnGCdJJ3onqyfcKA0oPyhxKKIo1CkGKTgpaymdKdAqAio1KmgqmyrPKwIrNitpK50r0SwFLDksbiyiLNctDC1BLXYtqy3hLhYuTC6CLrcu7i8kL1ovkS/HL/4wNTBsMKQw2zESMUoxgjG6MfIyKjJjMpsy1DMNM0YzfzO4M/E0KzRlNJ402DUTNU01hzXCNf02NzZyNq426TckN2A3nDfXOBQ4UDiMOMg5BTlCOX85vDn5OjY6dDqyOu87LTtrO6o76DwnPGU8pDzjPSI9YT2hPeA+ID5gPqA+4D8hP2E/oj/iQCNAZECmQOdBKUFqQaxB7kIwQnJCtUL3QzpDfUPARANER0SKRM5FEkVVRZpF3kYiRmdGq0bwRzVHe0fASAVIS0iRSNdJHUljSalJ8Eo3Sn1KxEsMS1NLmkviTCpMcky6TQJNSk2TTdxOJU5uTrdPAE9JT5NP3VAnUHFQu1EGUVBRm1HmUjFSfFLHUxNTX1OqU/ZUQlSPVNtVKFV1VcJWD1ZcVqlW91dEV5JX4FgvWH1Yy1kaWWlZuFoHWlZaplr1W0VblVvlXDVchlzWXSddeF3JXhpebF69Xw9fYV+zYAVgV2CqYPxhT2GiYfViSWKcYvBjQ2OXY+tkQGSUZOllPWWSZedmPWaSZuhnPWeTZ+loP2iWaOxpQ2maafFqSGqfavdrT2una/9sV2yvbQhtYG25bhJua27Ebx5veG/RcCtwhnDgcTpxlXHwcktypnMBc11zuHQUdHB0zHUodYV14XY+dpt2+HdWd7N4EXhueMx5KnmJeed6RnqlewR7Y3vCfCF8gXzhfUF9oX4BfmJ+wn8jf4R/5YBHgKiBCoFrgc2CMIKSgvSDV4O6hB2EgITjhUeFq4YOhnKG14c7h5+IBIhpiM6JM4mZif6KZIrKizCLlov8jGOMyo0xjZiN/45mjs6PNo+ekAaQbpDWkT+RqJIRknqS45NNk7aUIJSKlPSVX5XJljSWn5cKl3WX4JhMmLiZJJmQmfyaaJrVm0Kbr5wcnImc951kndKeQJ6unx2fi5/6oGmg2KFHobaiJqKWowajdqPmpFakx6U4pammGqaLpv2nbqfgqFKoxKk3qamqHKqPqwKrdavprFys0K1ErbiuLa6hrxavi7AAsHWw6rFgsdayS7LCszizrrQltJy1E7WKtgG2ebbwt2i34LhZuNG5SrnCuju6tbsuu6e8IbybvRW9j74KvoS+/796v/XAcMDswWfB48JfwtvDWMPUxFHEzsVLxcjGRsbDx0HHv8g9yLzJOsm5yjjKt8s2y7bMNcy1zTXNtc42zrbPN8+40DnQutE80b7SP9LB00TTxtRJ1MvVTtXR1lXW2Ndc1+DYZNjo2WzZ8dp22vvbgNwF3IrdEN2W3hzeot8p36/gNuC94UThzOJT4tvjY+Pr5HPk/OWE5g3mlucf56noMui86Ubp0Opb6uXrcOv77IbtEe2c7ijutO9A78zwWPDl8XLx//KM8xnzp/Q09ML1UPXe9m32+/eK+Bn4qPk4+cf6V/rn+3f8B/yY/Sn9uv5L/tz/bf///8AAEQgALwCpAwEiAAIRAQMRAf/EAB8AAAEFAQEBAQEBAAAAAAAAAAABAgMEBQYHCAkKC//EALUQAAIBAwMCBAMFBQQEAAABfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeoqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2drh4uPk5ebn6Onq8fLz9PX29/j5+v/EAB8BAAMBAQEBAQEBAQEAAAAAAAABAgMEBQYHCAkKC//EALURAAIBAgQEAwQHBQQEAAECdwABAgMRBAUhMQYSQVEHYXETIjKBCBRCkaGxwQkjM1LwFWJy0QoWJDThJfEXGBkaJicoKSo1Njc4OTpDREVGR0hJSlNUVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoKDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uLj5OXm5+jp6vLz9PX29/j5+v/bAEMAAQEBAQEBAgEBAgMCAgIDBAMDAwMEBQQEBAQEBQYFBQUFBQUGBgYGBgYGBgcHBwcHBwgICAgICQkJCQkJCQkJCf/bAEMBAQEBAgICBAICBAkGBQYJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCQkJCf/dAAQAC//aAAwDAQACEQMRAD8A/mvooqWCCa5mW3tkaSRzhVUEkk9gByTX7Skfxs2krsior37wj+zJ8YvGl5aafpWmiO4vpEhgimkVJJJJGCooXkgsSAMgVl+I/wBnz4qeGUkkudPFysRIf7M4kZSvX5RhuPYV6z4fx3Lz+ylb0Z8iuP8AI3V9isXT5r2+OO/a97X8jxWinMrIxRwVYHBB4INNryD69MKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigD//Q/mvr9Ev2WPhB9os9N1Oxtftuva/KkFlGAC485xHEkY7NIxHPuBX521+3P7B/7ZnxW+DfhnQNS+GmreQdAnhFzZNHEySCFw2xi6MwWVRjKkEZOCCK/p7gWnfFSlCKlNRbim7K/wBzP8yPHnEOOU06dapKnQlNKpKEVJqOulnKOje+vZWdz9vP2QP2bPgn4A/a68IfBdfCeq/EXxbpGprNrviHzZ7XQdHurEGaSO1SGMG6MEkYjMs8ixvJwqEV5f8AG79lb4VfEj42+Mfgp4J8Hat8N/H+n39//YqzSz3eh+IBCzyLFFJOgktbieIboMSSQu3yfLkV+p/7N37Yv7S/xk/aN0HXvhj4o0jxt8J/EN0xvdMkWytde0AToxEFzADDLItvKQqzxrKkkYyTuNcV8Zv27/2nfgb8YfFXjj43eJNH8O+DNHvLxPDvhK0Wzuda1vyy0dp520zSWtux2yzTSNG235Y1yRjmhnGbf2g3G3tORae0lfmu9OXltfo48qSWvMviPRr8HcJf6vRjUTWG9tJc31enZU+SPvKr7Ru1rNVfaynKfuezlbkP4oP2mfhtp50tvHmmxCC8t5FjvFAxvVjtDMP76tgE9weelfD9frd+3P8AtRfE34p+C5dO+KGttql7qsylIzHDHtVHDs2IkT5QQAM+tfkjWvHVKMcddJKTSckndX+5dLdDm8CMVVqZEk5ynTjKSpynHlbgrdFKWid0vee1uh33wo8A3XxW+KXhr4XWNylnP4l1Wz0qO4kUskT3k6QK7KOSql8kDkgV+o37Uf8AwSM1f4AfDT4i/EbwD8U9A+ID/CPU7PSfF+l2dpe2N5p1xfyiGDb9pTyrgF2APlOeMkZwRX5x/s3+LtA8AftEeAfHniyf7NpWieI9Kv7yYKz+Xb213FLK+1AWbaik4UEnoATX9Lf7eX/BSf8AZD+Lvwh+M/hXU/i3J8WrXxxqdjf+B/D1v4Zn0oeGrm3mDG5n1CaKB7jbHkYIctjbj5jj85xtatGrFU1p10815dvNH9H5Ng8HUwtWWIaUltd2+y3tdX1t0fay3X4GfBP9iH4q/Eb4hDwb8UrPVfh1YG3vHGqaroepTRG4tLf7T9mEcEJkMjx/NkDCL8zYXmqfxh/YS/aP+B3wB8C/tK+OtEkTwv8AEC3muLKWKKcvarHKsUYvQ0SrA1wWDW4LHzV5Wv3X8Xf8FafhH4z/AOCu+s/GjxD8SdSvfgnYeFr7T/D6Sw3xtLe9u9ES2cxWHleYkkl0ZFeUxAnOS2zBrybwT/wUD+Aus/sl/szar8T/AIm6jNrHwH1jzPEfgG8t7+6PiSGPU4Z7OSObJs2+x2yloRcHCMgjG0YJxWLxF4ycdHbv1T8vS/Y7XlOXcs4Rq6pySd10cVfezVm2rauz3eh+HkP7Kn7SbeO/Cnw11HwNrema144uIbXQrfUbGezN/JcOqIYWnRAy5YFmBIUcnAr9CPjP/wAEqvhz8G/C/i3R739ozwHe/ErwJZS3uteEg1xAyGAL5trb30gEU92jNs8lUDF/lO2v03/am/4Ky/Avwjr/AIP+I/wa8VaH8RINO+Jdt43XSorLxGmq21ssc0Vx5l3rV1Pa28rwy+SYLVFiLYdQoUCvz4/aw8A/8Eh/iBqHxE/ah8D/ABt8SX+qeMDfaro3guLQJIr6z1e+Zpgl5ezt9na1jlchihD7T8ruV+Yhi603FyTivJX+/TT+tQq5TgqUZqnKNRrvJKyturPV36a+nU/JWT4KfGWH4bL8ZZvCWtJ4Qd/LGttYXA04tnbj7Vs8nOePvdeOtWdT+A/xx0XR4/EOseDNdtNPme1jjuZtOuUhd70ZtVR2jCs045iAOXH3c1/St4g/4KY/sn3vw51X4u2/xQ1iXStS+FH/AAgcXwPOm3IsINVNoLX7R55P2H7MjjzRMB52Dj/Yrz3Xf+Cu/wALtG/be/Zy8Wy+KNU8TfB74ceEdFs9X0iKO5S2tdcisbi0mvRZzLGJ7i0eVHWUBjhcRNmrjja7v+779/u2/wCAYTyPAxtevvZdHu7X0e3W2662ufzr/Ef4R/Fb4OaxD4e+LnhnVfC1/cQrcRW2r2c9lLJE3SREnRGZT/eAxXntfub/AMFY/wBrX4RfG74UeBvhR8L/ABnoPjmLRNY1PVVudMs/ESXVnFeqv7uW78QXVxI/nN87wR4SN0BBwa/DKu/C1ZTgpSVmeFmuEp0K7p0pcy01+XkFFFFdB5wUUUUAFFFFAH//0f5r66fwl4x8Q+CNWGs+HLgwS42sOqOv911PBH8u1cxRX7bRrTpyU6bs11R/F2MwdHEUpUK8VKMtGmrprzR+gHwl/bnv/hv420P4gvpBGp6DfW9/A9vIApktpFlXhhkAleeTxXK+Mv2wbvWby71LQ9K23V5K8zzXUm755GLE7Vxk5Pdq+KaK+lfGuZW/ia2teyvb1sfmK8EuGrr/AGf3U3JR5pct3ZN25vJabeRueI/Eut+LNWk1vxBcNc3MvVm6ADoqgcADsBWHRRXzFSrKcnObu2fqOGw1OjTjSpRUYpWSWiS7JBRRRUGwUUUUAFFFFABRRRQAUUUUAFFFFABRRRQAUUUUAf/Z",

"mimetype": "image/jpeg",

"reference_id": "e4111288-c65a-46ca-afda-4528fdac63c0",

"filename": "britecore.jpg"

}

Sample response

View code
{

"data": {

"file_id": "e92723c0-1ba7-4705-bbd7-bba80d9d138d"

},

"messages": [

"Photo uploaded"

],

"success": true

}

Step 8: Submit a claim

The submit_claim endpoint submits the claim that was just updated. Pass the claim_id.

Sample request

View code
curl --location --request POST '/api/v2/insured/submit_claim' \

--header 'Content-Type: application/json' \

--header 'Authorization: \

--data-raw '{

"claim_id": "cd7bea1e-1ee2-4d50-9d2a-22cf84c50f84"

}'

Sample response

View code
{

"data": [],

"messages": [],

"success": true

}

Step 9: Retrieve claim details

Use get_claim to retrieve claim details. Pass the claim_id.

Sample request

View code
curl --location --request POST '/api/v2/claims/get_claim' \

--header 'Content-Type: application/json' \

--header 'Cookie: webpy_session_id=f17d0b72981027cda0fdfceea468ccf812a5d4a8' \

--header 'Authorization: \

--data-raw '{

"api_key": "931a9a97-f825-4e51-81d2-ba26d2f9426c",

"claim_id": "cd7bea1e-1ee2-4d50-9d2a-22cf84c50f84"

}'

Sample response

View code
{

"data": {

"claim": {

"date_updated": "2020-11-18 08:16:58",

"cat_id": null,

"loss_address_line1": null,

"additional_information": {},

"loss_address_line2": null,

"county": null,

"loss_address_listed": true,

"loss_address_state": null,

"subrogation_reserve": 0.00,

"id": "cd7bea1e-1ee2-4d50-9d2a-22cf84c50f84",

"loss_date": "2020-10-13 12:35:00",

"iso_transaction_type": "individual",

"adjusters": [],

"claim_number_origin": "v1",

"policy": {

"in_progress_oos_transaction_id": null,

"submit_bound": false,

"copied_to_rev_id": null,

"date_updated": "2020-09-11 09:10:59",

"inception_date": "2020-02-21",

"policy_group_id": null,

"submit_receipt_email": "",

"id": "6bbc5699-2f11-404f-8450-d03fbd9b2da7",

"rewritten": false,

"policy_number": "P-2020-3",

"submit_confirm_name": "Jane Testagent",

"show_app": true,

"do_not_automatically_rewrite": false,

"system_tags": null,

"flag": "white",

"unbound_option_id": null,

"active": true,

"date_added": "2020-02-21 12:32:52",

"policy_number_origin": "v2",

"submit_confirm_email": "Jane.testagent@pbwyo.com",

"sequence_id": "68b4b23f-6025-11e7-b385-1208baa8836b",

"account_number": null,

"submit_receipt_name": "",

"policy_number_normalized": "P20203",

"copied_from_rev_id": null

},

"type": "property",

"reinsurancelae_reserve": 0.00,

"status": "Pending, Submitted",

"description": "test description",

"perils": [

{

"date_updated": "2018-11-16 13:16:06",

"code": "26",

"id": "10de2be5-e9d4-11e8-a4be-0e509f7061a6",

"name": "Broken Window",

"aplus_code": "GLASS"

},

{

"date_updated": "2018-11-16 13:16:06",

"code": "38",

"id": "10de2cfe-e9d4-11e8-a4be-0e509f7061a6",

"name": "Earth Movement",

"aplus_code": "MOVE"

}

],

"loss_address": {

"addressState": "MA",

"countySpecification": "",

"addressCounty": "0c320e26-047d-4fcb-a9da-3d07619ec2f4",

"addressLine2": "300",

"addressLine1": "321 Main St",

"addressCity": "Watertown",

"addressZip": "02134"

},

"system_tags": null,

"type_manual": false,

"loss_address_city": null,

"photos": {

"insured": [],

"carrier": [],

"preferred": null

},

"flag": "white",

"last_modified": "2020-11-18",

"active": true,

"date_added": "2020-10-20 07:51:38",

"reinsurance_reserve": 0.00,

"dual_masthead": false,

"coverages": [],

"county_specify": null,

"last_rein_report_date": null,

"reinsurance_monitor_status": "system-off",

"salvage_reserve": 0.00,

"claim_number": "C-2020-63",

"loss_address_zip": null,

"loss_address_id": "6298520b-47d8-4914-b9ab-554b46ac97d8",

"policy_id": "6bbc5699-2f11-404f-8450-d03fbd9b2da7"

},

"claim_id": "cd7bea1e-1ee2-4d50-9d2a-22cf84c50f84"

},

"messages": [],

"success": true

}

Step 10: Retrieve claims attachments

The get_attachment_file_list endpoint retrieves related documents list. Pass a JSON object with the following details:

View code
{

"reference_id": "3e238c05-221b-4d03-a068-401d0e082b2a",

"reference_type": "claims",

"order_by": "date_added",

"ascending": true,

"page": 1

}

Sample request

View code
curl --location --request POST '/api/v2/attachments/get_attachments_file_list' \

--header 'Content-Type: application/json' \

--data-raw '{

"api_key": "",

"reference_id": "3e238c05-221b-4d03-a068-401d0e082b2a",

"reference_type": "claims",

"order_by": "date_added",

"ascending": true,

"page": 1

}'

Sample response

View code
{

"data": {

"folders": [],

"records": [

{

"isdir": true,

"actualPrintDate": null,

"printState": "Do Not Print",

"folderId": null,

"emailed": false,

"uploadingToS3": false,

"emailOnly": false,

"url": "/gateway?file=core.uploads&method=getAttachment&id=d88620d7-3563-423c-ad64-624165e13b02",

"title": "Claim Acknowledgment Letter",

"mimeType": null,

"printDateFmt": null,

"folderName": null,

"readOnly": true,

"private": false,

"dateAddedFmt": "10/01/2019 08:25 PM",

"itemCount": 1,

"id": "d88620d7-3563-423c-ad64-624165e13b02",

"size": "4.0 KB"

},

{

"isdir": true,

"actualPrintDate": null,

"printState": "Do Not Print",

"folderId": null,

"emailed": false,

"uploadingToS3": false,

"emailOnly": false,

"url": "/gateway?file=core.uploads&method=getAttachment&id=3997887d-9fda-4186-9498-d632f950d9fc",

"title": "Loss Notice",

"mimeType": null,

"printDateFmt": null,

"folderName": null,

"readOnly": true,

"private": false,

"dateAddedFmt": "10/01/2019 09:38 PM",

"itemCount": 1,

"id": "3997887d-9fda-4186-9498-d632f950d9fc",

"size": "4.0 KB"

}

],

"activePage": 1,

"maxPages": 1,

"folderName": null

},

"messages": [],

"success": true

}

Step 11: Retrieve a specific document

Use the get_attachment endpoint to retrieve a specific deliverable.

Note: The endpoint returns a Base64 encoded payload of your PDF. You need the file_id for the attachment.

Sample request

View code
curl --location --request POST '/api/v2/deliverables/get_attachment' \

--header 'Content-Type: application/json' \

--header 'Authorization: \

--data-raw '{

"file_id": "92da6b2f-b0ad-464a-bc5b-d7a9add40a36"

}'

Sample response

View code
{

"data": {

"content": "JVBERi0xLjMKJeLjz9MKMSAwIG9iago8PC9BdXRob3IgPD4gL0NyZWF0aW9uRGF0ZSAoRDoyMDIw\nMDUyNzIzMjUwNS0wNScwMCkgL0tleXdvcmRzIDw+CiAgL1Byb2R1Y2VyIChXZWFzeVByaW50IDAu\nNDEgXChodHRwOi8vd2Vhc3lwcmludC5vcmcvXCkpIC9UaXRsZQogIChJbnN1cmVkIExldHRlcik+\nPgplbmRvYmoKMiAwIG9iago8PC9QYWdlcyAzIDAgUiAvVHlwZSAvQ2F0YWxvZz4+CmVuZG9iagoz\nIDAgb2JqCjw8L0NvdW50IDEgL0tpZHMgWzQgMCBSXSAvVHlwZSAvUGFnZXM+PgplbmRvYmoKNCAw\nIG9iago8PC9Bbm5vdHMKICBbPDwvQSA8PC9TIC9VUkkgL1R5cGUgL0FjdGlvbiAvVVJJIChodHRw\nOi8vd3d3LmJyaXRlY29yZS5jb20pPj4gL0JvcmRlcgogIFswIDAgMF0gL1JlY3QgWzQ3My4yMzI0\nMjE4NzUgNjQyLjM2Njc5Njg3NSA1NDkuNzUgNjI5Ljc2Njc5Njg3NV0KICAvU3VidHlwZSAvTGlu\nayAvVHlwZSAvQW5ub3Q+Pl0KICAvQmxlZWRCb3ggWzAgMCA2MTIgNzkyXSAvQ29udGVudHMgNSAw\nIFIgL0dyb3VwCiAgPDwvQ1MgL0RldmljZVJHQiAvSSB0cnVlIC9TIC9UcmFuc3BhcmVuY3kgL1R5\ncGUgL0dyb3VwPj4gL01lZGlhQm94CiAgWzAgMCA2MTIgNzkyXSAvUGFyZW50IDMgMCBSIC9SZXNv\ndXJjZXMgNiAwIFIgL1RyaW1Cb3ggWzAgMCA2MTIgNzkyXQogIC9UeXBlIC9QYWdlPj4KZW5kb2Jq\nCjUgMCBvYmoKPDwvRmlsdGVyIC9GbGF0ZURlY29kZSAvTGVuZ3RoIDI5IDAgUj4+CnN0cmVhbQp4\nnI1T207bQBB936+Yt0KF17O73ltVVWooqkBCDUmkPpQ+GMcJoYlNHKPQv++s17kIqESirHYmc85c\nzqwApG8i6LBeQrFia7aGdJi3bdlUUGwgfTSwKSpIc4T5hoVwI2QX3ZQwYzfsBtbMSC41xFNY5Jm1\nkBnuUISon1ARb+833sWk4f8dBD1HHdLHNJA+W/hW9+TYxTfzXQ2DCaMKYuESpJLcSqON7GnQOgET\nopolmCDQfcZO4HTywHwEeSpNESaAQEjkOjPO6h4j9phBs2jL85oauKw2T01eFWVgOeZNBKdsxmVU\nCs8Qhc1gMmUnUlE74/qpvYfBMi/+rPIKRtOAFlx5FF70AIOuA4wfm0U1ny3K5fQMrn+A0Q59iL+Y\nxP65V+ETxkD9HzqxikuVKSpfaMeV9mrfyaH77XbL70I3BXXDi3r1FvPoO901bMl7Rb8H9us3ORCm\nTCBcwxpElzSeJFWfmvJ6rkmIFejM866Q6FjCGG4O6h2XvY/8b8mdYAK58N6i7dXem/3aOOTWv6nd\n1VNVAqozkCjxpWpEJblAlFlUa1DffdjAZVHCeVPmKxjf14+f75r0i5AKrvNFBeO2Kcu28w3qTVtX\nJNJXQCkieUeI3jsjOsLRxScY1stF8ReGSaggoaW/PUGdSpsGG9oa9pa4Pe31CNuuTWhNizAfjZIU\nwXDtn9HLtxCjlaUwmj+N0/bWcmdFJjKPeJdw/x6k5EfAaLzAzT6+44XSOhAis9wZK5x7pdUwn5d0\nrWcgXr0vDNCEGOKS0Gz3A93NjP0DC3sQVgplbmRzdHJlYW0KZW5kb2JqCjYgMCBvYmoKPDwvRXh0\nR1N0YXRlIDw8L2EwIDw8L0NBIDEgL2NhIDE+Pj4+IC9Gb250IDw8L2YtMC0wIDcgMCBSIC9mLTEt\nMCA4IDAgUj4+CiAgL1BhdHRlcm4gPDwvcDYgOSAwIFI+PiAvWE9iamVjdCA8PC94NyAxMCAwIFI+\nPj4+CmVuZG9iago3IDAgb2JqCjw8L0Jhc2VGb250IC9JVUlJWFIrSGVsdmV0aWNhIC9FbmNvZGlu\nZyAvV2luQW5zaUVuY29kaW5nIC9GaXJzdENoYXIgMzIKICAvRm9udERlc2NyaXB0b3IgMjQgMCBS\nIC9MYXN0Q2hhciAxMjEgL1N1YnR5cGUgL1RydWVUeXBlIC9Ub1VuaWNvZGUKICAyNSAwIFIgL1R5\ncGUgL0ZvbnQgL1dpZHRocwogIFsyNzcgMCAwIDAgMCAwIDAgMTkwIDMzMyAzMzMgMCAwIDI3NyAz\nMzMgMjc3IDI3NyA1NTYgNTU2IDU1NiA1NTYgMCA1NTYKICA1NTYgNTU2IDU1NiA1NTYgMjc3IDAg\nNTgzIDAgNTgzIDAgMCA2NjYgNjY2IDcyMiAwIDY2NiAwIDAgMCAyNzcgMCAwIDAKICA4MzMgMCA3\nNzcgNjY2IDAgNzIyIDY2NiAwIDAgMCAwIDAgMCAwIDAgMCAwIDAgMCAwIDU1NiA1NTYgNTAwIDU1\nNiA1NTYKICAyNzcgNTU2IDU1NiAyMjIgMCA1MDAgMjIyIDgzMyA1NTYgNTU2IDU1NiAwIDMzMyA1\nMDAgMjc3IDU1NiAwIDcyMiAwCiAgNTAwXT4+CmVuZG9iago4IDAgb2JqCjw8L0Jhc2VGb250IC9S\nRURNREQrSGVsdmV0aWNhLUJvbGQgL0VuY29kaW5nIC9XaW5BbnNpRW5jb2RpbmcgL0ZpcnN0Q2hh\ncgogIDMyIC9Gb250RGVzY3JpcHRvciAxOSAwIFIgL0xhc3RDaGFyIDExNyAvU3VidHlwZSAvVHJ1\nZVR5cGUgL1RvVW5pY29kZQogIDIwIDAgUiAvVHlwZSAvRm9udCAvV2lkdGhzCiAgWzI3NyAwIDAg\nMCAwIDAgMCAwIDAgMCAwIDAgMjc3IDAgMCAwIDU1NiA1NTYgNTU2IDU1NiAwIDAgMCAwIDAgMCAw\nIDAgMAogIDAgMCAwIDAgMCA3MjIgNzIyIDAgMCAwIDAgMCAyNzcgNTU2IDAgMCAwIDAgMCA2NjYg\nMCAwIDAgMCAwIDAgMCAwIDAgMAogIDAgMCAwIDAgMCAwIDU1NiAwIDU1NiAwIDU1NiAzMzMgNjEw\nIDAgMjc3IDAgMCAwIDAgNjEwIDYxMCAwIDAgMzg5IDU1NgogIDMzMyA2MTBdPj4KZW5kb2JqCjkg\nMCBvYmoKPDwvQkJveCBbMCAwIDE2MzIgMjExMl0gL0xlbmd0aCAxMiAwIFIgL01hdHJpeCBbMC43\nNSAwIDAgLTAuNzUgMCA3OTJdCiAgL1BhaW50VHlwZSAxIC9QYXR0ZXJuVHlwZSAxIC9SZXNvdXJj\nZXMgPDwvWE9iamVjdCA8PC94MTAgMTMgMCBSPj4+PgogIC9UaWxpbmdUeXBlIDEgL1hTdGVwIDE2\nMzIgL1lTdGVwIDIxMTI+PgpzdHJlYW0KIC94MTAgRG8gCgplbmRzdHJlYW0KZW5kb2JqCjEwIDAg\nb2JqCjw8L0JpdHNQZXJDb21wb25lbnQgOCAvQ29sb3JTcGFjZSAvRGV2aWNlUkdCIC9GaWx0ZXIg\nL0RDVERlY29kZSAvSGVpZ2h0CiAgNDE3IC9JbnRlcnBvbGF0ZSB0cnVlIC9MZW5ndGggMTEgMCBS\nIC9TdWJ0eXBlIC9JbWFnZSAvVHlwZSAvWE9iamVjdAogIC9XaWR0aCAxNTE5Pj4Kc3RyZWFtCv/Y\n/+AAEEpGSUYAAQEAAAEAAQAA/9sAQwAIBgYHBgUIBwcHCQkICgwUDQwLCwwZEhMPFB0aHx4dGhwc\nICQuJyAiLCMcHCg3KSwwMTQ0NB8nOT04MjwuMzQy/9sAQwEJCQkMCwwYDQ0YMiEcITIyMjIyMjIy\nMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIyMjIy/8AAEQgBoQXvAwEiAAIR\nAQMRAf/EAB8AAAEFAQEBAQEBAAAAAAAAAAABAgMEBQYHCAkKC//EALUQAAIBAwMCBAMFBQQEAAAB\nfQECAwAEEQUSITFBBhNRYQcicRQygZGhCCNCscEVUtHwJDNicoIJChYXGBkaJSYnKCkqNDU2Nzg5\nOkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6g4SFhoeIiYqSk5SVlpeYmZqio6Slpqeo\nqaqys7S1tre4ubrCw8TFxsfIycrS09TV1tfY2drh4uPk5ebn6Onq8fLz9PX29/j5+v/EAB8BAAMB\nAQEBAQEBAQEAAAAAAAABAgMEBQYHCAkKC//EALURAAIBAgQEAwQHBQQEAAECdwABAgMRBAUhMQYS\nQVEHYXETIjKBCBRCkaGxwQkjM1LwFWJy0QoWJDThJfEXGBkaJicoKSo1Njc4OTpDREVGR0hJSlNU\nVVZXWFlaY2RlZmdoaWpzdHV2d3h5eoKDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5\nusLDxMXGx8jJytLT1NXW19jZ2uLj5OXm5+jp6vLz9PX29/j5+v/aAAwDAQACEQMRAD8A9/ooooAK\nKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAoo\nooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiii\ngAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKA\nCiiigAooooAKKKKACiiigAooooAKKKKACiiigAooooAKKKKACiiigAoo

Step 12: Retrieve notes related to the claim

The retreiveNotes endpoint returns a JSON string containing the notes matching the search string entered by the user or null. Pass pageSize for amount and page for the section of notes to be returned. id refers to claim_id.

View code
Parameters

----------

pageSize : int

id : str

searchString : str

aggregateAll : bool

advSearch : bool

filterAlerts : bool

filterUserGen : bool

orderBy : str

page : int

ascending : bool

type : str

filterExcludeAlerts : bool

filterSystemNotesOnly : bool

Returns

-------

dict

Sample request

View code
curl --location --request POST '/api/v2/notes/retrieveNotes' \

--header 'Content-Type: application/json' \

--header 'Cookie: webpy_session_id=a837f720795b2951ebc52b4e44684dfce64f6d0f' \

--header 'Authorization: \

--data-raw '{

"api_key": "931a9a97-f825-4e51-81d2-ba26d2f9426c",

"id":"c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"orderBy":"date",

"ascending":false,

"page":0,

"pageSize":15

}'

Sample response

View code
{

"records": [

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 302162,

"eventFired": false,

"id": "63e8e41e-ba3b-4e35-8d93-9462c88fda89",

"contents": "Notification of Property Reinsurance Loss was created for this claim on 07-29-2020 09:26:39",

"alertNow": false,

"alertEmail": null,

"title": "Notification of Property Reinsurance Loss was created for this claim",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/29/2020 09:26 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": "db8dac1d-da8c-410a-a8d9-79379904c0b8",

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 303784,

"eventFired": false,

"id": "8d30ebab-131d-47e9-b9f7-55dc6ea40b56",

"contents": "Notification of Property Reinsurance Loss was created for this claim on 07-28-2020 08:40:05",

"alertNow": false,

"alertEmail": null,

"title": "Notification of Property Reinsurance Loss was created for this claim",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 08:40 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": "db8dac1d-da8c-410a-a8d9-79379904c0b8",

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 281127,

"eventFired": false,

"id": "f506a740-03f0-4331-bff5-650c66c694da",

"contents": "To: claims@adjuster.com\n\nNotice: Test Claims Adjuster, you have been assigned as a claims adjuster for claim number C-2020-45 for Policy P-2020-3 for the Insured: Test Organization.",

"alertNow": false,

"alertEmail": null,

"title": "Email Sent: You have been added to Claim C-2020-45 for Policy P-2020-3 for Insured: Test Organization",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 08:39 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": null,

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 261770,

"eventFired": false,

"id": "80a4b176-c80f-465b-b625-c47d773a57fc",

"contents": "To: test.person@email.com\n\nNotice: Test Claims Adjuster has been assigned as a claims adjuster for claim number C-2020-45 for Policy P-2020-3 for the Insured: Test Organization.",

"alertNow": false,

"alertEmail": null,

"title": "Email Sent: Test Insurance - Claims Adjuster Test Claims Adjuster has been added to Claim C-2020-45 for Policy P-2020-3 for Insured: Test Organization",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 08:39 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": null,

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 91526,

"eventFired": false,

"id": "81a9e526-2a15-44c9-9843-ed331d4b5e4b",

"contents": "Test Claims Adjuster is now listed as a claims adjuster.",

"alertNow": false,

"alertEmail": null,

"title": "Claim Contact Updated",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 08:39 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": null,

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 824289,

"eventFired": false,

"id": "32035bfb-f032-48ab-982d-691c78ce67c9",

"contents": "Notification of Property Reinsurance Loss was created for this claim on 07-28-2020 08:25:42",

"alertNow": false,

"alertEmail": null,

"title": "Notification of Property Reinsurance Loss was created for this claim",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 08:25 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": "db8dac1d-da8c-410a-a8d9-79379904c0b8",

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 577723,

"eventFired": false,

"id": "9782a9f8-f253-44a2-9dcf-9db1a210e218",

"contents": "Claim Acknowledgment Letter was created for this claim on 07-28-2020 08:25:38",

"alertNow": false,

"alertEmail": null,

"title": "Claim Acknowledgment Letter was created for this claim",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 08:25 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": "db8dac1d-da8c-410a-a8d9-79379904c0b8",

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 939284,

"eventFired": false,

"id": "312c19f8-49da-4630-9dc1-b53209d9ccb5",

"contents": "The status of this claim has changed from \"Pending, Submitted\" to \"Open, Standard\".",

"alertNow": false,

"alertEmail": null,

"title": "Claim Status Changed",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 08:25 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": null,

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 936450,

"eventFired": false,

"id": "e63e3558-de79-4490-a438-9218c6ad5bc5",

"contents": "To: test.person@email.com\n\nClaim C-2020-45 ( /claims/accounting?claimId=c116aaa5-4aaa-44a6-be45-cb14e750aa37) is being monitored for reinsurance purposes. Changes have been made to the claim that may need to be reviewed. Please visit the Notes tab for this claim to review the recent changes. \n\rIf you would like to stop receiving notifications, please uncheck the \"Monitored for Reinsurance\" checkbox located on the claim under the Information > Options section.",

"alertNow": false,

"alertEmail": null,

"title": "Email Sent: Attention Required - Changes to Claim (C-2020-45)",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 08:25 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": null,

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 919791,

"eventFired": false,

"id": "d4b6566e-dc73-437a-bc5d-8f77ff795706",

"contents": "To: test.person@email.com\n\nNotice: Claim number C-2020-45 status has been changed from Pending, Submitted to Open, Standard for Policy P-2020-3 for the Insured: Test Organization.",

"alertNow": false,

"alertEmail": null,

"title": "Email Sent: Test Insurance - Claim C-2020-45 Status Changed for Policy P-2020-3 for Insured: Test Organization",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 08:25 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": null,

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 245715,

"eventFired": false,

"id": "130c401c-6e5c-4e1b-9b55-40fd85d64f73",

"contents": "Updated the Location 1 - Coverage A - Building loss reserve field from $120000.00 to $150000.00.",

"alertNow": false,

"alertEmail": null,

"title": "Updated Loss Reserve Field",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 08:22 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": null,

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 243324,

"eventFired": false,

"id": "245fe07e-5246-4ecb-a276-cc13e2bed2b9",

"contents": "To: test.person@email.com\n\nClaim C-2020-45 (/claims/accounting?claimId=c116aaa5-4aaa-44a6-be45-cb14e750aa37) is being monitored for reinsurance purposes. Changes have been made to the claim that may need to be reviewed. Please visit the Notes tab for this claim to review the recent changes. \n\rIf you would like to stop receiving notifications, please uncheck the \"Monitored for Reinsurance\" checkbox located on the claim under the Information > Options section.",

"alertNow": false,

"alertEmail": null,

"title": "Email Sent: Attention Required - Changes to Claim (C-2020-45)",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 08:22 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": null,

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 690993,

"eventFired": false,

"id": "dad94ff8-0d1c-4ca7-9344-08dd42d163aa",

"contents": "Notification of Property Reinsurance Loss was created for this claim on 07-28-2020 07:49:06",

"alertNow": false,

"alertEmail": null,

"title": "Notification of Property Reinsurance Loss was created for this claim",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 07:49 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": "db8dac1d-da8c-410a-a8d9-79379904c0b8",

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 63532,

"eventFired": false,

"id": "b0884738-14d5-46a3-ba4c-0882e8b76c8a",

"contents": "Updated the Location 1 - Coverage A - Building adjusting reserve field from $0.00 to $10000.00.",

"alertNow": false,

"alertEmail": null,

"title": "Updated Adjusting Reserve Field",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 07:46 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": null,

"notifiableInsureds": [],

"alertStatus": false

},

{

"referenceId": "c116aaa5-4aaa-44a6-be45-cb14e750aa37",

"eventPreset": "0",

"alertDate": null,

"generation": "system",

"dateMicro": 51049,

"eventFired": false,

"id": "655ef77b-5496-4741-8734-d47158f56f36",

"contents": "This claim's 'Monitored for Reinsurance' status was set to 'True' because it exceeded the Reinsurance Threshold",

"alertNow": false,

"alertEmail": null,

"title": "Edited Monitor for Reinsurance Setting",

"eventAlert": false,

"enteredBy": "clientsystem_tester”,

"alertSent": false,

"editable": true,

"alertDisplayed": false,

"date": "07/28/2020 07:46 AM",

"notifiedInsureds": {},

"frozen": true,

"revisionId": null,

"notifiableInsureds": [],

"alertStatus": false

}

]

Step 13: Add a note to the claim

The storeNote endpoint takes a json_dict with the bc.models.Note() information and stores the record. It will return a success or an error message. Send the following parameters:

View code
Parameters

----------

enteredBy : str

id : str

alertSave : bool

alertStatus : str

eventAlert : str

eventPreset : str

alertDate : str

alertEmail : str

alertNow : str

title : str

contents : str

alertSent : str

notifiedInsureds : str

Returns

-------

success : bool

Sample request

View code
curl --location --request POST '/api/v2/notes/storeNote' \

--header 'Content-Type: application/json' \

--header 'Cookie: webpy_session_id=d77d7e9ed36f1bfa8a0bc940303b4691997e74ce' \

--data-raw '{

"api_key": "931a9a97-f825-4e51-81d2-ba26d2f9426c",

"id":"1c2a7941-7150-404b-8ee3-63b2a484d242",

"enteredBy":"user :: clientsystem_test_agent",

"title":"Testing 101 ",

"contents":"Adding relevant details "

}'

Sample response

View code
{

"success": true

}

You have successfully filed and updated a new claim with its related information.