Contacts Module API

API reference for contact management endpoints.

BriteCore v2 Contacts API endpoint wrappers.

This module provides wrappers for contact creation, updates, role assignment, lookup by identifier, and filtered contact search.

britecore_sdk.api.api_calls.v2.contacts.new_contact(name, address, phone=None, email=None, contact_type='individual', **kwargs)[source]

Create a contact record.

POST /api/v2/contacts/new_contact

Parameters:

name (str)
address (list[dict[str, str]])
phone (list[dict[str, str] | None] | None)
email (list[dict[str, str] | None] | None)
contact_type (Literal['individual', 'organization'] | None)
kwargs (Unpack[RequestParameters])

Return type:

tuple[Any, str | None]

britecore_sdk.api.api_calls.v2.contacts.add_contact_to_role(contact_id, role='Named Insured', **kwargs)[source]

Assign an existing contact to a role.

POST /api/v2/contacts/add_contact_to_role

Parameters:

contact_id (str)
role (Literal['Additional Insured', 'Additional Interest', 'Administrator', 'Agent', 'Attorney', 'Board Member', 'Claim Administrator', 'Claimant', 'Claims Adjuster', 'Claims Supervisor', 'Contractor', 'Driver', 'Employee', 'External Claims Adjuster', 'In Care Of', 'Inspector', 'Loss Payee', 'Medical Provider', 'Named Insured', 'Public Claims Adjuster', 'Surplus Lines Producer', 'Underwriter', 'Unlisted Payor', 'Vendor'] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.update_contact(contact, **kwargs)[source]

Update an existing contact record.

POST /api/v2/contacts/update_contact

Parameters:

contact (dict[str, str | list[dict[str, str]]])
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_contact(contact_id, **kwargs)[source]

Retrieve a contact by identifier.

POST /api/v2/contacts/get_contact

Parameters:

contact_id (str)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.find_contact_by_params(name, role_name=None, dob=None, **kwargs)[source]

Search for contacts by name and optional filters.

POST /api/v2/contacts/find_contact_by_params

Parameters:

name (str)
role_name (Literal['Additional Insured', 'Additional Interest', 'Administrator', 'Agent', 'Attorney', 'Board Member', 'Claim Administrator', 'Claimant', 'Claims Adjuster', 'Claims Supervisor', 'Contractor', 'Driver', 'Employee', 'External Claims Adjuster', 'In Care Of', 'Inspector', 'Loss Payee', 'Medical Provider', 'Named Insured', 'Public Claims Adjuster', 'Surplus Lines Producer', 'Underwriter', 'Unlisted Payor', 'Vendor'] | None)
dob (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_contacts_by_ids(contact_id_list, **kwargs)[source]

Retrieve contacts by a list of IDs.

POST /api/v2/contacts/get_contacts_by_ids

Parameters:

contact_id_list (list[str])
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.add_member_to_agency(set_member_company=None, agency_id=None, member_id=None, **kwargs)[source]

Add Member To Agency.

POST /api/v2/contacts/add_member_to_agency

Parameters:

set_member_company (str | None)
agency_id (str | None)
member_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.assign_policy_contact(role=None, contact_id=None, policy_id=None, **kwargs)[source]

Assign Policy Contact.

POST /api/v2/contacts/assign_policy_contact

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.assign_quote_contact(role=None, quote_id=None, contact_id=None, **kwargs)[source]

Assign Quote Contact.

POST /api/v2/contacts/assign_quote_contact

Parameters:

role (str | None)
quote_id (str | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.assign_risk_contact(role=None, risk_id=None, contact_id=None, **kwargs)[source]

Assign Risk Contact.

POST /api/v2/contacts/assign_risk_contact

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.check_username_availability(username=None, **kwargs)[source]

Check Username Availability.

POST /api/v2/contacts/check_username_availability

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.create_contact(username=None, source_update_date=None, dba=None, phones=None, date_business_started=None, agency_number=None, company_id=None, agent_ids=None, ssn_group=None, driver_license_date=None, commission_structure=None, agency_group_number=None, agency_inception_date=None, fein_tax_id=None, date_of_birth=None, agency_group_id=None, purchase_date=None, type=None, last_synched_date=None, added_by=None, producer_number=None, website=None, hicn_number=None, follow_agency_quoting_restriction=None, date_of_death=None, ssn=None, agency_id=None, drivers_license=None, confirmation_email=None, agency_termination_date=None, emails=None, addresses=None, external_system_reference=None, name=None, roles=None, gender=None, license_state=None, legal_entity_type=None, position=None, **kwargs)[source]

Create Contact.

POST /api/v2/contacts/create_contact

Parameters:

username (str | None)
source_update_date (str | None)
dba (str | None)
phones (list[dict[str, Any]] | None)
date_business_started (str | None)
agency_number (str | None)
company_id (str | None)
agent_ids (list[str] | None)
ssn_group (str | None)
driver_license_date (str | None)
commission_structure (str | None)
agency_group_number (str | None)
agency_inception_date (str | None)
fein_tax_id (str | None)
date_of_birth (str | None)
agency_group_id (str | None)
purchase_date (str | None)
type (str | None)
last_synched_date (str | None)
added_by (str | None)
producer_number (str | None)
website (str | None)
hicn_number (str | None)
follow_agency_quoting_restriction (bool | None)
date_of_death (str | None)
ssn (str | None)
agency_id (str | None)
drivers_license (str | None)
confirmation_email (str | None)
agency_termination_date (str | None)
emails (list[dict[str, Any]] | None)
addresses (list[dict[str, Any]] | None)
external_system_reference (str | None)
name (str | None)
roles (list[dict[str, Any]] | None)
gender (str | None)
license_state (str | None)
legal_entity_type (str | None)
position (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.create_credit_report_for_contact(policy_type_id=None, contact_id=None, **kwargs)[source]

Create Credit Report For Contact.

POST /api/v2/contacts/create_credit_report_for_contact

Parameters:

policy_type_id (str | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.credit_score_threshold_details(ref_contact_id=None, contact_ids=None, **kwargs)[source]

Credit Score Threshold Details.

POST /api/v2/contacts/credit_score_threshold_details

Parameters:

ref_contact_id (str | None)
contact_ids (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.enable_or_disable_contact(active=None, contact_id=None, **kwargs)[source]

Enable Or Disable Contact.

POST /api/v2/contacts/enable_or_disable_contact

Parameters:

active (bool | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.generate_contact_number(contact_id=None, **kwargs)[source]

Generate Contact Number.

POST /api/v2/contacts/generate_contact_number

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_aspect_data(all=None, id=None, has_permissions=None, role_id=None, **kwargs)[source]

Get Aspect Data.

POST /api/v2/contacts/get_aspect_data

Parameters:

all (str | None)
id (str | None)
has_permissions (str | None)
role_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_aspect_data_settings(**kwargs)[source]

Get Aspect Data Settings.

POST /api/v2/contacts/get_aspect_data_settings

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

britecore_sdk.api.api_calls.v2.contacts.get_contact_associations(policy_type_ids=None, contact_ids=None, **kwargs)[source]

Get Contact Associations.

POST /api/v2/contacts/get_contact_associations

Parameters:

policy_type_ids (list[str] | None)
contact_ids (list[str] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_contact_by_agency(agency_number=None, **kwargs)[source]

Get Contact By Agency.

POST /api/v2/contacts/get_contact_by_agency

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_contact_by_agency_group(agency_group_number=None, **kwargs)[source]

Get Contact By Agency Group.

POST /api/v2/contacts/get_contact_by_agency_group

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_contact_by_agent(producer_number=None, **kwargs)[source]

Get Contact By Agent.

POST /api/v2/contacts/get_contact_by_agent

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_contact_by_cognito_username(cognito_username=None, **kwargs)[source]

Get Contact By Cognito Username.

POST /api/v2/contacts/get_contact_by_cognito_username

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_contact_by_credentials(username=None, password=None, **kwargs)[source]

Get Contact By Credentials.

POST /api/v2/contacts/get_contact_by_credentials

Parameters:

username (str | None)
password (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_contact_for_migration(search_str=None, **kwargs)[source]

Get Contact For Migration.

POST /api/v2/contacts/get_contact_for_migration

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_payment_methods(payment_method_ids=None, **kwargs)[source]

Get Payment Methods.

POST /api/v2/contacts/get_payment_methods

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.get_resource_producer_id(revision_id=None, policy_id=None, **kwargs)[source]

Get Resource Producer Id.

POST /api/v2/contacts/get_resource_producer_id

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.link_contact_to_cognito_user(cognito_username=None, contact_id=None, **kwargs)[source]

Link Contact To Cognito User.

POST /api/v2/contacts/link_contact_to_cognito_user

Parameters:

cognito_username (str | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.list_all_contacts(**kwargs)[source]

List All Contacts.

POST /api/v2/contacts/list_all_contacts

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

britecore_sdk.api.api_calls.v2.contacts.list_credit_reports_for_contact(contact_id=None, **kwargs)[source]

List Credit Reports For Contact.

POST /api/v2/contacts/list_credit_reports_for_contact

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.list_emails_for_contact(contact_id=None, **kwargs)[source]

List Emails For Contact.

POST /api/v2/contacts/list_emails_for_contact

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.modify_contact(username=None, drivers_license=None, dba=None, phones=None, date_business_started=None, agency_number=None, company_id=None, id=None, ssn_group=None, driver_license_date=None, commission_structure=None, agency_group_number=None, agency_inception_date=None, fein_tax_id=None, date_of_birth=None, purchase_date=None, type=None, last_synched_date=None, added_by=None, agent_ids=None, website=None, hicn_number=None, follow_agency_quoting_restriction=None, date_of_death=None, ssn=None, source_update_date=None, confirmation_email=None, agency_termination_date=None, emails=None, addresses=None, external_system_reference=None, name=None, roles=None, gender=None, license_state=None, legal_entity_type=None, position=None, **kwargs)[source]

Modify Contact.

POST /api/v2/contacts/modify_contact

Parameters:

username (str | None)
drivers_license (str | None)
dba (str | None)
phones (list[dict[str, Any]] | None)
date_business_started (str | None)
agency_number (str | None)
company_id (str | None)
id (str | None)
ssn_group (str | None)
driver_license_date (str | None)
commission_structure (str | None)
agency_group_number (str | None)
agency_inception_date (str | None)
fein_tax_id (str | None)
date_of_birth (str | None)
purchase_date (str | None)
type (str | None)
last_synched_date (str | None)
added_by (str | None)
agent_ids (list[str] | None)
website (str | None)
hicn_number (str | None)
follow_agency_quoting_restriction (bool | None)
date_of_death (str | None)
ssn (str | None)
source_update_date (str | None)
confirmation_email (str | None)
agency_termination_date (str | None)
emails (list[dict[str, Any]] | None)
addresses (list[dict[str, Any]] | None)
external_system_reference (str | None)
name (str | None)
roles (list[dict[str, Any]] | None)
gender (str | None)
license_state (str | None)
legal_entity_type (str | None)
position (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.remove_contact_from_role(role_name=None, contact_id=None, **kwargs)[source]

Remove Contact From Role.

POST /api/v2/contacts/remove_contact_from_role

Parameters:

role_name (str | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.remove_contact_information(contact_emails=None, contact_addresses=None, contact_phones=None, contact_id=None, **kwargs)[source]

Remove Contact Information.

POST /api/v2/contacts/remove_contact_information

Parameters:

contact_emails (list[str] | None)
contact_addresses (list[str] | None)
contact_phones (list[str] | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.remove_contact_system_tags(system_tags=None, contact_id=None, **kwargs)[source]

Remove Contact System Tags.

POST /api/v2/contacts/remove_contact_system_tags

Parameters:

system_tags (list[str] | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.remove_policy_contact(role=None, contact_id=None, policy_id=None, **kwargs)[source]

Remove Policy Contact.

POST /api/v2/contacts/remove_policy_contact

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.remove_quote_contact(role=None, quote_id=None, contact_id=None, **kwargs)[source]

Remove Quote Contact.

POST /api/v2/contacts/remove_quote_contact

Parameters:

role (str | None)
quote_id (str | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.remove_risk_contact(role=None, risk_id=None, contact_id=None, **kwargs)[source]

Remove Risk Contact.

POST /api/v2/contacts/remove_risk_contact

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieveaddressinfo(stateAbbr=None, zip=None, addressLine1=None, **kwargs)[source]

Retrieveaddressinfo.

POST /api/v2/contacts/retrieveAddressInfo

Parameters:

stateAbbr (str | None)
zip (str | None)
addressLine1 (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_address_suggestions(address_line2=None, address_city=None, address_line1=None, address_state=None, policy_type_id=None, address_country=None, address_zip=None, **kwargs)[source]

Retrieve Address Suggestions.

POST /api/v2/contacts/retrieve_address_suggestions

Parameters:

address_line2 (str | None)
address_city (str | None)
address_line1 (str | None)
address_state (str | None)
policy_type_id (str | None)
address_country (str | None)
address_zip (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_addresses(address_ids=None, **kwargs)[source]

Retrieve Addresses.

POST /api/v2/contacts/retrieve_addresses

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_agencies_near_zip(max_distance=None, zipcode=None, results=None, **kwargs)[source]

Retrieve Agencies Near Zip.

POST /api/v2/contacts/retrieve_agencies_near_zip

Parameters:

max_distance (int | None)
zipcode (str | None)
results (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_all_roles(login_only=None, **kwargs)[source]

Retrieve All Roles.

POST /api/v2/contacts/retrieve_all_roles

Parameters:

login_only (bool | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_contact(external_system_reference=None, id=None, **kwargs)[source]

Retrieve Contact.

POST /api/v2/contacts/retrieve_contact

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_contact_info(contact_id=None, **kwargs)[source]

Retrieve Contact Info.

POST /api/v2/contacts/retrieve_contact_info

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_contact_motor_vehicle_reports(store_no_hit=None, contact_id=None, **kwargs)[source]

Retrieve Contact Motor Vehicle Reports.

POST /api/v2/contacts/retrieve_contact_motor_vehicle_reports

Parameters:

store_no_hit (str | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_contact_system_tags(contact_id=None, **kwargs)[source]

Retrieve Contact System Tags.

POST /api/v2/contacts/retrieve_contact_system_tags

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_credit_score_tier(policy_type_id=None, contact_id=None, **kwargs)[source]

Retrieve Credit Score Tier.

POST /api/v2/contacts/retrieve_credit_score_tier

Parameters:

policy_type_id (str | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_dob_and_ssn(contact_id=None, **kwargs)[source]

Retrieve Dob And Ssn.

POST /api/v2/contacts/retrieve_dob_and_ssn

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_quoting_permissions(contact_id=None, **kwargs)[source]

Retrieve Quoting Permissions.

POST /api/v2/contacts/retrieve_quoting_permissions

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.retrieve_related_contacts(result_structure=None, attributes_required=None, cognito_username=None, contact_id=None, relations_required=None, **kwargs)[source]

Retrieve Related Contacts.

POST /api/v2/contacts/retrieve_related_contacts

Parameters:

result_structure (str | None)
attributes_required (str | None)
cognito_username (str | None)
contact_id (str | None)
relations_required (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.search_names_emails(query=None, limit=None, **kwargs)[source]

Search Names Emails.

POST /api/v2/contacts/search_names_emails

Parameters:

query (str | None)
limit (int | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.set_aspect_data(payments_issued=None, agency_number=None, login_information=None, id=None, commission_payment=None, agency_dates=None, agency_group_number=None, role_id=None, inactive_agency=None, vendor_number=None, producer_number=None, notices=None, commission_structure=None, quoting_restriction=None, default_surplus_lines_producer=None, interest_content=None, sweep_account=None, agencies=None, disallow_e2_value=None, is_1099_reportable=None, personal_information=None, default_agency=None, naic_number=None, credit_score_account=None, agency_group=None, termination=None, **kwargs)[source]

Set Aspect Data.

POST /api/v2/contacts/set_aspect_data

Parameters:

payments_issued (dict[str, Any] | None)
agency_number (dict[str, Any] | None)
login_information (dict[str, Any] | None)
id (str | None)
commission_payment (dict[str, Any] | None)
agency_dates (dict[str, Any] | None)
agency_group_number (dict[str, Any] | None)
role_id (str | None)
inactive_agency (bool | None)
vendor_number (dict[str, Any] | None)
producer_number (dict[str, Any] | None)
notices (dict[str, Any] | None)
commission_structure (dict[str, Any] | None)
quoting_restriction (dict[str, Any] | None)
default_surplus_lines_producer (dict[str, Any] | None)
interest_content (dict[str, Any] | None)
sweep_account (dict[str, Any] | None)
agencies (dict[str, Any] | None)
disallow_e2_value (bool | None)
is_1099_reportable (dict[str, Any] | None)
personal_information (dict[str, Any] | None)
default_agency (dict[str, Any] | None)
naic_number (dict[str, Any] | None)
credit_score_account (dict[str, Any] | None)
agency_group (dict[str, Any] | None)
termination (dict[str, Any] | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.set_contact_system_tags(system_tags=None, contact_id=None, **kwargs)[source]

Set Contact System Tags.

POST /api/v2/contacts/set_contact_system_tags

Parameters:

system_tags (list[str] | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.set_quoting_permissions(states=None, policy_types=None, role=None, contact_id=None, **kwargs)[source]

Set Quoting Permissions.

POST /api/v2/contacts/set_quoting_permissions

Parameters:

states (str | None)
policy_types (str | None)
role (str | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.store_contact_gender(gender=None, contact_id=None, **kwargs)[source]

Store Contact Gender.

POST /api/v2/contacts/store_contact_gender

Parameters:

gender (str | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.update_contact_number(contact_id=None, **kwargs)[source]

Update Contact Number.

POST /api/v2/contacts/update_contact_number

Parameters:

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

Return type:

Any

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

Update Contacts.

POST /api/v2/contacts/update_contacts

Parameters:

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

Return type:

Any

britecore_sdk.api.api_calls.v2.contacts.validate_last_4_ssn_digits(last_4_ssn_digits=None, contact_id=None, **kwargs)[source]

Validate Last 4 Ssn Digits.

POST /api/v2/contacts/validate_last_4_ssn_digits

Parameters:

last_4_ssn_digits (str | None)
contact_id (str | None)
kwargs (Unpack[RequestParameters])

Return type:

Any