Policies Module API

API reference for policy lifecycle endpoints and policy management helpers.

BriteCore v2 Policies API endpoint wrappers.

Provides helpers for the full policy lifecycle: retrieval, creation, endorsements, cancellations, reinstatements, renewals, line items, and revision management.

Key functions:: retrieve_policy – Fetch a policy by number or ID. retrieve_policy_ids – Convenience wrapper returning (revision_id, property_id). add_line_item – Add a coverage line item to a revision. cancel_policy – Initiate a policy cancellation. reinstate_policy – Reinstate a previously cancelled policy. renew_policy – Create a renewal for a policy term. get_policies – List all policies (paginated).

britecore_sdk.api.api_calls.v2.policies.add_external_policies_to_existing_groups(external_policies=None, **kwargs)[source]

Add External Policies To Existing Groups.

POST /api/v2/policies/add_external_policies_to_existing_groups

Parameters:

external_policies (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.add_policies_to_existing_groups(field=None, Returns=None, messages=None, success=None, policies=None, **kwargs)[source]

Add Policies To Existing Groups.

POST /api/v2/policies/add_policies_to_existing_groups

Parameters:

field (str | None)
Returns (str | None)
messages (list[str] | None)
success (bool | None)
policies (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.add_policies_to_new_group(policies=None, **kwargs)[source]

Add Policies To New Group.

POST /api/v2/policies/add_policies_to_new_group

Parameters:

policies (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.add_sub_line(revision_id=None, sub_line_id=None, property_id=None, link_id=None, **kwargs)[source]

Add Sub Line.

POST /api/v2/policies/add_sub_line

Parameters:

revision_id (str | None)
sub_line_id (str | None)
property_id (str | None)
link_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.application_signature_event_callback(event_type=None, file_id=None, signer_name=None, signature_url=None, policy_id=None, **kwargs)[source]

Application Signature Event Callback.

POST /api/v2/policies/application_signature_event_callback

Parameters:

event_type (str | None)
file_id (str | None)
signer_name (str | None)
signature_url (str | None)
policy_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.apply_pnc_lockbox_payment_transactions(transactions=None, **kwargs)[source]

Apply Pnc Lockbox Payment Transactions.

POST /api/v2/policies/apply_pnc_lockbox_payment_transactions

Parameters:

transactions (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.async_create_policy_from_britequote(quote=None, postback=None, inception_date=None, transaction_type=None, user=None, term_type=None, **kwargs)[source]

Async Create Policy From Britequote.

POST /api/v2/policies/async_create_policy_from_britequote

Parameters:

quote (Any | None)
postback (Any | None)
inception_date (Any | None)
transaction_type (Any | None)
user (Any | None)
term_type (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.async_create_revision_from_britequote(quote=None, postback=None, transaction_type=None, revision_date=None, user=None, policy_id=None, **kwargs)[source]

Async Create Revision From Britequote.

POST /api/v2/policies/async_create_revision_from_britequote

Parameters:

quote (Any | None)
postback (Any | None)
transaction_type (Any | None)
revision_date (Any | None)
user (Any | None)
policy_id (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.async_request_loss_analysis(revision_id=None, **kwargs)[source]

Async Request Loss Analysis.

POST /api/v2/policies/async_request_loss_analysis

Parameters:

revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.bind(bind_info=None, **kwargs)[source]

Bind a policy to convert it from a quote to an active policy.

Initiates the binding process, which finalizes underwriting and activates coverage. Requires complete bind information including policy holder, coverage selections, and endorsement details.

Parameters:

bind_info (dict[str, Any] | None) – The complete binding information dictionary (required). Typically includes policy_id, premium amount, effective_date, and coverage details.
**kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing the bound policy details and confirmation.

Raises:

BritecoreError.MissingParameter – If bind_info is not provided or invalid.

Return type:

Any

Example

>>> bind_info = {"policy_id": "...", "premium": 1500, ...}
>>> bind(bind_info=bind_info)

POST /api/v2/policies/bind

britecore_sdk.api.api_calls.v2.policies.cancel_policy(cancel_reason=None, cancel_pending_date=None, policy_term_id=None, cancel_date=None, cancel_reason_id=None, policy_id=None, **kwargs)[source]

Cancel an active policy.

Initiates policy cancellation with specified reason and effective date. Either policy_id or policy_term_id must be provided.

Parameters:

policy_id (str | None) – The policy ID to cancel (takes priority if both IDs provided).
policy_term_id (str | None) – The policy term ID to cancel.
cancel_date (str | None) – The cancellation effective date (ISO date format, e.g., “2024-08-01”).
cancel_reason (str | None) – Human-readable cancellation reason (e.g., “Customer Request”).
cancel_reason_id (str | None) – The cancellation reason code/ID from the system.
cancel_pending_date (str | None) – Optional date for pending cancellations.
**kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing cancellation confirmation and details.

Raises:

BritecoreError.MissingParameter – If neither policy_id nor policy_term_id is provided.

Return type:

Any

Example

>>> cancel_policy(policy_id="POL-123", cancel_date="2024-08-15", cancel_reason="Customer Request")

POST /api/v2/policies/cancel_policy

britecore_sdk.api.api_calls.v2.policies.cancel_policy_v2(policy_term_external_system_reference=None, cancellation_reason_id=None, additional_description=None, policy_term_id=None, cancellation_date=None, cancellation_pending_date=None, print_description=None, cancellation_reason=None, policy_id=None, **kwargs)[source]

Cancel Policy V2.

POST /api/v2/policies/cancel_policy_v2

Parameters:

policy_term_external_system_reference (str | None)
cancellation_reason_id (str | None)
additional_description (str | None)
policy_term_id (str | None)
cancellation_date (str | None)
cancellation_pending_date (str | None)
print_description (str | None)
cancellation_reason (str | None)
policy_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.copy_risk(copy_address=None, copy_rating=None, copy_tenants=None, copy_mortgagees=None, from_risk_id=None, to_risk_id=None, **kwargs)[source]

Copy Risk.

POST /api/v2/policies/copy_risk

Parameters:

copy_address (str | None)
copy_rating (str | None)
copy_tenants (str | None)
copy_mortgagees (str | None)
from_risk_id (str | None)
to_risk_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.copy_sub_line(sub_line_instance_id=None, revision_id=None, sub_line_id=None, property_id=None, link_id=None, **kwargs)[source]

Copy Sub Line.

POST /api/v2/policies/copy_sub_line

Parameters:

sub_line_instance_id (str | None)
revision_id (str | None)
sub_line_id (str | None)
property_id (str | None)
link_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.create_from_stateless_quote(stateless_quote_id=None, **kwargs)[source]

Create From Stateless Quote.

POST /api/v2/policies/create_from_stateless_quote

Parameters:

stateless_quote_id (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.create_loss_dispute(reason=None, property_id=None, case_number=None, **kwargs)[source]

Create Loss Dispute.

POST /api/v2/policies/create_loss_dispute

Parameters:

reason (str | None)
property_id (str | None)
case_number (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.create_new_policy(quote_info=None, **kwargs)[source]

Create New Policy.

POST /api/v2/policies/create_new_policy

Parameters:

quote_info (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.create_new_policy_extended(quote_info=None, **kwargs)[source]

Create New Policy Extended.

POST /api/v2/policies/create_new_policy_extended

Parameters:

quote_info (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.create_policy_from_britequote(quote=None, postback=None, term_type=None, inception_date=None, transaction_type=None, **kwargs)[source]

Create a policy directly from a BriteCore quote.

Converts a quote into an active policy in a single operation. This is a convenience wrapper that bypasses manual binding steps for automated workflows.

Parameters:

quote (dict[str, Any] | None) – The complete quote dictionary (required).
inception_date (str | None) – The policy effective date (ISO date format).
term_type (str | None) – The term length (e.g., “1 Year”, “3 Years”).
transaction_type (str | None) – The type of transaction (e.g., “New Business”, “Renewal”).
postback (str | None) – Optional postback URL for async notifications.
**kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing the created policy details.

Raises:

BritecoreError.MissingParameter – If quote is not provided or invalid.

Return type:

Any

Example

>>> quote_data = {"insured": {...}, "coverage": {...}, ...}
>>> create_policy_from_britequote(quote=quote_data, inception_date="2024-09-01")

POST /api/v2/policies/create_policy_from_britequote

britecore_sdk.api.api_calls.v2.policies.create_quote(quote_info=None, **kwargs)[source]

Create Quote.

POST /api/v2/policies/create_quote

Parameters:

quote_info (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.create_quote_async(success=None, field=None, Returns=None, quote_info=None, message=None, data=None, **kwargs)[source]

Create Quote Async.

POST /api/v2/policies/create_quote_async

Parameters:

success (bool | None)
field (str | None)
Returns (str | None)
quote_info (dict[str, Any] | None)
message (list[str] | None)
data (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.create_quote_extended(quote_info=None, requote=None, run_uw_rules=None, run_stateless=None, **kwargs)[source]

Create Quote Extended.

POST /api/v2/policies/create_quote_extended

Parameters:

quote_info (dict[str, Any] | None)
requote (bool | None)
run_uw_rules (bool | None)
run_stateless (bool | str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.create_quote_extended_async(success=None, field=None, Returns=None, run_uw_rules=None, quote_info=None, message=None, data=None, **kwargs)[source]

Create Quote Extended Async.

POST /api/v2/policies/create_quote_extended_async

Parameters:

success (bool | None)
field (str | None)
Returns (str | None)
run_uw_rules (bool | None)
quote_info (dict[str, Any] | None)
message (list[str] | None)
data (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.create_revision_from_britequote(transaction_type=None, quote=None, revision_date=None, postback=None, policy_id=None, **kwargs)[source]

Create Revision From Britequote.

POST /api/v2/policies/create_revision_from_britequote

Parameters:

transaction_type (str | None)
quote (str | None)
revision_date (str | None)
postback (str | None)
policy_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.delete_external_policies(policies=None, **kwargs)[source]

Delete External Policies.

POST /api/v2/policies/delete_external_policies

Parameters:

policies (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.delete_loss_dispute(dispute_id=None, **kwargs)[source]

Delete Loss Dispute.

POST /api/v2/policies/delete_loss_dispute

Parameters:

dispute_id (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.evaluate_cancellation(policy_id=None, **kwargs)[source]

Evaluate cancellation eligibility and penalties for a policy.

Checks whether a policy can be cancelled and calculates any penalties, prorations, or other financial impacts of cancellation.

Parameters:

policy_id (str | None) – The policy ID to evaluate (required).
**kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing cancellation eligibility, penalties, and prorations.

Raises:

BritecoreError.MissingParameter – If policy_id is not provided.

Return type:

Any

Example

>>> evaluate_cancellation(policy_id="POL-123")

POST /api/v2/policies/evaluate_cancellation

britecore_sdk.api.api_calls.v2.policies.export_auto_policies(property_ids=None, revision_ids=None, **kwargs)[source]

Export Auto Policies.

POST /api/v2/policies/export_auto_policies

Parameters:

property_ids (list[str] | None)
revision_ids (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.export_policies(property_ids=None, revision_ids=None, **kwargs)[source]

Export Policies.

POST /api/v2/policies/export_policies

Parameters:

property_ids (list[str] | None)
revision_ids (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.get_loss_disputes(property_id=None, **kwargs)[source]

Get Loss Disputes.

POST /api/v2/policies/get_loss_disputes

Parameters:

property_id (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.get_policy_groups(**kwargs)[source]

Get Policy Groups.

POST /api/v2/policies/get_policy_groups

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.policies.get_revision_data_for_stp(revision_id=None, **kwargs)[source]

Get Revision Data For Stp.

POST /api/v2/policies/get_revision_data_for_stp

Parameters:

revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.get_underlying_policy_changes(revision_id=None, **kwargs)[source]

Get Underlying Policy Changes.

POST /api/v2/policies/get_underlying_policy_changes

Parameters:

revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.get_underwriting_review_workflow(**kwargs)[source]

Get Underwriting Review Workflow.

POST /api/v2/policies/get_underwriting_review_workflow

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.policies.import_iso_protection_classes(county_fips=None, retrieval_date=None, distance_to_coast_range_name=None, protection_class=None, distance_to_coast_range_code=None, bcegs_year=None, distance_to_coast_county_name=None, bcegs_positive_hit=None, bcegs_code=None, county_name=None, effective_date=None, distance_to_coast_fips=None, fire_district=None, property_id=None, distance_to_coast_ocean_gulf_name=None, **kwargs)[source]

Import Iso Protection Classes.

POST /api/v2/policies/import_iso_protection_classes

Parameters:

county_fips (Any | None)
retrieval_date (Any | None)
distance_to_coast_range_name (Any | None)
protection_class (Any | None)
distance_to_coast_range_code (Any | None)
bcegs_year (Any | None)
distance_to_coast_county_name (Any | None)
bcegs_positive_hit (Any | None)
bcegs_code (Any | None)
county_name (Any | None)
effective_date (Any | None)
distance_to_coast_fips (Any | None)
fire_district (Any | None)
property_id (Any | None)
distance_to_coast_ocean_gulf_name (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.import_munichre_eligibility(retrieval_date=None, is_eligible=None, score=None, property_id=None, **kwargs)[source]

Import Munichre Eligibility.

POST /api/v2/policies/import_munichre_eligibility

Parameters:

retrieval_date (Any | None)
is_eligible (Any | None)
score (Any | None)
property_id (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.initialize_application_questions(**kwargs)[source]

Initialize Application Questions.

POST /api/v2/policies/initialize_application_questions

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.policies.initiate_property_valuation(integration_instance_id=None, property_id=None, **kwargs)[source]

Initiate Property Valuation.

POST /api/v2/policies/initiate_property_valuation

Parameters:

integration_instance_id (str | None)
property_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.issue(issue_info=None, **kwargs)[source]

Issue.

POST /api/v2/policies/issue

Parameters:

issue_info (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.ivr_lookup(digits=None, property_address_zip=None, **kwargs)[source]

Ivr Lookup.

POST /api/v2/policies/ivr_lookup

Parameters:

digits (str | None)
property_address_zip (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.link_underlying_policy(revision_id=None, underlying_policy_id=None, **kwargs)[source]

Link Underlying Policy.

POST /api/v2/policies/link_underlying_policy

Parameters:

revision_id (str | None)
underlying_policy_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.new_policy_information(**kwargs)[source]

New Policy Information.

POST /api/v2/policies/new_policy_information

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.policies.new_revision(policy_id=None, renewal_status=None, revision_date=None, override_effective_date_checks=None, check_for_policy_changes=None, force_persistent_builder=None, **kwargs)[source]

New Revision.

POST /api/v2/policies/new_revision

Parameters:

policy_id (str | None)
renewal_status (str | None)
revision_date (str | None)
override_effective_date_checks (bool | None)
check_for_policy_changes (str | None)
force_persistent_builder (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.post_external_policies(policies=None, **kwargs)[source]

Post External Policies.

POST /api/v2/policies/post_external_policies

Parameters:

policies (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.rate_quote_revision(**kwargs)[source]

Rate Quote Revision.

POST /api/v2/policies/rate_quote_revision

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.policies.remove_line_item(item_id=None, **kwargs)[source]

Remove Line Item.

POST /api/v2/policies/remove_line_item

Parameters:

item_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.requote_extended(quote_info=None, run_uw_rules=None, **kwargs)[source]

Requote Extended.

POST /api/v2/policies/requote_extended

Parameters:

quote_info (str | None)
run_uw_rules (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.reset_revision_premium(revision_id=None, **kwargs)[source]

Reset Revision Premium.

POST /api/v2/policies/reset_revision_premium

Parameters:

revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.reset_risk_premium(risk_id=None, **kwargs)[source]

Reset Risk Premium.

POST /api/v2/policies/reset_risk_premium

Parameters:

risk_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_account_history(current_page=None, policy_term_id=None, page_size=None, filter_dict=None, policy_id=None, **kwargs)[source]

Retrieve Account History.

POST /api/v2/policies/retrieve_account_history

Parameters:

current_page (int | None)
policy_term_id (str | None)
page_size (int | None)
filter_dict (dict[str, Any] | None)
policy_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_cancellation_info(revision_id=None, **kwargs)[source]

Retrieve Cancellation Info.

POST /api/v2/policies/retrieve_cancellation_info

Parameters:

revision_id (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_current_and_future_policies_terms_with_recurring_payment_method_id(payment_method_id=None, **kwargs)[source]

Retrieve Current And Future Policies Terms With Recurring Payment Method Id.

POST /api/v2/policies/retrieve_current_and_future_policies_terms_with_recurring_payment_method_id

Parameters:

payment_method_id (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_files_pending_signature(policy_id=None, **kwargs)[source]

Retrieve Files Pending Signature.

POST /api/v2/policies/retrieve_files_pending_signature

Parameters:

policy_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_ivans_billing_data(revision_id=None, **kwargs)[source]

Retrieve Ivans Billing Data.

POST /api/v2/policies/retrieve_ivans_billing_data

Parameters:

revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_pnc_lockbox_matchfile_info(**kwargs)[source]

Retrieve Pnc Lockbox Matchfile Info.

POST /api/v2/policies/retrieve_pnc_lockbox_matchfile_info

Parameters:: kwargs (Unpack[RequestParameters])
Return type:: Any

britecore_sdk.api.api_calls.v2.policies.retrieve_policy_change_logs(transactions=None, revision_ids=None, filter_by=None, allow_timestamp=None, from_date=None, to_date=None, policy_type_ids=None, **kwargs)[source]

Retrieve Policy Change Logs.

POST /api/v2/policies/retrieve_policy_change_logs

Parameters:

transactions (list[str] | None)
revision_ids (list[str] | None)
filter_by (str | None)
allow_timestamp (bool | None)
from_date (str | None)
to_date (str | None)
policy_type_ids (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_potential_policies_payors(policy_numbers=None, **kwargs)[source]

Retrieve Potential Policies Payors.

POST /api/v2/policies/retrieve_potential_policies_payors

Parameters:

policy_numbers (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_properties_by_coverage_name(revision_id=None, name=None, policy_id=None, **kwargs)[source]

Retrieve Properties By Coverage Name.

POST /api/v2/policies/retrieve_properties_by_coverage_name

Parameters:

revision_id (str | None)
name (str | None)
policy_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_properties_by_group(revision_id=None, **kwargs)[source]

Retrieve Properties By Group.

POST /api/v2/policies/retrieve_properties_by_group

Parameters:

revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_rates_for_quote(revision_id=None, rating_specs=None, **kwargs)[source]

Retrieve Rates For Quote.

POST /api/v2/policies/retrieve_rates_for_quote

Parameters:

revision_id (str | None)
rating_specs (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_revision_analysis(revision_id=None, **kwargs)[source]

Retrieve Revision Analysis.

POST /api/v2/policies/retrieve_revision_analysis

Parameters:

revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_revision_invoice_numbers(revision_id=None, **kwargs)[source]

Retrieve Revision Invoice Numbers.

POST /api/v2/policies/retrieve_revision_invoice_numbers

Parameters:

revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_revision_property_group_numbers(revision_id=None, **kwargs)[source]

Retrieve Revision Property Group Numbers.

POST /api/v2/policies/retrieve_revision_property_group_numbers

Parameters:

revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_revision_status(revision_id=None, **kwargs)[source]

Retrieve Revision Status.

POST /api/v2/policies/retrieve_revision_status

Parameters:

revision_id (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.retrieve_underlying_policy(revision_id=None, **kwargs)[source]

Retrieve Underlying Policy.

POST /api/v2/policies/retrieve_underlying_policy

Parameters:

revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.rewrite_policy(term=None, policy_number=None, rewritten_revision_external_system_reference=None, expiration_date=None, reason_id=None, policy_number_option=None, effective_date=None, reason=None, revision_external_system_reference=None, rewritten_policy_number=None, revision_id=None, at_renewal_set_policy_term_to=None, **kwargs)[source]

Rewrite Policy.

POST /api/v2/policies/rewrite_policy

Parameters:

term (str | None)
policy_number (str | None)
rewritten_revision_external_system_reference (str | None)
expiration_date (str | None)
reason_id (str | None)
policy_number_option (str | None)
effective_date (str | None)
reason (str | None)
revision_external_system_reference (str | None)
rewritten_policy_number (str | None)
revision_id (str | None)
at_renewal_set_policy_term_to (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.run_property_lookup(dependencies=None, integration_instance_id=None, property_id=None, headless=None, **kwargs)[source]

Run Property Lookup.

POST /api/v2/policies/run_property_lookup

Parameters:

dependencies (list[str] | None)
integration_instance_id (str | None)
property_id (str | None)
headless (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.run_underwriting_rules(success=None, field=None, Returns=None, exclude_modules=None, revision_id=None, use_new_rules_engine=None, message=None, property_id=None, **kwargs)[source]

Run Underwriting Rules.

POST /api/v2/policies/run_underwriting_rules

Parameters:

success (bool | None)
field (str | None)
Returns (str | None)
exclude_modules (str | None)
revision_id (str | None)
use_new_rules_engine (str | None)
message (str | None)
property_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.set_binder_to_active(revision_id=None, external_system_reference=None, **kwargs)[source]

Set Binder To Active.

POST /api/v2/policies/set_binder_to_active

Parameters:

revision_id (str | None)
external_system_reference (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.set_exclude_from_combined_billing(exclude=None, policy_id=None, **kwargs)[source]

Set Exclude From Combined Billing.

POST /api/v2/policies/set_exclude_from_combined_billing

Parameters:

exclude (Any | None)
policy_id (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.store_policy_information(quote_info=None, policy_data=None, **kwargs)[source]

Store Policy Information.

POST /api/v2/policies/store_policy_information

Parameters:

quote_info (Any | None)
policy_data (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.store_policy_information_extended(quote_info=None, run_uw_rules=None, policy_data=None, **kwargs)[source]

Store Policy Information Extended.

POST /api/v2/policies/store_policy_information_extended

Parameters:

quote_info (dict[str, Any] | None)
run_uw_rules (bool | None)
policy_data (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.store_renewal_status(renewal_status_reason=None, revision_id=None, renewal_status=None, renewal_status_description=None, **kwargs)[source]

Store Renewal Status.

POST /api/v2/policies/store_renewal_status

Parameters:

renewal_status_reason (Any | None)
revision_id (Any | None)
renewal_status (Any | None)
renewal_status_description (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.store_revision_description(revision_id=None, type=None, description=None, **kwargs)[source]

Store Revision Description.

POST /api/v2/policies/store_revision_description

Parameters:

revision_id (str | None)
type (str | None)
description (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.submit_quote(date_cursor=None, json_dict=None, **kwargs)[source]

Submit a quote for processing in the policy workflow.

Sends a quote to the next stage in the underwriting or binding process. This is typically used after quote modifications or rate updates.

Parameters:

json_dict (Any | None) – The quote data dictionary to submit (required).
date_cursor (Any | None) – Optional cursor for pagination or batch processing.
**kwargs (Unpack[RequestParameters]) – Additional request parameters (timeout, retry, headers, etc.).

Returns:

API response containing confirmation of submission and next steps.

Return type:

Any

Example

>>> quote_data = {"quote_id": "...", "status": "ready", ...}
>>> submit_quote(json_dict=quote_data)

POST /api/v2/policies/submit_quote

britecore_sdk.api.api_calls.v2.policies.sync_item_within_a_property_group(property_group_id=None, item_id=None, builder_obj=None, **kwargs)[source]

Sync Item Within A Property Group.

POST /api/v2/policies/sync_item_within_a_property_group

Parameters:

property_group_id (str | None)
item_id (str | None)
builder_obj (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.sync_underlying_policy_changes(revision_id=None, **kwargs)[source]

Sync Underlying Policy Changes.

POST /api/v2/policies/sync_underlying_policy_changes

Parameters:

revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_billing_schedule(billing_schedule=None, policy_term_id=None, policy_id=None, **kwargs)[source]

Update Billing Schedule.

POST /api/v2/policies/update_billing_schedule

Parameters:

billing_schedule (str | None)
policy_term_id (str | None)
policy_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_builder_ready_to_rate(property_revision=None, property_id=None, revision_id=None, is_completed=None, **kwargs)[source]

Update Builder Ready To Rate.

POST /api/v2/policies/update_builder_ready_to_rate

Parameters:

property_revision (dict[str, Any] | None)
property_id (str | None)
revision_id (str | None)
is_completed (bool | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_contact_interest(x_revisions_contact_id=None, revision_id=None, interest=None, **kwargs)[source]

Update Contact Interest.

POST /api/v2/policies/update_contact_interest

Parameters:

x_revisions_contact_id (str | None)
revision_id (str | None)
interest (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_effective_and_expiration_date(effective_date=None, expiration_date=None, policy_term_type=None, policy_type_id=None, policy_id=None, **kwargs)[source]

Update Effective And Expiration Date.

POST /api/v2/policies/update_effective_and_expiration_date

Parameters:

effective_date (str | None)
expiration_date (str | None)
policy_term_type (str | None)
policy_type_id (str | None)
policy_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_inactive_policy_groups(force_removal=None, group_ids=None, **kwargs)[source]

Update Inactive Policy Groups.

POST /api/v2/policies/update_inactive_policy_groups

Parameters:

force_removal (str | None)
group_ids (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_loss_dispute(dispute_id=None, reason=None, **kwargs)[source]

Update Loss Dispute.

POST /api/v2/policies/update_loss_dispute

Parameters:

dispute_id (Any | None)
reason (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_mortgagee_information(x_contact_reference=None, mortgagee_info=None, **kwargs)[source]

Update Mortgagee Information.

POST /api/v2/policies/update_mortgagee_information

Parameters:

x_contact_reference (str | None)
mortgagee_info (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_policies_terms_payment_method_batch(policy_term_ids=None, payment_method_id=None, **kwargs)[source]

Update Policies Terms Payment Method Batch.

POST /api/v2/policies/update_policies_terms_payment_method_batch

Parameters:

policy_term_ids (Any | None)
payment_method_id (Any | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_policy_contact(contact_role=None, contact_id=None, x_policy_contact_id=None, **kwargs)[source]

Update Policy Contact.

POST /api/v2/policies/update_policy_contact

Parameters:

contact_role (str | None)
contact_id (str | None)
x_policy_contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_policy_last_visited(revision_id=None, params=None, policy_id=None, **kwargs)[source]

Update Policy Last Visited.

POST /api/v2/policies/update_policy_last_visited

Parameters:

revision_id (str | None)
params (dict[str, Any] | None)
policy_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_primary_property(property_id=None, **kwargs)[source]

Update Primary Property.

POST /api/v2/policies/update_primary_property

Parameters:

property_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_property_sub_line_name(property_sub_line_id=None, **kwargs)[source]

Update Property Sub Line Name.

POST /api/v2/policies/update_property_sub_line_name

Parameters:

property_sub_line_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_property_valuation(integration_instance_external_id=None, replacement_cost_value=None, property_id=None, property_val=None, **kwargs)[source]

Update Property Valuation.

POST /api/v2/policies/update_property_valuation

Parameters:

integration_instance_external_id (str | None)
replacement_cost_value (str | None)
property_id (str | None)
property_val (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_review_workflow(workflow_event=None, event_context=None, revision_id=None, **kwargs)[source]

Update Review Workflow.

POST /api/v2/policies/update_review_workflow

Parameters:

workflow_event (str | None)
event_context (dict[str, Any] | None)
revision_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_underwriting_options(revision_id=None, underwriting_options=None, **kwargs)[source]

Update Underwriting Options.

POST /api/v2/policies/update_underwriting_options

Parameters:

revision_id (str | None)
underwriting_options (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.policies.update_underwriting_questions(revision_id=None, underwriting_questions=None, **kwargs)[source]

Update Underwriting Questions.

POST /api/v2/policies/update_underwriting_questions

Parameters:

revision_id (str | None)
underwriting_questions (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any