contacts

Method to lookup contacts by name.

Code
Searches for contacts by name for a particular role and contact type.
Returns all the contacts matching that criteria.

Parameters
----------
name : string
    Required. The name of the contact to look up. Example: 'John'.
role : string
    Required. Role name of the contact to look up. Example: 'Agent'.
role_type : string
    Required. Type of the contact to look up. Example: 'individual' or 'organization'.

Returns
-------
list:
    Returns list of dict containing Contact's data that matched the lookup criteria.

    Example contact dict:
        {
            id: UUID,
            name: str,
            extra: {
                agencyGroupNumber: str
                addresses: [dict],
                emailAddresses: [dict],
                phoneNumbers: [dict],
                company: dict,
                isWholeSaleModeAgency: boolean
            }
        }

Method to get address details.

Code
Takes zip code and optionally text address info and returns the Cities, Counties,
and State Abbr related to that Zip Code as determined by the Geography table.

Parameters
----------
zip : string
    Required. Zip code to look up. Example: '73401'.
addressLine1 : string
    Optional. Address to look up. Example: '123, White Lamp Boulevard'.

Returns
-------
valid : bool
    Whether or not the provided info is valid.
cities : list
    List of city names for the provided info.
counties : list
    List of county names for the provided info.
stateAbbr : string
    State abbreviation for the provided info.

Method to get Contact's aspect data.

Code
Takes contact id and role id for which aspects needs to be returned.
Most aspects are only returned in the response dict if applicable (or available).

Parameters
----------
id : UUID
    Required. Id of the contact to retrieve aspect data for.
roleId : UUID
    Required. Id of the role to retrieve aspect data for.
hasPermissions : boolean
    Required. Expected by internal processing. Must be set to true when called via API key.
all: boolean
    Optional. Retrieve all contact roles aspect data. Defaulted to false.

Returns
-------
disallowE2Val : boolean
    This flag shows if E2Value is disabled for the contact.
agencyInactive : boolean
    This flag shows if contact (which is agency) is inactive.
paycommissionto : string
    To whom comission will be paid to. Example: 'Agency'.
pagePermissionsExist : string
    Boolean in string format, used internally by the system.
mvrReports : list
    Motor vehicle reports for the contact. Only sent if MVR reports are active.
creditScoreAccountEnabled : boolean
    This flag suggests whether the creditScoreAccount aspect field should be considered.
creditReports : list
    Credit reports for the contact. Only sent if there is an active credit score vendor.
e2ValOn : boolean
    Flag for E2Value. Only sent if E2Value on vendor is enabled.
agencyGroupNumber : string
    Agency group number of the contact. Only sent if set.
agencyNumber : string
    Agency number of the contact. Only sent if set.
creditScoreAccount : string
    Credit score account of the contact. Only sent if set.
naicNumber : string
    NAIC number of the contact. Only sent if set.
producerNumber : string
    Producer number of the contact. Only sent if set.
vendorNumber : string
    Venfor number of the contact. Only sent if set.
is1099Reportable : boolean
    This flag suggests if 1099 is reportable, false by default. Only sent if set.
policies : list
    List of policies or apps associated with the contact for the passed role. Only sent if set.
associatedInfo : list
    List of policies or apps associated with the contact (not for the passed role).
agencyDates : dict
    Contains agencyInceptionDate and agencyTerminationDate. Only sent if set.
agencies : list
    List containing agencies to which contact is attached to. Only sent if set.
agencyGroup : dict
    Dict containing agency group information. Only sent if set.
defaultSurplusLinesProducer : dict
    Dict containing default_surplus_lines_producer details. Only set if set.
claims : list
    List containing all the claims that reference the contact as a claimant. Only sent if set.
commissionPayment : dict
    Dict containing information about commission payments issued by the contact. Only sent if set.
commissionStructure : dict
    Dict containing information about the contact's commission structure. Only sent if set.
surplusLinesProducerLicense: dict
    Dict containing information about surplus_lines_producer aspect. Only sent if set.
interestContent: dict
    Dict containing mortgagee statement used in dec page content. Only sent if set.
loginInformation : dict
    Dict containing the contact's login information (username, confirmation email, and permission level).
notices : dict
    Dict containing information about email notices for a contact. Only sent if set.
paymentsIssued: dict
    Dict containing information about payments issued to a contact. Only sent if set.
personalInformation : dict
    Dict containing a contact's personal information. Only sent if set.
sweepAccount: get_sweep_account,
    Dict containing information about the contact's sweep account. Only sent if set.
termination : dict
    Dict containing the terminated status and termination reason for the contact. Only sent if set.
quotingRestriction : dict
    Dict containing the contacts followAgencyQuotingRestriction flag. Only sent if set.

Method to get contacts list.

Code
Filters the contacts by search string and role filter along with pagination.
Returns all the contacts matching that criteria.

Parameters
----------
searchString : string
    Required. The search string to look up.
filter : string
    Required. The name of the role to filter against. Example: 'Agent'.
currentPage : string
    Required. The number of current page (stringified). Example: '1'.
pageSize : string
    Required. The size of page (stringified). Example: '10'.
nameFirst : bool
    Optional. When true, contacts whose name matches the search rank above the other
    matches, with ties ordered by name and then id.

Returns
-------
activePage : int
    Current page number. Example: 2
maxPages : int
    Total number of pages. Example: 17
maxRecords : int
    Total number of records matching the criteria. Example: 419
records : list
    List of dictionaries containing contact data.

    Example contact dict:
        {
            "flag": str,
            "type": str,
            "id": UUID,
            "details": {
                "name": str,
                "raw_addresses": list[dict],
                "phone": str,
                "role": str,
                "is_approved_vendor": boolean,
                "address": str,
                "email": str
            }
        }

Method to create new contact.

Code
Used by the simple contact popup used throughout the policies
and claims module. Creates a new contact and adds address, phone, and
email records. Sends back a JSON string containing the contact's id.
If applicable, a relationship is set up between a given revision
and the contact.

Parameters
----------
role : string
    Optional. The name of the role to add the new contact to. Example: 'Agent'.
content : dict
    Required. The following keys are expected:
        {
            'name': str,
            'type': str,
            'confirmationEmail': str,
            'legalEntityType': str,
            'website': str,
            'username': str,
            'isGod': boolean,
            'cognitoUsername': str,
            'dba': '2020-04-14',
            'purchaseDate': '2020-04-14',
            'riskIdNumber': str,
            'agencyId': UUID,
            'stateId': UUID,
            'licenseNumber': str,
            'ssn': 'str',
            'addedBy': str,
            'roles': [str],

            # Date of birth can be set via following 3 keys
            'dobMonth': '04',
            'dobYear': '2020',
            'dobDay': '14',
            # Alternatively, can be set directly via following key in the given format
            'dob': '2020-04-14',

            # Date business started can be set via following 3 keys
            'dbsYear': '2020',
            'dbsMonth': '04',
            'dbsDay': '14',
            # Alternatively, can be set directly via following key in the given format
            'dbs': '2020-04-14',
            # Or via following key
            'dateBusinessStarted': '2020-04-14',

            # Agency inception/termination date can be set via following 3 keys
            'agencyInceptionDateYear': '2019',
            'agencyInceptionDateMonth': '02',
            'agencyInceptionDateDay': '03',
            'agencyTerminationDateYear': '2020',
            'agencyTerminationDateMonth': '05',
            'agencyTerminationDateDay': '06',
            # Or directly via following key in the given format
            'agencyInceptionDate': '2019-02-03',
            'agencyTerminationDate': '2020-05-06',

            # Either of the following keys can be used to set FeinTax
            'feinTaxId': str,
            'feinTax': str,

            # following key can be alternatively passed as 'emails'
            'emailAddresses': [
                {
                    'email': str,
                    # following key can be alternatively passed as 'type'
                    'emailType': str
                }
            ],

            # following key can be alternatively passed as 'phones'
            'phoneNumbers': [
                {
                    'email': str,
                    # following key can be alternatively passed as 'type'
                    'phoneType': str
                }
            ],

            'addresses': [
                {
                    'addressLine1': str,
                    'addressCity': str,
                    'addressState': str,
                    'addressZip': str,
                    'addressCountry': str,
                    'addressCityOther': str,   # optional when country is not USA/Canada
                    'addressCountyOther': str, # optional when country is not USA/Canada
                    'addressStateOther': str,  # optional when country is not USA/Canada
                    'addressStateCanada': str, # optional when address provider is not google

                    # following key can be alternatively passed as 'type'
                    'addressType': str

                }
            ],
        }

Returns
-------
success : bool
    Whether or not the contact could be created.
id : UUID
    Id of the newly created contact
address_ids : list of UUID
    List containing id of created addresses

Method to update Contact's aspect data for a given role.

Code
Updates all aspects passed in the JSON belonging to the passed contact id.

Parameters
----------
contactId : UUID
    Required. The contact to update.
roleId : UUID
    Required. The role to update.
agencyInactive : boolean
    Optional.
e2ValDisallow : boolean
    Optional.
defaultAgency : UUID
    Optional. For setting an Agent Contact's default agency.
agencies : dict
    Optional. The following keys should be passed for updating Agency Relations.
        {
            'toDelete': [UUID,],  # Agency ids to remove
            'toAdd': [UUID,]      # Agency ids to add
        }
agencyDates : dict
    Optional. The following keys should be passed for updating Agency's dates.
    If both dates are provided, the termination date must not predate the inception.
        {
            'agencyInceptionDateYear': '2019',
            'agencyInceptionDateMonth': '02',
            'agencyInceptionDateDay': '03',
            'agencyTerminationDateYear': '2020',
            'agencyTerminationDateMonth': '05',
            'agencyTerminationDateDay': '06'
        }
agencyGroup : dict
    Optional. The following keys should be passed for updating Contact's Agency Group Relations.
        {
            'agencyGroupId': str,
            'belongsTo': boolean  # Whether or not contact belongs to an agency group
        }
agencyNumber : dict
    Optional. The following keys should be passed for setting Contact's Agency number.
        {
            'agencyNumber': str
        }
agencyGroupNumber : dict
    Optional. The following keys should be passed for setting Contact's Agency Group number.
        {
            'agencyGroupNumber': str
        }
creditScoreAccount : dict
    Optional. The following keys should be passed for setting Contact's Agency credit score integration account
    number.
        {
            'creditScoreAccount': str
        }
commissionPayment : dict
    Optional. The following keys should be passed for setting Contact's commission payment information.
        {
            'issueComPaymentsElectronically': boolean,
            'chosenCommissionAccount': UUID
        }
commissionStructure : dict
    Optional. The following keys should be passed for setting Contact's commission structure information.
        {
            'chosenStructure': str
        }
defaultSurplusLinesProducer : dict
    Optional. The following keys should be passed for setting Contact's default surplus lines producer.
        {
            'defaultSurplusLineProducerId': UUID
        }
interestContent : dict
    Optional. The following keys should be passed for setting Contact's interest content information.
        {
            'mortgageeStatement': str
        }
loginInformation : dict
    Optional. The following keys should be passed for setting Contact's login information.
        {
            'roleLoginUsername': str,
            'roleLoginPassword': str,
            'roleLoginRetypePassword': str,
            'roleLoginEmail': str,
            'roleLoginAccessLevel': UUID,
            'defaultState': UUID,
            'timezone': str,
            'oops': str
        }
naicNumber : dict
    Optional. The following keys should be passed for setting Contact's Agency NAIC number.
        {
            'naicNumber': str
        }
notices : dict
    Optional. The following keys should be passed for setting Contact's electronic notice information.
        {
            'directApplicationActivityOn': boolean,
            'acceptNoticesByEmail': boolean,
            'notifyOfOverdueInvoices': boolean,
            'emailPrintList': boolean,
            'displayAgencyGroupInfoOnDec': boolean,
            'ccEmail': str
            'directApplicationActivityTo': str,
            'sendCommissionsElectronically': boolean,

            # The following keys are optional
            'chosenEmail': UUID,
            'commStatementChosenEmail': UUID,
            'claimActivityChosenEmail': UUID,
            'ccClaimEmail': str,
            'agencyBillingEnabled': boolean,
            'doNotPrintWhenBillWhom': boolean
        }
paymentsIssued : dict
    Optional. The following keys should be passed for setting Contact's payments issued information.
        {
            'issuePaymentsElectronically': boolean,
            'chosenAccount': UUID
        }
personalInformation : dict
    Optional. The following keys should be passed for setting Contact's personal information.
        {
            'ssn': str,
            'ssnGroup': str,
            'dobMonth': '02',
            'dobDay': '10',
            'dobYear': '1990',
            'dbsMonth': '08',
            'dbsDay': '14',
            'dbsYear': '2013',
            'sameAsSsn': boolean, # driver license same as ssn
            'driversLicense': str,
            'legalEntityType': str,
            'riskIdNumber': str,
            'dba': str
        }
producerNumber : dict
    Optional. The following keys should be passed for setting Agent Contact's producer number.
        {
            'producerNumber': str
        }
quotingRestriction : dict
    Optional. The following keys should be passed for setting Agent Contact's quoting restriction settings.
        {
            'followAgencyQuotingRestriction': boolean
        }
sweepAccount : dict
    Optional. The following keys should be passed for setting Contact's sweep account information.
        {
            'hasSweepAccount': boolean,
            'chosenSweepAccount': UUID
        }
termination : dict
    Optional. The following keys should be passed for setting Agent Contact's termination status & reason.
        {
            'reasonTerminated': str,
            'isTerminated': boolean
        }
vendorNumber : dict
    Optional. The following keys should be passed for setting Contact's vendor number.
        {
            'vendorNumber': str
        }

Returns
-------
A list containing error messages; empty if there are no errors.

Add a date to remember. Body: {contact_id, date, frequency, contents, touchpoint?, alert_status, alert_time_period?, alert_time_unit?, alert_email?}; answers {contact_id, date_to_remember, meta}.

Add a producer or surplus lines producer licence (one list per contact, shown in both role box tables). Body: {contact_id, role_id, state_id, license_number}; answers the list, or licenses none when the viewer may write the role but not read it (the licence is added all the same). Adjuster licences are saved through create_adjuster_license and its siblings.

Add a role to the contact, as the classic Add Role popup does: by role id, with the popup's permission checks and notes. add_contact_to_role is the integrations' call by role name and does not change.

Associate an agency with the surplus lines producer contact_id (an agent stands for its agency), as classic's SLP role box does. Answers {contact_id, agencies, meta}; agencies is none when the viewer may write the role but not read it (the agency is associated all the same).

Adds a specified contact to the given role.

Code
Parameters
----------
contact_id : str
    UUID of the contact
role_name : str
    Role name to be associated with the contact

Returns
-------
success : bool
    Whether or not the role could appropriately be applied to the contact
messages : list
    List of human-readable error messages
data : dict
    Object with the following format.
    ::

        {
            "contact_id": "",
            "role_id": "",
            "role_name": ""
        }

Method to add agents to an agency

Code
Parameters
----------
member_id : str
    Required. contact id of Agent
agency_id : str
    Required. contact id of Agency
set_member_company: bool
    Optional. If true, set Agent's company field as the Agency as well. Default to false.

Returns
-------
success : bool
    True if successful, false if not
messages : list or str
    List of human-readable error messages

Archive a contact from the Contacts list; agents on current policies are refused.

Code
With permissions.protect-agency-contacts on, only an Administrator may archive an Agent, Agency or Agency Group
contact, as the other v2 contact writes (enable_or_disable_contact among them) are protected.
@protect_contact_records sits OUTSIDE @api_request: it returns (not raises) the permission-denied response, which
@api_request would otherwise wrap as the data of a successful response.

assign_policy_contact

assign_quote_contact

assign_risk_contact

Return true if the requested username is not taken by any contact.

Code
Parameters
----------
username : str
    Required.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: dict containing availability status
    {
        available: bool
    }

Replace the contact's Work phones, e-mails and website with its company's (copyContactInfoFromCompany).

Create a new adjuster license record.

Code
Parameters
----------
contact_id : str
    UUID of the contact
business_location_id : str
    UUID of the business location (state)
license_number : str
    License number (max 64 characters)
effective_date : str, optional
    Effective date in YYYY-MM-DD format
expiration_date : str, optional
    Expiration date in YYYY-MM-DD format

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : dict
    Created license record

Code
Creates a new contact.

The input and output formats of this function are defined by the JSON schemas
located at 'lib/api/api_specs/request-create_contact.json' and
'lib/api/api_specs/response-create_contact.json', respectively.

Every contact it creates gets the "Contact Created" note, as classic contact creation writes.

Get the current credit report for a given contact

Code
Parameters
----------
contact_id : UUID
    Required. Id of the contact
policy_type_id : UUID
    Optional. Specify the Policy Type currently quoted.
    If not provided, defaults to the Policy Type of one of the contact's active Policies.
    If not available, the integration point may not run.
revision_id : UUID
    Optional. The quote/revision the report is being pulled for. When sent, it must be live,
    name the contact as a named insured or additional interest, belong to `policy_id` when
    one is sent, and be filed under an agency the session user may act for, unless the session
    user created the revision or is its agent. Otherwise the request is refused with no pull.
    Callers without a quote context (for example the generic contacts screen) omit it and
    billing follows the session user.
policy_id : UUID
    Optional. The policy that revision belongs to, so a revision from another policy the
    same contact sits on cannot decide billing. Same bind Policy Setup uses.

Returns
-------
data: A dictionary with credit report, if successfully created. Fields may be null.
    ::

        {
            'id': UUID,
            'contact_id': UUID,
            'content': str,
            'date_added': date,
            'report_number': str,
            'score': str,
            'warning': str,
            'error': bool,
            'vendor_id': UUID,
            'billed_agency_id': UUID or None,
            'billed_agency_name': str or None,
            'billing_message': str or None
        }

success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages

Get the credit score threshold data on contacts that have existing credit reports

Code
Parameters
-----------
contact_ids : list
    Required. List of contact ids to validate credit score reports on.
ref_contact_id : str
    Required. UUID of the associate contact assigned with a limited score allowed

Returns
--------
success: bool
    True if successful, false if not
messages: list of str:
    List of human-readable error messages
data : dict
    Object with threshold information
    ::

        {
            "success" : bool
                True if all the given contacts pass the threshold
            "warnings": list
                A list of dictionaries consisting of `message` and `contact_id`
                [{
                    "message" : str
                        Failure message
                    "contact_id" : uuid
                        Contact ID
                }]
        }

Delete an adjuster license record.

Code
Parameters
----------
license_id : str
    UUID of the license to delete

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages

Remove one of the contact's dates to remember, with classic's note. Answers {contact_id, removed, meta}.

Enable or disable contact by archiving/un-archiving based on active flag.

Code
Parameters
----------
contact_id : UUID
    Required. ID of the contact
active : bool
    Optional. False by default. Flag to update contact active column accordingly

Returns
-------
success : bool
    True if successful, false if not
message : list of str
    List of human-readable error messages

Find insured using given params

Code
Parameters
----------
name : str
    Optional. Contact name (full or partial). If not provided, searches all contacts
role_name : str
    One of contact's roles (optional param, if None passed - won't filter)
dob : str
    Contact's DOB. Format is mm/dd/yyyy  (optional param, if None passed - won't filter)
exclude_roles : list of str
    Optional. List of role names to exclude from results
exclude_empty_usernames : bool
    Optional. If True, excludes contacts with empty usernames
requires_login_information : bool
    Optional. If True, only returns contacts whose roles have loginInformation aspect
page_size : int
    Optional. Maximum number of results to return (default: no limit)
use_database_search : bool
    Optional. If True, uses direct database LIKE query instead of ElasticSearch (default: False)
include_primary_address : bool
    Optional. If True, every result carries ``primary_address``: the contact's preferred address
    when it has a street line, else its first address with one (by type order), or null
    (default: False; the key is absent when not requested)
order_by_name : bool
    Optional. If True, the search order is deterministic: relevance first, then name
    (case-insensitive on ElasticSearch), then id. An empty name is therefore alphabetical.
    Requires ``page_size`` on ElasticSearch (a full scan is unordered).
    Not applied to ``use_database_search`` (default: False)

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list of dict
    List of contacts that meet search criteria
    ::
        [{
            "ssn_exist": true,
            "name": "John Doe",
            "roles": [
                "Insured Portal User",
                "Named Insured"
            ],
            "phones": [
                {
                    "date_updated": "2018-10-08 02:35:57",
                    "phone": "(111) 111-1111",
                    "type": "Home",
                    "id": "14aef33b-9fff-4b27-b139-d8d9dcd93c07",
                    "contact_id": "02a40e00-c72c-4fef-be3c-c46bc71910df"
                }
            ],
            "emails": [
                {
                    "date_updated": "2018-10-04 03:09:41",
                    "type": "Home",
                    "id": "da79df01-0bf1-464a-8a1c-61226823ca12",
                    "contact_id": "02a40e00-c72c-4fef-be3c-c46bc71910df",
                    "email": "a@a.com"
                }
            ],
            "id": "02a40e00-c72c-4fef-be3c-c46bc71910df",
            "primary_address": {
                "id": "5b0f3c4e-1d7a-4e1b-9d52-0c3f1f0a8e21",
                "type": "Mailing/Billing",
                "street": "100 Main St",
                "line2": "",
                "city": "Springfield",
                "county": "Greene",
                "state": "MO",
                "zipcode": "65802",
                "country": "USA",
                "attention": "",
                "is_preferred": true
            }
        }]

    ``primary_address`` is only present when ``include_primary_address`` is True.

generate_contact_number

Get aspect data

Code
Parameters
----------
id : UUID
    Required. Id of the contact to retrieve aspect data for.
role_id : UUID
    Required. Id of the role to retrieve aspect data for.
has_permissions : boolean
    Required. Expected by internal processing. Must be set to true when called via API key.
all: boolean
    Optional. Retrieve all contact roles aspect data. Defaulted to false.

Returns
-------
success : bool
    Whether or not aspect data settings are found
messages : list of str
    List of human-readable error messages
data : dict
    Dict containing aspect data settings.

Get all aspect data settings

Code
Returns
-------
success : bool
    Whether or not aspect data settings are found
messages : list of str
    List of human-readable error messages
data : dict
    Dict containing aspect data settings.

Retrieve contact_id by id.

Code
Parameters
----------
contact_id : str
    Required. Contact id to retrieve

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: dict containing contact

Code
Retrieve associations of contacts with revisions and properties,
filtered by contact IDs and optionally by policy type IDs.

This API allows consumers to look up revision and property associations for a list of contact IDs,
potentially restricted by policy types.

Parameters
----------
contact_ids : list of str, required
    A list of contact IDs to retrieve associations for.
policy_type_ids : list of str, optional
    Optional list of policy type IDs to restrict queried revisions and properties.

Returns
-------
success : bool
    True if the query was successful, False otherwise.
messages : list of str
    List of messages detailing any errors encountered during execution.
data : dict
    A nested dictionary containing associations under keys "contacts" and "properties",
    with detailed information for each.

get_contact_by_agency

get_contact_by_agency_group

get_contact_by_agent

Retrieve contact by cognito username.

Code
Parameters
----------
cognito_username : str
    Required. Cognito username to search for.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: dict containing contact data that corresponds with the referred cognito_username
    Example contact data:
        {
            contact: {
                contactId: UUID,
                name: str,
                roles: [str],
                addresses: dict,
                phones: dict,
                emails: dict,
                website: str,
                dob: str,
                agencies: [dict]
            }
        }

Returns contact data of which credentials are passed.

Code
Parameters
----------
username : str
    Required. The username of the contact to be migrated.
password : str
    Required. The password of the contact to be migrated.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: dict containing contact data
    Example contact data:
        {
            contact: {
                contactId: UUID,
                name: str,
                confirmationEmail: str,
                phoneNumber: str, # (the first phone number from the contact)
                roles: [str], # (only the roles names)
                timezone: str,
                photoId: str,
                username: str,
                cognitoUsername: str
            }
        }

Return contact data of a contact with matching username or email id for migration to BriteAuth.

Code
This endpoint is used in following couple of scenarios:
    - During "Forgot Password" flow of BriteAuth user migration
    - During "User Invite" to find existing contact by confirmation email

Consider using a generic contact search endpoint for other use cases.

Parameters
----------
search_str : str
    Required. Username or email id of the contact to be migrated.

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: dict containing contact data
    Example contact data:
        {
            contact: {
                contactId: UUID,
                name: str,
                confirmationEmail: str,
                phoneNumber: str, # (the first phone number from the contact)
                roles: [str], # (only the roles names)
                timezone: str,
                photoId: str,
                username: str,
                cognitoUsername: str
            }
        }

Retrieve contacts by id.

Code
Parameters
----------
contact_id_list: list
    Required. List of Contact ids to retrieve

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: dict containing contacts

The contact's MFA key, on the Security tab's explicit Show; a contact with none gets one, as classic's tab makes one. Logged without the key, and never cached.

Retrieve payment methods by id.

Code
Parameters
----------
payment_method_ids: list
    Required. List of payment method ids to retrieve

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data: list of dict
    List of dictionaries containing payment method data

The Configuration tab's read (classic getContactBusinessLocation and getContactBusinessLocationWithUniquePolicyTypes): the role the tab edits, the states the contact may quote in and those it may add, each state's policy types open and closed to quoting by name, and whether the viewer may change them.

Get a resource's producer id.

Code
The producer of a resource can be an agent or an agency depending on the `policy-go-to` advanced setting.

Parameters
----------
revision_id : UUID
    Optional. Id of the revisions whose producer is required.
policy_id : UUID
    Optional. Id of the policy whose latest revision's producer is required.

Returns
-------
success : bool
    Whether or not a producer could be found
messages : list of str
    List of human-readable error messages
data : dict
    Dict containing producer id.
    Example :
        {
            "producer_id": "CONTACT-UUID"
        }

Code
Get screening history for a contact.

Returns screening check results, plus a lookup of contacts that have applied overrides.

Parameters
----------
contact_id : str
    ID of the contact

Returns
-------
dict
    Dictionary with 'contact_screening_check_results' (list of screening records) and
    'override_contacts' (list of contacts that have applied overrides)

Links the given contact to the Cognito username specified in the request.

Code
This endpoint also sets contact username if its not set.

Parameters
----------
contact_id : str
    Required. ID of the contact to be linked.
cognito_username : str or None
    Required. Cognito username to which contact will be linked. If it is None, the contact will be unlinked.

Returns
-------
success : bool
    Whether or not the contact could be linked.
messages : list of str
    List of human-readable error messages.

The roles the viewer may add to the contact (the Add Role list), by the rule add_contact_role checks: classic's popup list (not held, the contact's type, one Primary Carrier, Tenant only with its setting), known to the page, whose rule the viewer may read. Answers {contact_id, roles: [{id, name}]}.

list_all_contacts

List contacts by partial role code using prefix matching.

Code
Supports partial lookup on agency_number, agency_group_number,
or producer_number with a minimum 5-character filter.

Parameters
----------
payload : dict
    role : str
        The role type to search. One of 'agency', 'agency_group', 'agent'.
    filter : str
        The prefix to match against the role code.
        Minimum 5 characters after trimming whitespace.
    limit : int, optional
        Maximum number of results to return (1-50). Defaults to 50.

Returns
-------
list[dict]
    List of matching contacts with id, name, and role code fields.

List credit reports available for the given contact

Code
Parameters
----------
contact_id : UUID
    Required. Id of the contact

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list of dict
    A list of dictionary entries, of the following format:
    ::
        {
            'id': UUID,
            'score': str,  # score value
            'warning': str,  # warning value
            'date': str,  # (representation of a date MM-DD-YYYY),
            'has_content': bool  # Indicates whether the content (pdf report) is available
        }

List emails available for the given contact

Code
Parameters
----------
contact_id : UUID
    Required. Id of the contact

Returns
-------
success : bool
    True if successful, false if not
messages : list of str
    List of human-readable error messages
data : list of dict
    A list of dictionary entries, of the following format:
    ::
        {
            'id': UUID,
            'email': str,
            'type': str,  # Home, Work, Other
        }

The cities, counties and state for a zip code, as the classic address popup looks them up.

Code
Updates an existing contact.

The input and output formats of this function are defined by the JSON schemas
located at 'lib/api/api_specs/request-modify_contact.json' and
'lib/api/api_specs/response-modify_contact.json', respectively.