Topics on this page

Manage contacts: Agents, agencies, and insureds

Insurance companies require a contact management system that stores and updates information about any entity, business, or individual associated with the insurance company to ensure accuracy and security.

BriteCore’s Contacts module provides a single, centralized repository of customer information that’s shared across the BriteCore platform; it also prevents duplication of contacts through rules, SSN matching, and support tools to merge duplicate contacts.

BriteCore’s Contacts module offers a robust contact management system that lets you:

  • Create, edit, view, and remove individual and organization contacts.
  • Associate one contact to another through relationships.
  • Establish system notifications or reminders for important dates via the Dates to Remember feature.
  • Assign or remove roles from existing contacts. For BriteCore users, roles can determine permission level.
  • Configure states and lines of business that agency contacts can write policies under.
  • Add and associate payment methods with a contact.
  • Maintain account security with multi-factor authentication and passphrases.
  • Associate notes and alerts with specific contacts. Alerts will generate emails to designated email addresses on indicated date or event occurrence.
  • Manage files efficiently at the contact level.
  • Employ robust search logic that generates search results by contact name, address, phone number, email, and filters by contact role.
  • Sync contact information entered at any point during the policy or claim lifecycle, store contact information, and export contact information when adding a contact during the policy or claim lifecycle.
  • Prevent duplicate contacts through the use of rules and SSN matching.
  • Enter and track customer interactions and conversation history.

Figure 1 illustrates the Contacts module, broken down by the type of information available and API lookups.

Figure 1: Contacts module.

In this tutorial, will guide you through creating, updating, and retrieving contacts and related information.

Manage your contacts using BriteAPIs

Note: Blocks of code are hidden by default to make the page more navigable. Select View code and Hide code to view or hide these sections as needed.

Step 1: Get a security token

You will need to request an ID and Secret to use OAuth 2.0.

For more information, refer to How do I get started?

Step 2: Create a contact

Use the new_contact endpoint (/contacts/new_contact/) to create a new contact and enter related contact information (optional).

Sample code

View code
curl--location--request POST 'https://client.britecorepro.com/api/v2/contacts/new_contact'\
	--header 'Content-Type: application/json'\
	--data - raw '{
"api_key": "",
"name": "Test Agency Inc",
"doing_business_as": "TA Inc.",
"type": "organization",
"phones": [{
	"phone": "1-111-1111",
	"type": "Work"
}],
"emails": [{
	"email": "person@domain.com",
	"type": "Work"
}],
"addresses": [{
	"address_line1": "123 Main",
	"address_city": "Springfield",
	"address_state": "MO",
	"address_zip": "12345",
	"address_country": "USA",
	"type": "Mailing/Billing"
}],
"roles": [
	"Agency"
]
}

Sample response

View code
{
  "data": {
    "phones": [
      {
        "phone": "1-111-1111",
        "type": "Work",
        "id": "c9167f88-9b1e-4cd5-9f52-374fbd1e00e6"
      }
    ],
    "addresses": [
      {
        "address_city": "Springfield",
        "address_line1": "123 Main",
        "address_state": "MO",
        "type": "Mailing/Billing",
        "address_county": null,
        "address_country": "USA",
        "id": "20553542-74dc-4f4a-9549-c40d4aacd69a",
        "address_zip": "12345"
      }
    ],
    "contact_id": "42e654cb-1f3d-45dc-a014-4e472240b69f",
    "emails": [
      {
        "type": "Work",
        "id": "9e71d4c3-41f3-43f8-9aae-8727a0836596",
        "email": "person@domain.com"
      }
    ]
  },
  "messages": [],
  "success": true
}

Step 3: Retrieve contact list

The retrieveContactList endpoint (/contacts/retrieveContactList) to retrieve contacts matching a search criteria. You will need the contact_id for a specific contact from this response for the next step.

Sample code

View code
curl --location --request POST '<client_url>/api/v2/contacts/'retrieveContactList \
--header 'Content-Type: application/json' \
--data-raw '{ 
	"api_key": "",
	"contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad"
}'

Sample response

View code
 "raw_addresses":[
          
        ],
        "phone":"",
        "role":"Agent",
        "is_approved_vendor":"",
        "address":"",
        "email":""
      }
    },
    {
      "flag":"white",
      "type":"individual",
      "id":"51b137ec-05a1-46b4-b4d6-f67716c4ae8e",
      "details":{
        "name":"TestAgent8",
        "raw_addresses":[
          
        ],
        "phone":"",
        "role":"Agent",
        "is_approved_vendor":"",
        "address":"",
        "email":""
      }
    },
    {
      "flag":"white",
      "type":"individual",
      "id":"8ceff328-80ec-4c48-831a-69ff03f96ab1",
      "details":{
        "name":"Zachary Saplan",
        "raw_addresses":[
          
        ],
        "phone":"",
        "role":"Administrator, Agency, Agent",
        "is_approved_vendor":"",
        "address":"",
        "email":"zach.saplan@britecore.com"
      }
    }
  ]
}

Step 4: Retrieve contact data

The get_contact endpoint (/contacts/get_contact) to retrieve specific contact information using contact_id. You can obtain the contact_id from step 3. contact_id is a required field in this call.

Sample request

View code
curl --location --request POST '<client_url>/api/v2/contacts/get_contact' \
--header 'Content-Type: application/json' \
--data-raw '{ 
	"api_key": "",
	"contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad"
}'

Sample response

View code
{
  "data": {
    "display_agency_group_info_on_dec": false,
    "mfa": false,
    "disallow_e2_val": false,
    "background": null,
    "dba": "",
    "cc_email_notices": null,
    "date_business_started": null,
    "email_print_list": false,
    "agency_number": null,
    "has_sweep_account": false,
    "commission_account_id": null,
    "direct_application_activity_to": null,
    "timezone": null,
    "phones": [],
    "sweep_account_id": null,
    "ssn_group": null,
    "id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",
    "issue_payments": false,
    "terminated": false,
    "default_agency_id": null,
    "same_as_ssn": false,
    "info_for_new_payment_method": {
      "cards": {
        "AmericanExpress": true,
        "VISA": true,
        "Discover": true,
        "MasterCard": true
      },
      "options": {
        "ach": false,
        "avs": true,
        "cvv2": true
      }
    },
    "cognito_username": null,
    "agency_billing_enabled": false,
    "notify_of_overdue_invoices": false,
    "portal_code": "429721",
    "photo_id": null,
    "vendor_number": null,
    "last_login": null,
    "producer_number": null,
    "issue_commission_payments": false,
    "is_god": false,
    "api_key": null,
    "type": "individual",
    "purchase_date": null,
    "website": "",
    "risk_id_number": "",
    "notice_email_id": null,
    "follow_agency_quoting_restriction": true,
    "termination_reason": null,
    "system_tags": null,
    "agency_inactive_timestamp": null,
    "agency_inactive": false,
    "password_attempts": 0,
    "emails": [],
    "flag": "white",
    "ssn": "",
    "date_updated": "2019-09-19 13:37:02",
    "mfa_code": null,
    "drivers_license": null,
    "position": null,
    "active": true,
    "date_added": "2019-09-19 13:37:02",
    "password": null,
    "fein_tax": "",
    "cc_claim_email_notices": null,
    "oops_email": null,
    "email_notices": false,
    "claim_activity_email_id": null,
    "accept_electronic_comm_statement": false,
    "addresses": [
      {
        "address_line2": "",
        "address_city": "New Orleans",
        "address_line1": "1010 Oak Lane",
        "type_label": "",
        "date_updated": "2019-09-19 13:37:02",
        "type": "Mailing/Billing",
        "address_county": "Orleans",
        "contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",
        "longitude": 0,
        "attention": "",
        "address_state": "LA",
        "latitude": 0,
        "address_country": "USA",
        "id": "a6ea00e4-180a-4486-af34-b2121e8aac55",
        "address_zip": "70117"
      }
    ],
    "confirmation_email": null,
    "name": "Joe Test",
    "naic_number": "",
    "dob": null,
    "permission_level_id": null,
    "credit_score_account": null,
    "issue_payments_account_id": null,
    "payment_methods": [],
    "username": null,
    "terms_conditions_accepted": false,
    "commission_structure": null,
    "mortgagee_statement": null,
    "legal_entity_type": "",
    "mfa_counter": 0,
    "comm_statement_email_id": null,
    "default_state_id": null,
    "do_not_print_when_bill_whom": false
  },
  "messages": [
    "Retrieved contact information."
  ],
  "success": true
}

Step 5: Retrieve contact billing information

You can retrieve more contact data using retrieve_contact_information. contact_id is required. Save the payment_method_id from the response payload for Step 8.

Sample request

View code
curl --location --request POST '<client_url>/api/v2/insured/retrieve_contact_information' \
--header 'Content-Type: application/json' \
--data-raw '{ 
	"api_key": "",
	"contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad"
}'

Sample response

View code
{
  "data": {
    "display_agency_group_info_on_dec": false,
    "mfa": false,
    "disallow_e2_val": false,
    "background": null,
    "dba": "",
    "cc_email_notices": null,
    "date_business_started": null,
    "email_print_list": false,
    "agency_number": null,
    "has_sweep_account": false,
    "commission_account_id": null,
    "direct_application_activity_to": null,
    "timezone": null,
    "phones": [],
    "sweep_account_id": null,
    "ssn_group": null,
    "id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",
    "issue_payments": false,
    "policies": [
      {
        "submit_bound": false,
        "copied_to_rev_id": null,
        "date_updated": "2019-09-26 07:08:09",
        "policy_term": {
          "manual_reason": null,
          "override_min_amount_due": null,
          "date_updated": "2019-09-26 10:35:52",
          "generate_pre_pay_schedule": false,
          "bill_sched_id": "7d3461be-f426-4ba5-8a14-82cc2af82689",
          "first_address_used_id": null,
          "renewal_status": "Renew",
          "email_used_id": null,
          "is_renewal": false,
          "term_type": "3 Months",
          "id": "56d40418-4928-41d6-adcc-a08fc5d9dcff",
          "auto_pay_days_before": 0,
          "term_length": 92,
          "renewal_status_description": null,
          "renewal_type": null,
          "first_bill_whom_id": null,
          "effective_date": "2019-08-01",
          "renewal_status_reason_id": null,
          "first_email_used_id": null,
          "term_credit_score": null,
          "address_used_id": "a6ea00e4-180a-4486-af34-b2121e8aac55",
          "auto_payment_method_id": null,
          "has_write_off": false,
          "policy_term_number": "",
          "first_payment_method_id": null,
          "expiration_date": "2019-11-01",
          "bill_whom_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",
          "first_bill_checked": false,
          "force_comm_recalc": false,
          "policy_id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9"
        },
        "ar_details": {
          "next_due": "0.00",
          "due_date": "10/01/2019",
          "previous_due": "0.00",
          "next_due_date": "--",
          "current_due": "23.00",
          "cancel_date": "10/16/2019",
          "canceled_on_date": null,
          "show_unbilled_amounts": false
        },
        "inception_date": "2019-08-01",
        "policy_group_id": null,
        "submit_receipt_email": null,
        "current_due": "23.00",
        "id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9",
        "rewritten": false,
        "policy_number": "10-2019-181",
        "payoff_amount": "23.00",
        "submit_confirm_name": null,
        "show_app": true,
        "do_not_automatically_rewrite": false,
        "billing_schedules": [
          {
            "automatic_payment_reminder": false,
            "billing_schedule": "Annual",
            "id": "7d3461be-f426-4ba5-8a14-82cc2af82689"
          }
        ],
        "revision": {
          "last_visited": null,
          "create_date": "2019-09-30 09:28:44",
          "date_updated": "2019-10-01 20:21:15",
          "review_workflow_state": "NOT_STARTED",
          "underwriting_questions": null,
          "policy_type_id": "af706bcf-b569-4c72-a041-215a709e3f2a",
          "revision_state": "committed",
          "id": "3895aba8-7251-451e-b9d7-d0d036a3b5c7",
          "builder_pending": false,
          "primary_property_id": "85c6eab2-7ca8-4cf2-84f9-c3d09e86d7ae",
          "annual_fee": 0,
          "policy_status_reason_id": null,
          "grant_mortgagee_extension": false,
          "written_fee": 0,
          "revision_date": "2019-08-01",
          "annual_premium": 523,
          "policy_type": "Builders' Risk Single Shot",
          "print_dec": true,
          "review_workflow_request_reason": null,
          "underwriting_options": null,
          "description": null,
          "deleted": false,
          "credit_report_permissions": null,
          "override_commission": false,
          "written_premium": 523,
          "policy_status": "Active",
          "date_archived": null,
          "cancel_date": null,
          "dec_description": null,
          "commission_rate": 0,
          "commit_date": "2019-10-01",
          "policy_term_id": "56d40418-4928-41d6-adcc-a08fc5d9dcff",
          "underwriting_contact_date": null,
          "builder_ready_to_rate": false,
          "reinstate_at_commit": false,
          "underwriting_contacted": false,
          "policy_id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9"
        },
        "account_history": {
          "records": [
            {
              "fileKey": null,
              "amount": 500,
              "icon": "",
              "date": "10/01/2019",
              "data": {
                "amount": 500,
                "premiumOverview": {
                  "debitCustomFeeProRata": 0,
                  "revisionWrittenFee": 0,
                  "debitCustomFeeFullyEarned": 0,
                  "revisionWrittenPremium": 523,
                  "revisionAnnualFee": 0,
                  "revisionAnnualPremium": 523,
                  "paymentAmount": 500,
                  "debitPremiumFullyBilled": 0,
                  "customFeesBilled": 0,
                  "premiumBilled": 523,
                  "debitSystemFee": 0,
                  "debitPremiumFullyEarned": 0,
                  "debitPremiumProRata": 523,
                  "payoffAmount": 23,
                  "debitCustomFeeFullyBilled": 0
                },
                "details": {
                  "showDelete": true,
                  "generatedBy": "IWS_jamiesteward",
                  "payor": "Joe Test",
                  "description": "Underpaid by $23.00.",
                  "sweepCheckNumber": null,
                  "paymentAmount": "500.00",
                  "paymentStatus": "Complete",
                  "nsf": false,
                  "policyStatus": "Active",
                  "nsfFee": "10.00",
                  "showEditAndReprint": false,
                  "dirty": false,
                  "showWaive": false,
                  "paymentInterface": "Check",
                  "paymentId": "0c4f9b7d-96ef-4862-bf34-5278b8a0359e",
                  "confirmationNumber": "56711569979937",
                  "paymentMethod": "Check 213"
                }
              },
              "balance": "23.00",
              "type": "Payment",
              "id": "45f88f35-1b2d-47c7-892c-212daf885186",
              "summary": "Underpaid by $23.00."
            },
            {
              "fileKey": "f8634205-1585-496f-94cd-057774fbfaaf",
              "amount": 523,
              "icon": "view",
              "date": "10/01/2019",
              "data": {
                "amount": 523,
                "schedule": {
                  "Premium": 523,
                  "Installment Fee": 0,
                  "Custom Fees": 0
                },
                "details": {
                  "showDelete": false,
                  "cancelDate": "10/16/2019",
                  "paidInFull": false,
                  "billDate": "10/01/2019",
                  "description": "Installment Invoice",
                  "generatedBy": "IWS_jamiesteward",
                  "policyStatus": "Active",
                  "showEditAndReprint": true,
                  "dirty": false,
                  "showWaive": false,
                  "dueDate": "10/01/2019"
                }
              },
              "balance": "523.00",
              "type": "Invoice",
              "id": "f6ebe73b-e32c-423f-a0cf-187eb55d7613",
              "summary": "Installment Invoice"
            }
          ],
          "max_pages": 1,
          "active_page": 1
        },
        "system_tags": null,
        "current_term": {
          "manual_reason": null,
          "override_min_amount_due": null,
          "date_updated": "2019-09-26 10:35:52",
          "generate_pre_pay_schedule": false,
          "bill_sched_id": "7d3461be-f426-4ba5-8a14-82cc2af82689",
          "first_address_used_id": null,
          "renewal_status": "Renew",
          "email_used_id": null,
          "is_renewal": false,
          "term_type": "3 Months",
          "id": "56d40418-4928-41d6-adcc-a08fc5d9dcff",
          "auto_pay_days_before": 0,
          "term_length": 92,
          "renewal_status_description": null,
          "renewal_type": null,
          "first_bill_whom_id": null,
          "effective_date": "2019-08-01",
          "renewal_status_reason_id": null,
          "first_email_used_id": null,
          "term_credit_score": null,
          "address_used_id": "a6ea00e4-180a-4486-af34-b2121e8aac55",
          "auto_payment_method_id": null,
          "has_write_off": false,
          "policy_term_number": "",
          "first_payment_method_id": null,
          "expiration_date": "2019-11-01",
          "bill_whom_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",
          "first_bill_checked": false,
          "force_comm_recalc": false,
          "policy_id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9"
        },
        "flag": "white",
        "agent": {
          "phones": [],
          "addresses": [
            {
              "address_line2": "",
              "address_city": "Canton",
              "address_line1": "221b Baker Street",
              "address_state": "CT",
              "type": "Mailing/Billing",
              "address_zip": "06019"
            }
          ],
          "id": "c0e9a609-deed-4552-bea4-0d2ca1ed3543",
          "emails": [],
          "name": "Agent Shona"
        },
        "claims": [
          {
            "date_updated": "2019-10-01 20:25:38",
            "cat_id": null,
            "loss_address_line1": null,
            "additional_information": {},
            "loss_address_line2": null,
            "county": null,
            "loss_address_listed": true,
            "loss_address_state": null,
            "subrogation_reserve": 0,
            "id": "3e238c05-221b-4d03-a068-401d0e082b2a",
            "loss_date": null,
            "iso_transaction_type": "individual",
            "type": "property",
            "salvage_reserve": 0,
            "status": "Open, Standard",
            "description": null,
            "loss_address": {
              "addressState": "LA",
              "countySpecification": "",
              "addressCounty": "55dd70fe-e778-43e3-9171-ed804cf65d8b",
              "addressLine2": null,
              "addressLine1": "306 E Miller Ave",
              "addressCity": "Iowa",
              "addressZip": "70647"
            },
            "system_tags": null,
            "type_manual": false,
            "loss_address_city": null,
            "flag": "white",
            "last_modified": "2019-10-01",
            "active": true,
            "date_added": "2019-10-01 20:22:30",
            "reinsurance_reserve": 0,
            "dual_masthead": false,
            "county_specify": null,
            "last_rein_report_date": null,
            "reinsurance_monitor_status": "system-off",
            "claim_number": "20-2019-83",
            "loss_address_zip": null,
            "loss_address_id": "85c6eab2-7ca8-4cf2-84f9-c3d09e86d7ae",
            "policy_id": "1c6dcb65-06c2-4996-806c-bef46cd5b6a9"
          }
        ],
        "active": true,
        "date_added": "2019-09-26 06:59:55",
        "properties": [
          {
            "replace_loss": null,
            "property_val": null,
            "date_updated": "2019-10-01 11:58:14",
            "photo": null,
            "inspection_requested_date": null,
            "county_specify": "",
            "address_state": "LA",
            "protection_class_id": null,
            "hydrant_distance": 1000,
            "id": "85c6eab2-7ca8-4cf2-84f9-c3d09e86d7ae",
            "address_line2": null,
            "annual_fee": 0,
            "address_line1": "306 E Miller Ave",
            "replacement_cost_value": null,
            "copy_address": false,
            "iso_pc_data": null,
            "address_country": "USA",
            "written_fee": 0,
            "risk_data": null,
            "loss_history_report_content": null,
            "annual_premium": 523,
            "latitude": 30.245912,
            "type": null,
            "replace_contents": null,
            "address_accuracy": "great",
            "deleted": false,
            "address_county": "55dd70fe-e778-43e3-9171-ed804cf65d8b",
            "written_premium": 523,
            "approved_limits": null,
            "flag": "white",
            "fire_district_distance": 0,
            "loss_history_report_number": null,
            "date_added": "2019-09-26 06:59:55",
            "revision_id": "3895aba8-7251-451e-b9d7-d0d036a3b5c7",
            "inspection_vendor": null,
            "address_zip": "70647",
            "address_city": "Iowa",
            "prefill_services_data": null,
            "year_built": null,
            "name": "Property 1",
            "gross_area": null,
            "date_added_micro": 145470,
            "longitude": -93.010953,
            "next_inspection_date": null,
            "stories": null,
            "builder_ready_to_rate": false,
            "replace_other": null
          }
        ],
        "policy_number_origin": "v1",
        "submit_confirm_email": null,
        "sequence_id": null,
        "submit_receipt_name": null,
        "policy_number_normalized": "102019181",
        "copied_from_rev_id": null
      }
    ],
    "terminated": false,
    "default_agency_id": null,
    "same_as_ssn": false,
    "info_for_new_payment_method": {
      "cards": {
        "AmericanExpress": true,
        "VISA": true,
        "Discover": true,
        "MasterCard": true
      },
      "options": {
        "ach": false,
        "avs": true,
        "cvv2": true
      }
    },
    "cognito_username": null,
    "agency_billing_enabled": false,
    "perils": [
      {
        "date_updated": "2019-07-08 15:02:06",
        "code": "01",
        "id": "42cd7ffd-a1bb-11e9-b3ca-121d960b34c0",
        "name": "Accidental Discharge/Leakage",
        "aplus_code": "ACCDL"
      },
      {
        "date_updated": "2019-07-08 15:02:06",
        "code": "02",
        "id": "42cd8196-a1bb-11e9-b3ca-121d960b34c0",
        "name": "Appliance Related Water",
        "aplus_code": "APPL"
      },
],
    "notify_of_overdue_invoices": false,
    "portal_code": "429721",
    "photo_id": null,
    "vendor_number": null,
    "last_login": null,
    "producer_number": null,
    "issue_commission_payments": false,
    "is_god": false,
    "api_key": null,
    "type": "individual",
    "purchase_date": null,
    "website": "",
    "risk_id_number": "",
    "notice_email_id": null,
    "follow_agency_quoting_restriction": true,
    "termination_reason": null,
    "system_tags": null,
    "agency_inactive_timestamp": null,
    "agency_inactive": false,
    "password_attempts": 0,
    "emails": [],
    "flag": "white",
    "ssn": "",
    "date_updated": "2019-09-19 13:37:02",
    "mfa_code": null,
    "drivers_license": null,
    "position": null,
    "active": true,
    "date_added": "2019-09-19 13:37:02",
    "password": null,
    "fein_tax": "",
    "cc_claim_email_notices": null,
    "oops_email": null,
    "email_notices": false,
    "claim_activity_email_id": null,
    "accept_electronic_comm_statement": false,
    "addresses": [
      {
        "address_line2": "",
        "address_city": "New Orleans",
        "address_line1": "1010 Oak Lane",
        "type_label": "",
        "date_updated": "2019-09-19 13:37:02",
        "type": "Mailing/Billing",
        "address_county": "Orleans",
        "contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",
        "longitude": 0,
        "attention": "",
        "address_state": "LA",
        "latitude": 0,
        "address_country": "USA",
        "id": "a6ea00e4-180a-4486-af34-b2121e8aac55",
        "address_zip": "70117"
      }
    ],
    "confirmation_email": null,
    "name": "Joe Test",
    "naic_number": "",
    "dob": null,
    "permission_level_id": null,
    "credit_score_account": null,
    "issue_payments_account_id": null,
    "payment_methods": [],
    "username": null,
    "terms_conditions_accepted": false,
    "commission_structure": null,
    "mortgagee_statement": null,
    "legal_entity_type": "",
    "mfa_counter": 0,
    "comm_statement_email_id": null,
    "default_state_id": null,
    "do_not_print_when_bill_whom": false
  },
  "messages": [
    "Retrieved contact information."
  ],
  "success": true
}

Step 6: Retrieve complete insured contact information using a search parameter

The get_complete_contact_information endpoint retrieves insured contact information using a search parameter.

Sample request

View code
curl --location --request POST '<client_url>/api/v2/insured/get_complete_contact_information' \
--header 'Content-Type: application/json' \
--data-raw '{ 
	"api_key": "",
	"contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",
	"filter_values": ["contact"]
}'

Sample response

View code
{
  "data": {
    "contact": {
      "display_agency_group_info_on_dec": false,
      "mfa": false,
      "disallow_e2_val": false,
      "background": null,
      "dba": "",
      "cc_email_notices": null,
      "date_business_started": null,
      "email_print_list": false,
      "agency_number": null,
      "has_sweep_account": false,
      "commission_account_id": null,
      "direct_application_activity_to": null,
      "timezone": null,
      "phones": [],
      "sweep_account_id": null,
      "ssn_group": null,
      "id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",
      "issue_payments": false,
      "terminated": false,
      "default_agency_id": null,
      "same_as_ssn": false,
      "info_for_new_payment_method": {
        "cards": {
          "AmericanExpress": true,
          "VISA": true,
          "Discover": true,
          "MasterCard": true
        },
        "options": {
          "ach": false,
          "avs": true,
          "cvv2": true
        }
      },
      "cognito_username": null,
      "agency_billing_enabled": false,
      "perils": [
        {
          "date_updated": "2019-07-08 15:02:06",
          "code": "01",
          "id": "42cd7ffd-a1bb-11e9-b3ca-121d960b34c0",
          "name": "Accidental Discharge/Leakage",
          "aplus_code": "ACCDL"
        },
        {
          "date_updated": "2019-07-08 15:02:06",
          "code": "02",
          "id": "42cd8196-a1bb-11e9-b3ca-121d960b34c0",
          "name": "Appliance Related Water",
          "aplus_code": "APPL"
        },
],
      "notify_of_overdue_invoices": false,
      "portal_code": "429721",
      "photo_id": null,
      "vendor_number": null,
      "last_login": null,
      "producer_number": null,
      "issue_commission_payments": false,
      "is_god": false,
      "api_key": null,
      "type": "individual",
      "purchase_date": null,
      "website": "",
      "risk_id_number": "",
      "notice_email_id": null,
      "follow_agency_quoting_restriction": true,
      "termination_reason": null,
      "system_tags": null,
      "agency_inactive_timestamp": null,
      "agency_inactive": false,
      "password_attempts": 0,
      "emails": [],
      "flag": "white",
      "ssn": "",
      "date_updated": "2019-09-19 13:37:02",
      "mfa_code": null,
      "drivers_license": null,
      "position": null,
      "active": true,
      "date_added": "2019-09-19 13:37:02",
      "password": null,
      "fein_tax": "",
      "cc_claim_email_notices": null,
      "oops_email": null,
      "email_notices": false,
      "claim_activity_email_id": null,
      "accept_electronic_comm_statement": false,
      "addresses": [
        {
          "address_line2": "",
          "address_city": "New Orleans",
          "address_line1": "1010 Oak Lane",
          "type_label": "",
          "date_updated": "2019-09-19 13:37:02",
          "type": "Mailing/Billing",
          "address_county": "Orleans",
          "contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",
          "longitude": 0,
          "attention": "",
          "address_state": "LA",
          "latitude": 0,
          "address_country": "USA",
          "id": "a6ea00e4-180a-4486-af34-b2121e8aac55",
          "address_zip": "70117"
        }
      ],
      "confirmation_email": null,
      "name": "Joe Test",
      "naic_number": "",
      "dob": null,
      "permission_level_id": null,
      "credit_score_account": null,
      "issue_payments_account_id": null,
      "payment_methods": [
        {
          "date_updated": "2019-10-01 21:40:28",
          "name_on_account": "Miss Joe Test",
          "contact_id": "c94446b8-a49f-4dbf-8eee-5dec93a28fad",
          "address_state": "LA",
          "vendor": "AuthnetCNP",
          "address_country": "USA",
          "id": "0251f13d-86ee-4421-90bc-aa12217d7d7e",
          "address_line2": null,
          "address_line1": "1010 Oak Lane",
          "masked_number": "...3010",
          "account_hash": "$2b$10$M4VRl/ygymaRCkFgcztRyenE/Zg8CpFoN.fSGP0vQrN5LEPl0/exW",
          "search_key": "54a",
          "primary_account": false,
          "account_name": "VISA",
          "expire_date": "2023-01-31",
          "method": "CC",
          "masked_routing": null,
          "vendor_id": "2c869d96-32e1-11e0-9ec0-00163e2d1c00",
          "account_type": "Credit Card",
          "same_address": false,
          "account_description": "",
          "vendor_log": {
            "requests": [
              {
                "Body": {
                  "CreateCustomerProfile": {
                    "profile": {
                      "paymentProfiles": {
                        "CustomerPaymentProfileType": {
                          "billTo": {
                            "city": "New Orleans",
                            "zip": "70117",
                            "firstName": "Joe",
                            "lastName": "Test",
                            "company": null,
                            "faxNumber": null,
                            "state": "LA",
                            "phoneNumber": null,
                            "address": "1010 Oak Lane",
                            "country": "USA"
                          },
                          "customerType": "individual",
                          "payment": {
                            "creditCard": {
                              "cardNumber": "************3010",
                              "expirationDate": "2023-01"
                            }
                          }
                        }
                      },
                      "email": null,
                      "shipToList": {
                        "city": null,
                        "zip": null,
                        "firstName": "Joe",
                        "lastName": "Test",
                        "company": null,
                        "faxNumber": null,
                        "state": null,
                        "phoneNumber": null,
                        "address": null,
                        "country": null
                      },
                      "merchantCustomerId": null,
                      "description": "c94446b8-a49f-4dbf-8eee-5dec93a28fad"
                    },
                    "merchantAuthentication": {
                      "transactionKey": "45685pS2pe4C7St3",
                      "name": "97kMujJ4D"
                    },
                    "validationMode": "testMode"
                  }
      
                        },
          "company_on_account": "",
          "active": true,
          "address_zip": "70117",
          "address_city": "New Orleans",
          "vendor_payment_method_id": "1833937411",
          "customer_profile_id": "1920958280",
          "updated_on": "2019-10-01 21:40:28"
        }
      ],
      "username": null,
      "terms_conditions_accepted": false,
      "commission_structure": null,
      "mortgagee_statement": null,
      "legal_entity_type": "",
      "mfa_counter": 0,
      "comm_statement_email_id": null,
      "default_state_id": null,
      "do_not_print_when_bill_whom": false
    }
  },
  "messages": [
    "Retrieved contact information."
  ],
  "success": true
}

Step 7: Update an existing contact

Use the update_contact endpoint (/contacts/update_contact) to update an existing contact. The only required key is contact_id.

Note: If you add any key and leave it empty, the field will be cleared. If you don’t want to clear a field, leave the key out of your request. In other words, every key/value pair you send will be checked for discrepancies with the current data, and changes will be made.

Sample request

View code
curl --location --request POST 'https://client.britecorepro.com/api/v2/contacts/update_contact' \
--header 'Content-Type: application/json' \
--data-raw '{
    "contact": {
        "display_agency_group_info_on_dec": false,
        "mfa": false,
        "ssn_group": null,
        "dba": "",
        "email_print_list": false,
        "commission_account_id": "d12575fd-7220-4ea8-99c5-7f9b95d22e0b",
        "agency_inception_date": null,
        "date_updated": "2020-07-01 13:35:29",
        "is_god": false,
        "api_key": null,
        "sweep_account_id": "d12575fd-7220-4ea8-99c5-7f9b95d22e0b",
        "follow_agency_quoting_restriction": true,
        "issue_payments_account_id": null,
        "ssn": null,
        "background": "Rerum blanditiis dolor mollitia velit labore quibusdam et. Impedit non ut quo. Perspiciatis vero aut velit. Et inventore fuga tempore fugiat nihil vel dolores. Dolores nulla provident fugit. Minus sint ipsum saepe.\n\nEius et inventore fuga tempore fugiat nihil vel dolores. Dolores nulla provident fugit. Minus sint ipsum saepe.",
        "date_added": "2019-04-16 11:12:47",
        "agency_termination_date": null,
        "password": null,
        "fein_tax": "12-4234234",
        "emails": [
            {
                "date_updated": "2019-04-16 11:13:41",
                "type": "Work",
                "id": "29308b64-8ca7-4be5-805a-27f0fa368a2f",
                "contact_id": "08e1efe0-de94-48e8-b763-6f0a2223025a",
                "email": "faker66034@gmail.com"
            }
        ],
        "photo_id": "2aee6219-0ac2-449f-b374-406a4d177399",
        "name": "Wholesale Agency",
        "naic_number": "",
        "gender": null,
        "agency_inactive_timestamp": null,
        "comm_statement_email_id": "29308b64-8ca7-4be5-805a-27f0fa368a2f",
        "default_state_id": null,
        "phones": [
            {
                "date_updated": "2020-06-30 21:10:10",
                "phone": "(281) 447-3029",
                "type": "Work",
                "id": "8806236d-eaec-4f05-9e4a-d33e0a8a7fa7",
                "contact_id": "08e1efe0-de94-48e8-b763-6f0a2223025a"
            }
        ],
        "date_business_started": null,
        "agency_number": "987654",
        "disallow_e2_val": false,
        "is_approved_vendor": false,
        "default_agency_id": null,
        "termination_reason": null,
        "agency_group_number": null,
        "notify_of_overdue_invoices": true,
        "last_login": null,
        "producer_number": null,
        "added_by": null,
        "do_not_print_when_bill_whom": true,
        "active": true,
        "agency_billing_enabled": true,
        "oops_email": null,
        "permission_level_id": null,
        "commission_structure": "Default Commission Structure",
        "legal_entity_type": "",
        "cc_claim_email_notices": null,
        "addresses": [
            {
                "address_line2": "",
                "address_city": "Boston",
                "address_line1": "3707 Conroy Heights",
                "type_label": "",
                "date_updated": "2019-04-16 11:13:23",
                "type": "Mailing/Billing",
                "address_county": "Suffolk",
                "contact_id": "08e1efe0-de94-48e8-b763-6f0a2223025a",
                "longitude": null,
                "attention": "",
                "address_state": "MA",
                "latitude": null,
                "address_country": "USA",
                "id": "2d8417a7-df92-4bb1-9a5f-93e18f94b5df",
                "address_zip": "02110"
            }
        ],
        "cc_email_notices": "",
        "risk_id_number": null,
        "mfa_counter": 0,
        "terminated": false,
        "vendor_number": null,
        "issue_commission_payments": true,
        "info_for_new_payment_method": {
            "cards": {
                "AmericanExpress": true,
                "VISA": true,
                "Discover": true,
                "MasterCard": true
            },
            "options": {
                "ach": true,
                "cvv2": false
            }
        },
        "type": "organization",
        "website": "http://wholsaleinsurance.com",
        "system_tags": {
            "472ffeba-d5dc-11e8-a239-0242ac110003": {
                "name": "Credit Score Threshold",
                "value": "100"
            }
        },
        "flag": "orange",
        "mfa_code": "INB5JIB5TYRXRYVA",
        "has_sweep_account": true,
        "cognito_username": null,
        "claim_activity_email_id": null,
        "accept_electronic_comm_statement": true,
        "roles": [
            "Agency"
        ],
        "credit_score_account": null,
        "terms_conditions_accepted": false,
        "username": null,
        "direct_application_activity_to": null,
        "timezone": "",
        "id": "08e1efe0-de94-48e8-b763-6f0a2223025a",
        "issue_payments": false,
        "portal_code": "278127",
        "purchase_date": null,
        "notice_email_id": "29308b64-8ca7-4be5-805a-27f0fa368a2f",
        "agency_inactive": false,
        "password_attempts": 0,
        "is1099_reportable": false,
        "drivers_license": null,
        "same_as_ssn": false,
        "email_notices": true,
        "confirmation_email": null,
        "dob": null,
        "payment_methods": [
            {
                "date_updated": "2019-04-16 11:14:14",
                "name_on_account": "Wholesale Agency",
                "contact_id": "08e1efe0-de94-48e8-b763-6f0a2223025a",
                "address_state": "MA",
                "vendor": null,
                "address_country": "USA",
                "id": "d12575fd-7220-4ea8-99c5-7f9b95d22e0b",
                "address_line2": "",
                "address_line1": "3707 Conroy Heights",
                "masked_number": "...3848",
                "account_hash": "$2a$10$jpba7nsq8lFPWCohq3WFquzkN3VMWc.gFEdvm1Z7Yca/xP3Y6iO0y",
                "primary_account": false,
                "account_name": "MASS BAY CREDIT UNION",
                "expire_date": null,
                "method": "ACH",
                "masked_routing": "...3557",
                "vendor_id": "904e3a9a-097a-11e5-b750-0242ac110009",
                "account_type": "Business Checking",
                "same_address": false,
                "account_description": "",
                "vendor_log": {
                    "requests": [
                        {
                            "routing_number": "*****3557",
                            "bank_name": "MASS BAY CREDIT UNION",
                            "bank_account_number": "****3848",
                            "account_type": "ACH",
                            "name": "Wholesale Agency",
                            "prepaid": "yes",
                            "customer_identifier": "08e1efe0-de94-48e8-b763-6f0a2223025a",
                            "process_date": "04172019",
                            "user_identifier": "Wholesale Agency",
                            "account_number": "d***75fd-7220-4ea8-99c5-7f9b95d22e0b",
                            "key": "H6ZJBESFRi0tXcO4gPgYq0N7",
                            "action": "post",
                            "path": "/payments/account",
                            "is_savings": "no",
                            "account_name": "MASS BAY CREDIT UNION"
                        }
                    ],
                    "responses": [
                        {
                            "data": {
                                "account_status": null,
                                "gateway_message": "Success",
                                "account_token": "D23K4n3n#",
                                "payment_token": "JDNM234NJ23",
                                "payment_token_status": "complete"
                            },
                            "success": true
                        }
                    ]
                },
                "company_on_account": "",
                "active": true,
                "address_zip": "02110",
                "address_city": "Boston",
                "vendor_payment_method_id": "D23K4n3n#",
                "customer_profile_id": "08e1efe0-de94-48e8-b763-6f0a2223025a",
                "updated_on": "2019-04-16 11:14:14"
            }
        ],
        "mortgagee_statement": null,
        "position": null
    }
}'

Sample response

View code
{
  "data": {
    "display_agency_group_info_on_dec": false,
    "mfa": false,
    "disallow_e2_val": false,
    "gender": null,
    "background": "Rerum blanditiis dolor mollitia velit labore quibusdam et. Impedit non ut quo. Perspiciatis vero aut velit. Et inventore fuga tempore fugiat nihil vel dolores. Dolores nulla provident fugit. Minus sint ipsum saepe.\n\nEius et inventore fuga tempore fugiat nihil vel dolores. Dolores nulla provident fugit. Minus sint ipsum saepe.",
    "dba": "",
    "cc_email_notices": "",
    "date_business_started": null,
    "email_print_list": false,
    "agency_number": "987654",
    "agency_inception_date": null,
    "has_sweep_account": true,
    "commission_account_id": "d12575fd-7220-4ea8-99c5-7f9b95d22e0b",
    "is_approved_vendor": false,
    "direct_application_activity_to": null,
    "timezone": "",
    "phones": [
      {
        "date_updated": "2020-06-30 21:10:10",
        "phone": "(281) 447-3029",
        "type": "Work",
        "id": "8806236d-eaec-4f05-9e4a-d33e0a8a7fa7",
        "contact_id": "08e1efe0-de94-48e8-b763-6f0a2223025a"
      }
    ],
    "sweep_account_id": "d12575fd-7220-4ea8-99c5-7f9b95d22e0b",
    "ssn_group": null,
    "id": "08e1efe0-de94-48e8-b763-6f0a2223025a",
    "issue_payments": false,
    "terminated": false,
    "default_agency_id": null,
    "same_as_ssn": false,
    "cognito_username": null,
    "agency_billing_enabled": true,
    "agency_group_number": null,
    "notify_of_overdue_invoices": true,
    "portal_code": "278127",
    "photo_id": "2aee6219-0ac2-449f-b374-406a4d177399",
    "vendor_number": null,
    "last_login": null,
    "producer_number": null,
    "issue_commission_payments": true,
    "is_god": false,
    "api_key": null,
    "type": "organization",
    "added_by": null,
    "purchase_date": null,
    "website": "http://wholsaleinsurance.com",
    "risk_id_number": null,
    "notice_email_id": "29308b64-8ca7-4be5-805a-27f0fa368a2f",
    "follow_agency_quoting_restriction": true,
    "termination_reason": null,
    "system_tags": {
      "472ffeba-d5dc-11e8-a239-0242ac110003": "100"
    },
    "legal_entity_type": "",
    "agency_inactive": false,
    "password_attempts": 0,
    "is1099_reportable": false,
    "isWholeSaleModeAgency": true,
    "flag": "orange",
    "ssn": null,
    "date_updated": "2020-07-01 13:35:29",
    "mfa_code": "INB5JIB5TYRXRYVA",
    "drivers_license": null,
    "position": null,
    "active": true,
    "date_added": "2019-04-16 11:12:47",
    "agency_termination_date": null,
    "fein_tax": "12-4234234",
    "cc_claim_email_notices": null,
    "oops_email": null,
    "email_notices": true,
    "claim_activity_email_id": null,
    "accept_electronic_comm_statement": true,
    "addresses": [
      {
        "address_line2": "",
        "address_city": "Boston",
        "address_line1": "3707 Conroy Heights",
        "type_label": "",
        "date_updated": "2019-04-16 11:13:23",
        "type": "Mailing/Billing",
        "address_county": "Suffolk",
        "contact_id": "08e1efe0-de94-48e8-b763-6f0a2223025a",
        "longitude": null,
        "attention": "",
        "address_state": "MA",
        "latitude": null,
        "address_country": "USA",
        "id": "2d8417a7-df92-4bb1-9a5f-93e18f94b5df",
        "address_zip": "02110"
      }
    ],
    "confirmation_email": null,
    "name": "Wholesale Agency",
    "naic_number": "",
    "dob": null,
    "permission_level_id": null,
    "credit_score_account": null,
    "issue_payments_account_id": null,
    "username": null,
    "emails": [
      {
        "date_updated": "2019-04-16 11:13:41",
        "type": "Work",
        "id": "29308b64-8ca7-4be5-805a-27f0fa368a2f",
        "contact_id": "08e1efe0-de94-48e8-b763-6f0a2223025a",
        "email": "faker66034@gmail.com"
      }
    ],
    "terms_conditions_accepted": false,
    "commission_structure": "Default Commission Structure",
    "mortgagee_statement": null,
    "agency_inactive_timestamp": null,
    "mfa_counter": 0,
    "comm_statement_email_id": "29308b64-8ca7-4be5-805a-27f0fa368a2f",
    "default_state_id": null,
    "do_not_print_when_bill_whom": true
  },
  "messages": [],
  "success": true
}