Async Policies Module API

API reference for asynchronous policy workflows.

BriteCore v2 Async Policies API endpoint wrappers.

Asynchronous (cached) counterparts to the synchronous wrappers in policies.py. Uses AsyncBritecoreAPIClient for non-blocking, TTL-cached HTTP requests.

Read operations (retrieve_policy, retrieve_revision_details, etc.) are cached with a short TTL by default. Mutation operations (create, cancel, reinstate, etc.) automatically invalidate the policy cache namespace on success.

async britecore_sdk.api.api_calls.v2.async_policies.aadd_line_item(revision_id, item_id, property_id='', sub_line_id='', link_id='', check_for_subline=False, **kwargs)[source]

Add a line item to a revision or property asynchronously.

POST /api/v2/policies/add_line_item

Parameters:

  • revision_id (str)

  • item_id (str)

  • property_id (str | None)

  • sub_line_id (str | None)

  • link_id (str | None)

  • check_for_subline (bool | None)

  • kwargs (Unpack[RequestParameters])

Return type:

bool

async britecore_sdk.api.api_calls.v2.async_policies.acreate_policy(policy_number='', policy_type_id='', inception_date='', term_type='1 Year', expiration_date='', renewal_term_type='1 Year', is_renewal=False, as_agent=False, manual_policy_number=True, effective_date='', property_zip='', underwriting_questions=None, underwriting_options=None, external_system_reference='', **kwargs)[source]

Create a new policy asynchronously.

The payload mirrors /api/v2/policies/create_policy and accepts policy, term, underwriting, and external reference fields, including the documented custom-term expiration requirement. Returns the async aprocess_result(...) payload together with the new revision_id, invalidates cached policy reads on success, and accepts RequestParameters overrides.

Parameters:

  • policy_number (str | None) – The policy number (default empty string).

  • policy_type_id (str | None) – The policy type identifier.

  • inception_date (str | None) – Policy inception date.

  • term_type (Literal['Custom', '3 Years', '18 Months', '1 Year', '9 Months', '6 Months', '3 Months'] | None) – The term type (default ‘1 Year’). When ‘Custom’, expiration_date is required.

  • expiration_date (str | None) – Policy expiration date (required when term_type is ‘Custom’).

  • renewal_term_type (Literal['3 Years', '18 Months', '1 Year', '9 Months', '6 Months', '3 Months'] | None) – The renewal term type (default ‘1 Year’).

  • is_renewal (bool | None) – Whether this is a renewal policy (default False).

  • as_agent (bool | None) – Whether creating as an agent (default False).

  • manual_policy_number (bool | None) – Whether the policy number is manually entered (default True).

  • effective_date (str | None) – Policy effective date.

  • property_zip (str | None) – Primary property ZIP code.

  • underwriting_questions (list[Any] | None) – List of underwriting question responses.

  • underwriting_options (list[Any] | None) – List of underwriting option selections.

  • external_system_reference (str | None) – External system reference identifier.

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters and cache invalidation settings.

Returns:

A tuple of (processed_policy_data, revision_id).

Return type:

tuple[Any, str]

Raises:
async britecore_sdk.api.api_calls.v2.async_policies.acreate_risk(revision_id, property_group_number=None, building_number=None, force_categories=None, **kwargs)[source]

Create a risk for a revision asynchronously.

POST /api/v2/policies/create_risk

Parameters:

  • revision_id (str)

  • property_group_number (int | None)

  • building_number (int | None)

  • force_categories (bool | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.anew_mortgagee(property_id, **kwargs)[source]

Create a new mortgagee for a property asynchronously.

POST /api/v2/policies/new_mortgagee

Parameters:
Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.anew_revision_contact(revision_id, contact_id, x_id=None, contact_role='namedInsured', **kwargs)[source]

Add or update a contact assignment on a revision asynchronously.

The workflow uses revision_id, contact_id, and contact_role to create or reuse an x_revisions_contact_id before updating the revision contact link. Returns the async aprocess_result(...) payload, invalidates cached policy reads on success, and accepts RequestParameters overrides.

Parameters:

  • revision_id (str) – The revision identifier.

  • contact_id (str) – The contact identifier to assign.

  • x_id (str | None) – Optional existing x_revisions_contact_id (creates new if not provided).

  • contact_role (Literal['namedInsured', 'addtlInterest', 'financeCompany', 'underwriter', 'driver'] | None) – The role for the contact assignment (default ‘namedInsured’).

  • **kwargs (Unpack[RequestParameters]) – Additional request parameters and cache invalidation settings.

Returns:

The processed result from the final update_revision_contact call.

Return type:

Any

Raises:

RuntimeError – Multiple conditions when ado_request returns None for any operation, or KeyError when contact_add_result missing ‘x_revisions_contact_id’ key.

async britecore_sdk.api.api_calls.v2.async_policies.arate_revision(revision_id, **kwargs)[source]

Calculate a rate for a revision asynchronously.

POST /api/v2/policies/rate_revision

Parameters:
Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.arate_risk(risk_id, **kwargs)[source]

Calculate a rate for a risk asynchronously.

POST /api/v2/policies/rate_risk

Parameters:
Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.aretrieve_policy(policy_number=None, policy_id=None, revision_state=None, **kwargs)[source]

Retrieve top-level policy information asynchronously..

Parameters:

  • policy_number (str | None)

  • policy_id (str | None)

  • revision_state (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.aretrieve_policy_contact_info(policy_number, **kwargs)[source]

Retrieve named insured contact information for a policy.

POST /api/v2/policies/retrieve_policy

Parameters:
Return type:

list[Any]

async britecore_sdk.api.api_calls.v2.async_policies.aretrieve_policy_ids(policy_number, **kwargs)[source]

Retrieve the active revision ID and primary property ID for a policy.

POST /api/v2/policies/retrieve_policy

Parameters:
Return type:

tuple[str, str]

async britecore_sdk.api.api_calls.v2.async_policies.aretrieve_policy_snapshot(policy_number, snapshot_date, **kwargs)[source]

Retrieve a policy snapshot asynchronously.

POST /api/v2/policies/retrieve_policy_snapshot

Parameters:
Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.aretrieve_policy_terms(policy_id='', policy_number='', **kwargs)[source]

Retrieve policy terms and revisions asynchronously.

POST /api/v2/policies/retrieve_policy_terms

Parameters:

  • policy_id (str | None)

  • policy_number (str | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.aretrieve_revision_details(revision_id, include_contact_details=True, **kwargs)[source]

Retrieve detailed revision information asynchronously.

POST /api/v2/policies/retrieve_revision_details

Parameters:

  • revision_id (str)

  • include_contact_details (bool | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.aretrieve_risk_details(risk_id, **kwargs)[source]

Retrieve risk details asynchronously.

POST /api/v2/policies/retrieve_risk_details

Parameters:
Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.aretrieve_risks(revision_id, page=0, page_size=10, retrieve_remaining=True, order_by='name', risk_types=None, **kwargs)[source]

Retrieve paginated or filtered risks for a revision asynchronously.

POST /api/v2/policies/retrieve_risks

Parameters:

  • revision_id (str)

  • page (int | None)

  • page_size (int | None)

  • retrieve_remaining (bool | None)

  • order_by (str | None)

  • risk_types (list[str] | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.astore_mortgagee(property_contact_id, mortgagee_contact_id, **kwargs)[source]

Store mortgagee information for a property contact asynchronously.

POST /api/v2/policies/store_mortgagee

Parameters:

  • property_contact_id (str)

  • mortgagee_contact_id (str)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.aupdate_property_location(location, soft_geoservice_bypass=None, hard_geoservice_bypass=None, reset_premiums=None, **kwargs)[source]

Update property location details asynchronously.

POST /api/v2/policies/update_property_location

Parameters:

  • location (dict[str, Any])

  • soft_geoservice_bypass (bool | None)

  • hard_geoservice_bypass (bool | None)

  • reset_premiums (bool | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any

async britecore_sdk.api.api_calls.v2.async_policies.aupdate_rating_information(property_id='', revision_id='', items=None, reset_premium=True, **kwargs)[source]

Update rating information for a revision or property asynchronously.

POST /api/v2/policies/update_rating_information

Parameters:

  • property_id (str | None)

  • revision_id (str | None)

  • items (list[dict[str, Any]] | None)

  • reset_premium (bool | None)

  • kwargs (Unpack[RequestParameters])

Return type:

Any