QQCatalyst logo

Getting Started With the QQCatalyst API

The QQCatalyst API allows developers to build apps that integrate with QQCatalyst and securely access Catalyst data via our application services. If you would like to integrate with Catalyst, we have everything you need right here. To get started with Catalyst API integration, please contact our API team via email. We’ll then talk with you about becoming an API partner.

In order to interact with the Catalyst API, you will need to register with QQ Solutions as an API partner. After successfully registering, we will provide you with security tokens and credentials for use during authentication, as documented in the security section of this site. Subsequently, each of your insurance agency customers will need to work with you directly to allow your app to access to their individual Catalyst accounts.

Once you have registered as an API partner, you can download our sample application and view our detailed API documentation. We will also set you with a sandbox Catalyst account (for a nominal annual fee) and help you bring your product to life.

Release Updates and Additions

Version 6.0.4 Highlights

  • Additional Contacts
    • Additional Contacts PUT
      Created a new endpoint for updating or inserting Additional Contacts for a Personal Customer.
  • Business Contacts
    • Business Contacts PUT
      Created a new endpoint for updating or inserting Business Contacts for a Commercial Customers.
  • Carriers
    • GetSummary GET
      Created a new API to get the list of carriers, their addresses and respective parent carriers
  • Contact
  • Contact Addresses
    • Upsert Contact Address PUT
      New endpoint to insert or update addresses for a contact. To insert an address, omit AddressID (or set to 0); required fields: Line1, City, Zip, AddressTypeID, CountryCode. To update an address, provide a non-zero AddressID that belongs to the contact; required fields: AddressID.
  • Contact Notes
    • Insert or Update Note PUT
      Updated endpoint to support creating and updating contact notes. To create a note, omit Id (or set to 0); required fields: AssignedContactId, Comment. To update a note, provide the existing note Id and updated Comment; required fields: Id, Comment.
  • Customers
    • Update Customer PUT
      Endpoint to update fields on a customer or prospect. Supports FirstName, MiddleName, LastName, AgentID, CsrID, DateOfBirthString, and Addresses. Omit or null a field to leave it unchanged. FirstName and LastName are required, so an empty string is rejected; MiddleName accepts an empty string to clear it. For AgentID/CsrID, send 0 to clear or a positive EmployeeID to assign (the employee must be active and have access to the customer's office). DateOfBirthString is yyyy-MM-dd; send an empty string to clear the date of birth. Addresses is a list of one or more addresses of any type: AddressID=0 inserts a new address, a non-zero AddressID updates an existing address belonging to the customer.
  • Emails
    • Email Accounts For EmployeeID GET
      Added a new endpoint to get the list of Email Accounts for a given Employee ID
    • Send Email V2 POST
      Simplified version of Send Email to send an email for a contact with an optional policy association.
    • Get Emails List GET
      New endpoint that returns a paginated list of sent emails scoped to an entity/contact or a policy. Supports filtering by subject, sender, recipient, assigned-by name, tag, or date, and sorting by Date, AssignedBy, or AssignedDate in ASC or DESC order.
  • File Upload
    • Post Upload File Stream POST
      Endpoint to upload a file for a contact and, optionally, one or more policies. Send a multipart/form-data request with fields 'ContactID' (required), 'FileName' (required), 'PolicyID' (optional; a single id or comma-delimited list) and the file content. The ContactID must exist, and every PolicyID must exist and belong to that ContactID. The response is a lightweight result: on success 'IsSuccess' is true with the new file id in 'InfoMessage' ('A new file with FileID {FileID} has been uploaded'); on a validation or upload failure 'IsSuccess' is false with the reason in 'ErrorMessage' (the internal AWS blob metadata is no longer returned).
  • Policies
    • Update Policy PATCH
      Created a new endpoint for updating Basic Policy Info, Binder Info, Quotes, and Named Insureds.
  • Policy Attachments
  • Policy Info
    • Get Detailed Policy Info By Customer GET
      New endpoint to retrieve detailed policy info for all policies belonging to a customer, including binder details, quotes, policy lines, and named insureds.
    • Get Detailed Policy Info By Policy IDs POST
      New endpoint to retrieve detailed consolidated policy info for a list of policy IDs (max 10 per request), including binder details, quotes, policy lines, and named insureds.
  • Policy Notes
  • Tasks
  • Underwriting Questions

Version 6.0.2 Highlights

  • Enterprise
    • Enterprise Personal Drivers GET
      Added a new endpoint to get paginated personal auto driver details for all policies within a last-modified date range, ordered by tenant Id.
    • Enterprise Personal Vehicles GET
      Added a new endpoint to get paginated personal auto vehicle details for all policies within a last-modified date range, ordered by tenant Id.
    • Enterprise Commercial Drivers GET
      Added a new endpoint to get paginated commercial auto driver details for all policies within a last-modified date range, ordered by tenant Id.
    • Enterprise Commercial Vehicles GET
      Added a new endpoint to get paginated commercial auto vehicle details for all policies within a last-modified date range, ordered by tenant Id.

Version 5.1.32 Highlights

Version 5.1.16 Highlights

  • Commercial Auto Drivers
  • Policies
    • PolicySummaryForApi GET
      Updated endpoint to return a list of Policy Agency Fees along with policy summary info details.
    • LastModifiedCreated GET
      Updated endpoint to return a list of Policy Agency Fees along with modified policies given a date range with paging.
  • Policies Info
    • PolicyInfo GET
      Updated endpoint to return a list of Policy Agency Fees along with basic policy info including agent and CSR.

Version 5.1.12 Highlights

  • Policy Premium
  • Policies
    • PolicySummaryForApi GET
      Updated endpoint to return a list of ProducerIDs along with policy summary info details.
    • LastModifiedCreated GET
      Updated endpoint to return a list of ProducerIDs along with modified policies given a date range with paging.
  • PoliciesInfo
    • PolicyInfo GET
      Updated endpoint to return a list of ProducerIDs along with basic policy info including agent and CSR.

Version 5.1.7 Highlights

Version 5.1.6 Highlights

Version 5.0.7 Highlights

  • Locations
    • UserLocationsV2 GET
      Added a new endpoint to get the current user's list of locations and their correspodning default state codes. This is an improved and efficient version for UserLocations endpoint.
    • LocationInfo GET
      Updated endpoint to return address details such as street, city, state and zip.

Version 5.0.5 Highlights

  • PoliciesInfo

Version 5.0.1 Highlights

  • Contacts
    • Contacts PUT
      Added the ability to declare Agent and CSR IDs. New integer parameters: AgentId, CSRId.
  • Policies
    • Policies PUT
      Added the ability to declare Producers and Policy Source. New parameters: PolicySourceID, PolicySourceDetails, and Producers.

Version 4.94 Highlights

  • Contacts
    • Contacts PUT
      Added the ability to declare Agent and CSR IDs. New integer parameters: AgentId, CSRId.
  • Policies
    • Policies PUT
      Added the ability to declare Producers and Policy Source. New parameters: PolicySourceID, PolicySourceDetails, and Producers.

Version 4.57 Highlights

  • Policies
    • Policies PUT
      Added The ability to declare Agent and CSR IDs. New integer parameters: AgentId, CSRId.

Version 4.43 Highlights

  • Billing
    • BillingLastModifiedCreated GET
      Added a new endpoint for getting customer billing information for a specific date range with paging. Available query string parameters: startDate, endDate, pageNumber, pageSize.

Version 4.39 Highlights

  • Invoices
    • Invoices GET
      Added a new endpoint for getting invoice information with billing details.

Version 4.37 Highlights

  • Contacts
  • Policies Billing
    • Customer GET
      Changed the return type of this endpoint to include additional information. For payments the endpoint now returns user id of the person who collected the payment, location id, and payment type.

Version 4.30 Highlights

  • Contacts Billing
    • CompanyCommission GET
      Added a new endpoint for getting company commission billing information for a customer.
    • CompanyPremium GET
      Added a new endpoint for getting company premium billing information for a customer.
    • Customer GET
      Added a new endpoint for getting customer billing information for a customer.
    • FinancePremium GET
      Added a new endpoint for getting finance premium billing information for a customer.
    • ProducerCommission GET
      Added a new endpoint for getting producer commission billing information for a customer.
  • NonCustomers Billing
    • CompanyCommission GET
      Added a new endpoint for getting company commission billing information for a noncustomer. This endpoint is available for carriers, MGAs and prospects.
    • CompanyPremium GET
      Added a new endpoint for getting company premium billing information for a noncustomer. This endpoint is available for carriers, MGAs and prospects.
    • Customer GET
      Added a new endpoint for getting customer billing information for a noncustomer. This endpoint is available for prospects.
    • FinancePremium GET
      Added a new endpoint for getting finance premium billing information for a noncustomer. This endpoint is available for finance companies and prospects.
    • ProducerCommission GET
      Added a new endpoint for getting producer commission billing information for a noncustomer. This endpoint is available for employees and prospects.
  • Policies Billing
    • CompanyCommission GET
      Added a new endpoint for getting company commission billing information for a policy.
    • CompanyPremium GET
      Added a new endpoint for getting company premium billing information for a policy.
    • Customer GET
      Added a new endpoint for getting customer billing information for a policy.
    • FinancePremium GET
      Added a new endpoint for getting finance premium billing information for a policy.
    • ProducerCommission GET
      Added a new endpoint for getting producer commission billing information for a policy.

Version 4.28 Highlights

  • Policies
    • Policy Info GET
      Updated endpoint to return additional 'CreatedBy' property
    • Adjustments GET
      Added a new endpoint for getting a list of adjustments for a policy.

Version 3.10 Highlights

Version 3.8 Highlights

Version 3.7 Highlights

  • The technology used to serve our Catalyst APIs has been upgraded from WCF to the Microsoft WebAPI architecture built of the MVC platform. This provides a more efficient and customizable system and combines the best of both architectures. All existing API methods have been configured to use new, easier to configure signatures that would allow future versions of the same method to exist while the old ones remain. Our goal was to maintain 100% backwards compatibility with the existing APIs and their respected URLs to minimize or eliminate impact to 3rd party consumers.
  • Use of the QQCatalyst API Test Harness tool has been deprecated.
    • Developers can log into their own test tenants using https://app.qqcatalyst.com/apideveloper and run API tests without having to know their bearer token, this functionality replaces the QQCatalyst API Test Harness.
    • New functionality has been added to allow developers to directly test API methods on http://api.qqcatalyst.com/Help. A "Test this API" button in the lower right hand corner of the screen of each API method, will allow developers to enter the requested parameters and send the request. An encrypted bearer token is required to test methods using this tool. Bearer token can be retrieved from https://app.qqcatalyst.com/apideveloper
  • Added / Modified API Methods
    • Customers GET
      Added a parameter to the method used to get Customer Details to indicate if the user wants all the details including tasks/notes/files/ACORDs
    • Contact Addresses GET
      Return a list of addresses for a contact.
    • Contact XDates GET
      Return a list of XDates for a contact.

Version 3.6 Highlights

  • Contacts - Employees
    • Employee Shifts
      Provide a way for getting and updating Employee Shifts, found in the employee's user preferences tab in QQCatalyst.
    • Employee Details
      Provide a way to get an employee's User Details

Updates beyond this point refer to the old API format. Refer to Technical Documentation for the new method format and layout.

Version 3.5 Highlights

Version 3.4 Highlights

  • Contacts
    • Contacts By Date Modified or Created with Pagination GET
      Available query string parameters: startDate, endDate, pageNumber, pageSize
      Use this method to get a list of contacts that have been modified or created for a specific data range. This is an extension of a method that already exists but it contains additional parameters to include paging. If you are using the old method and are experiencing issues please adjust your system to use the new, paged result set. By default the results are paged at 100 records and the max requested page count is 500.
    • Contact Tasks GET
      Available query string parameters: pageNumber, pageSize, orderBy, orderDirection
      Use this method to get a list of tasks associated to a contact. This is not the employee assigned to the contact.
    • Employee Tasks GET
      Available query string parameters: pageNumber, pageSize, orderBy, orderDirection
      Use this method to get a list of tasks associated to an Employee.
    • Mark Task Complete POST
      Use this method to update a task to completed status.
    • Update Task Progress POST
      Use this method to update a task. TaskDTO properties ID, Complete (percentage), Status and ReminderDate(Optional) should be filled. Status= Not Started, Waiting, In Progress, Deferred, Completed
    • Contact Notes GET
      Available query string parameters: pageNumber, pageSize, orderBy, orderDirection
      Use this method to get a list of notes associated to a contact
  • Policies
    • Policies By Date Modified or Created with Pagination GET
      Available query string parameters: startDate, endDate, pageNumber, pageSize
      Get a list of modified policies given a date range with paging. This is an extension of a method that already exists but it contains additional parameters to include paging. If you are using the old method and are experiencing issues please adjust your system to use the new, paged result set. By default the results are paged at 100 records and the max requested page count is 500.
    • Policy DownPayment GET
      Get the down payment information for a policy.
    • Commercial Inland Marine Policies
      Various methods will be found here to read and manipulate the Policy Detail sections of a Commercial Inland Marine Policies. Some methods will be found without the {policyDetailID} parameter. These methods also cover policies with the Equipment Floater and Contractor"s Equipment Floater lines of business.
    • Personal Inland Marine Policies
      Various methods will be found here to read and manipulate the Policy Detail sections of a Personal Inland Marine Policy. Some methods will be found without the {policyDetailID} parameter.
  • Files
    • Policy Files GET
      Available query string parameters: downloadAs, pageNumber, pageSize
      Get a list of files associated to a Policy ID, alternatively you can request the byte[] of the file with "downloadAs"= None, Thumbnail, Original. This is an extension of a method that already exists but it contains additional parameters to include paging. If you are using the old method and are experiencing issues please adjust your system to use the new, paged result set.
    • Contact Files GET
      Available query string parameters: downloadAs, pageNumber, pageSize
      Get a list of files associated to a Contact ID, alternatively you can request the byte[] of the file with "downloadAs"= None, Thumbnail, Original. This is an extension of a method that already exists but it contains additional parameters to include paging. If you are using the old method and are experiencing issues please adjust your system to use the new, paged result set.
<