Introduction

Before you get started

The following instructions are applicable to current customers of InsCipher with an active account. If you are interested in becoming a customer, you can speak with one of our sales representatives and/or receive a free demo here.

1. Reach out to your assigned InsCipher implementation lead to inquire about an API key, or request one here. Connect clients can also go to Settings > User List & Settings, select the relevant Agency Admin profile, and click Get a new API Key under API & Batch Import Settings. If you have multiple agencies within your Connect account, you will utilize this API Key for each Agency Admin profile.
2. Meanwhile, please become familiar with the API guides and schemas specific to the integration workflow that you are interested in and feel free to reach out with any technical questions to InsCipher support here.
3. Once you have obtained your key, please store in a secure, accessible place. Note that the key is only visible temporarily at time of generation. If you lose your key, you will need to generate another. Once a new key is generated, the old one becomes

API Overview by client type

There are two primary sets of clients within InsCipher - Connect and Filing Services clients. You can be neither if utilizing other standalone services such as the Tax Calculator or Diligent Forms API's. However, most clients fall into one of the previous two buckets. As such, you should utilize specific guides and schemas that differ for Connect and Filing Services clients specifically in order to avoid errors. If you have any questions or need assistance in this setup, contacting the support team is always the best route to take for a quick and helpful response.

Connect clients

Connect® is an enterprise-level task management and automation software tailored specifically to manage the surplus lines tax filing process. This product has several APIs to streamline data syncing. Click on the link below to learn more:

API solutions for Connect® Users

Filing Services clients

Filing Services® is a fully outsourced, award-winning service that files surplus lines reports and pays the taxes on your behalf. Our filing team is 100% U.S.-based. This product has several APIs to streamline data syncing. Click on the link below to learn more:

API solutions for Filing Services® Users

Understanding InsCipher-specific terminology

Throughout our documentation, you may come across a few of the following terms. It is helpful to understand the meaning behind them and to use this guide as a reference in case of questions.

📘

Common Terms

• Transaction - Here, we're referring to the policy data, policy invoice details, or individual policy filing.
• Filing - We sometimes use this term interchangeably with transaction or policy transaction
• Surplus Lines - Defined as the non-admitted policies that are written on the Excess and Surplus Lines market.
• Documents - Policy documents that are necessary to accompany transactions or that are necessary to be kept on hand but separate the policy document. An example of these are declination pages, full policy docs, state diligent effort forms, etc.
• Line of Business - We use this interchangeably with coverage code, class of business, etc.
• Other Terms - All specific field names are defined on each of the API guides.

Please field name definitions carefully to ensure that you are mapping fields accurately and completely.

Errors

InsCipher utilizes conventional HTTP response codes to indicate success or failure of an API request. Generally, 2xx codes indicate success, 4xx codes indicate a failure due to invalid information, and 5xx codes indicate server errors.