Insured Module API

API reference for insured-party management helpers.

BriteCore v2 Insured API endpoint wrappers.

This module provides the SDK wrapper for retrieving property information and associated photos from the BriteCore v2 insured API.

britecore_sdk.api.api_calls.v2.insured.change_billing_schedule(policy_id, billing_schedule_id, policy_term_id=None, **kwargs)[source]

Change an insured’s billing schedule selection.

Parameters:

  • policy_id (str)

  • billing_schedule_id (str)

  • policy_term_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.insured.get_agent_and_agencies_from_contact(contact_id, **kwargs)[source]

Retrieve agent and agency records for a contact.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.get_complete_contact_information(payload=None, **kwargs)[source]

Retrieve complete insured contact details.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.get_primary_carrier(**kwargs)[source]

Retrieve the primary carrier metadata.

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.insured.get_property_information_and_photos(property_id, **kwargs)[source]

Retrieve property information and associated photos.

POST /api/v2/insured/get_property_information_and_photos

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.is_email_available(email, contact_id=None, **kwargs)[source]

Check whether an email address is available for use.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.new_claim_information(property_id, policy_id, **kwargs)[source]

Retrieve claim starter information for a property/policy pair.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.retrieve_contact_information(payload=None, **kwargs)[source]

Retrieve insured contact information.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.set_file_metadata(file_id, metadata, **kwargs)[source]

Update metadata for an insured file record.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.set_photo_as_insurred_preferred(file_id, reference_id, **kwargs)[source]

Mark an uploaded photo as the preferred insured photo.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.set_photo_caption(file_id, caption=None, **kwargs)[source]

Set or update a caption for an insured photo.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.submit_claim(claim_id, **kwargs)[source]

Submit a claim for processing.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.update_claim(payload=None, **kwargs)[source]

Update claim details for an insured workflow.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.update_contact_email_notices_flag(contact_id, enabled, **kwargs)[source]

Update the insured contact email-notices preference flag.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.update_contact_information(payload=None, **kwargs)[source]

Update insured contact information.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.upload_property_or_claim_photo(payload=None, **kwargs)[source]

Upload a property or claim photo.

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.insured.find_similar_contact(contact_ids_to_check=None, ssn_only_check=None, contact_id=None, **kwargs)[source]

Find Similar Contact.

POST /api/v2/insured/find_similar_contact

Parameters:

  • contact_ids_to_check (list[str] | None)

  • ssn_only_check (bool | None)

  • contact_id (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.insured.get_contacts_with_insured_portal_user_role(**kwargs)[source]

Get Contacts With Insured Portal User Role.

POST /api/v2/insured/get_contacts_with_insured_portal_user_role

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any