Transaction Import - Single
Import single transactions & documents into InsCipher
Introduction
The Transaction Import API allows the programmatic import of single transactional policies and documents into InsCipher's online portal.
URL
POST
/api/v2/single/transaction
Request / Response Examples
{
"agent_id": 13947,
"policy_number": "CA20170228-05",
"policy_effective_date": "2025-06-02",
"policy_expiration_date": "2025-06-02",
"transaction_effective_date": "2025-06-02",
"expiring_policy_number": "CA20170228-04",
"invoice_date": "2025-06-02",
"invoice_number": "INVN-100011",
"transaction_type": "PN",
"policy_type": "master",
"account_written_as": "B",
"rpg": 1,
"layered_risk": 1,
"broker_of_record": 1,
"risk_retention_group": 1,
"purchasing_group_name": "Cal Association",
"risk_description": "General Accidental Coverage",
"ecp": 0,
"exempt": 0,
"multi_state": 0,
"policy_limit": 0.00,
"property_limit": 0.00,
"line_of_business_list": [
{
"item": "GEN-1001",
"coverage": 3108.50
}
],
"insurance_company_list": [
{
"item": "AA-1122000",
"coverage": 50
}
],
"syndicate_list": [
{
"item": "AA-1120131",
"coverage": 60
}
],
"premium": 3108.50,
"agency_fee": 200.00,
"inspection_fee": 0.00,
"collection_fee": 1.11,
"sl_tax": 117.00,
"stamping_fee": 7.80,
"sl_service_charge": 0.00,
"municipal_fee": 0.00,
"fm_tax": 0.00,
"empa_tax": 0.00,
"total": 4224.80,
"commission_received": 0,
"mailing_insured_name": "Westfield Galleria at Roseville",
"mailing_address": "1151 Galleria Blvd",
"mailing_city": "Roseville",
"mailing_zip_code": "95678",
"mailing_state_code": "CA",
"insured_entity": "individual",
"insured_email": "[email protected]",
"insured_phone": "212-456-7890",
"insured_county": "Washington",
"physical_same_as_mailing": 1,
"stamping_fee_invoice_id": "INVST-20001",
"sl_tax_invoice_id": "INVSL-30001",
"agent_notes": "test notes",
"business_group_id": "Division 1",
"customer_code": "OPT CUST CODE12",
"retail_producer_name": "Producer Name",
"retail_agency_name": "Producer Agency Name",
"retail_address": "Demo street 1",
"retail_address2": "2nd floor",
"retail_city": "Demo City",
"retail_state": "WA",
"retail_zip": "12345",
"sop_name": "SOP Name",
"sop_address": "Demo street 1",
"sop_address_2": "2nd floor",
"sop_city": "Winthrop",
"sop_state": "WA",
"sop_zip": "98862",
"dc_who_received_the_declinations": "John",
"dc_other_person_in_office": "Some Other Person",
"dc_who_performed_diligent_search": 1,
"wind_storm_eligible_for_pool": 1,
"wind_storm_primary_amount": 10,
"wind_storm_other_coverages_deductible": 25,
"wind_storm_exclusion": 1,
"wind_storm_deductible": 0.51,
"lloyds_cover_holder_number": "",
"lloyds_cover_holder_name": "",
"associated_producer": "1234567",
"declining_carriers": [
{
"naic": "54267",
"date_declined": "2017-02-02",
"declining_reason": "1 - Capacity Reached",
"underwriting_consideration": "frog",
"representative_name": "John",
"representative_title": "Mr",
"representative_email": "[email protected]",
"representative_phone_number": "54",
"representative_website": "demo.none"
},
{
"naic": "37816",
"date_declined": "2017-02-03",
"declining_reason": "2 - Underwriting Reason",
"underwriting_consideration": "frog",
"representative_name": "Doe",
"representative_title": "Dr",
"representative_email": "[email protected]",
"representative_phone_number": "36",
"representative_website": "demo.none"
},
{
"naic": "49865",
"date_declined": "2017-02-04",
"declining_reason": "incorrect",
"underwriting_consideration": "Considered",
"representative_name": "Johnson",
"representative_title": "Ms",
"representative_email": "[email protected]",
"representative_phone_number": "465",
"representative_website": "demo.none"
}
],
"transaction_documents": [
{
"code": "D1DISC",
"url": "https://www.google.com/logos/doodles/2017/abdul-sattar-edhis-89th-birthday-5757526734798848-res.png",
"id": 1000001
},
{
"code": "POLIC",
"id": 100000,
"document_payload": "/9j/4AAQSkZJRgABAQAASABIAAD/4QBwRXhpZgAATU0AKgAAAAgABAEGAAMAAAABAAIAAAESAAMAAAABAAEAAAEoAAMAAAABAAIAAIdpAAQAAAABAAAAPgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAABqADAAQAAAABAAAABgAAAAD/4QkhaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLwA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/PiA8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJYTVAgQ29yZSA1LjQuMCI+IDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+IDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiLz4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA8P3hwYWNrZXQgZW5kPSJ3Ij8+AP/tADhQaG90b3Nob3AgMy4wADhCSU0EBAAAAAAAADhCSU0EJQAAAAAAENQdjNmPALIE6YAJmOz4Qn7/wAARCAAGAAYDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9sAQwACAgICAgIDAgIDBAMDAwQFBAQEBAUHBQUFBQUHCAcHBwcHBwgICAgICAgICgoKCgoKCwsLCwsNDQ0NDQ0NDQ0N/9sAQwECAgIDAwMGAwMGDQkHCQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0N/90ABAAB/9oADAMBAAIRAxEAPwD2yiiiv5cbP9GD/9k=",
"document_filename": "policy.jpeg"
},
{
"code": "CUST",
"document_payload": "/9j/4AAQSkZJRgABAQAASABIAAD/4QBwRXhpZgAATU0AKgAAAAgABAEGAAMAAAABAAIAAAESAAMAAAABAAEAAAEoAAMAAAABAAIAAIdpAAQAAAABAAAAPgAAAAAAA6ABAAMAAAABAAEAAKACAAQAAAABAAAABqADAAQAAAABAAAABgAAAAD/4QkhaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLwA8P3hwYWNrZXQgYmVnaW49Iu+7vyIgaWQ9Ilc1TTBNcENlaGlIenJlU3pOVGN6a2M5ZCI/PiA8eDp4bXBtZXRhIHhtbG5zOng9ImFkb2JlOm5zOm1ldGEvIiB4OnhtcHRrPSJYTVAgQ29yZSA1LjQuMCI+IDxyZGY6UkRGIHhtbG5zOnJkZj0iaHR0cDovL3d3dy53My5vcmcvMTk5OS8wMi8yMi1yZGYtc3ludGF4LW5zIyI+IDxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PSIiLz4gPC9yZGY6UkRGPiA8L3g6eG1wbWV0YT4gICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICA8P3hwYWNrZXQgZW5kPSJ3Ij8+AP/tADhQaG90b3Nob3AgMy4wADhCSU0EBAAAAAAAADhCSU0EJQAAAAAAENQdjNmPALIE6YAJmOz4Qn7/wAARCAAGAAYDASIAAhEBAxEB/8QAHwAAAQUBAQEBAQEAAAAAAAAAAAECAwQFBgcICQoL/8QAtRAAAgEDAwIEAwUFBAQAAAF9AQIDAAQRBRIhMUEGE1FhByJxFDKBkaEII0KxwRVS0fAkM2JyggkKFhcYGRolJicoKSo0NTY3ODk6Q0RFRkdISUpTVFVWV1hZWmNkZWZnaGlqc3R1dnd4eXqDhIWGh4iJipKTlJWWl5iZmqKjpKWmp6ipqrKztLW2t7i5usLDxMXGx8jJytLT1NXW19jZ2uHi4+Tl5ufo6erx8vP09fb3+Pn6/8QAHwEAAwEBAQEBAQEBAQAAAAAAAAECAwQFBgcICQoL/8QAtREAAgECBAQDBAcFBAQAAQJ3AAECAxEEBSExBhJBUQdhcRMiMoEIFEKRobHBCSMzUvAVYnLRChYkNOEl8RcYGRomJygpKjU2Nzg5OkNERUZHSElKU1RVVldYWVpjZGVmZ2hpanN0dXZ3eHl6goOEhYaHiImKkpOUlZaXmJmaoqOkpaanqKmqsrO0tba3uLm6wsPExcbHyMnK0tPU1dbX2Nna4uPk5ebn6Onq8vP09fb3+Pn6/9sAQwACAgICAgIDAgIDBAMDAwQFBAQEBAUHBQUFBQUHCAcHBwcHBwgICAgICAgICgoKCgoKCwsLCwsNDQ0NDQ0NDQ0N/9sAQwECAgIDAwMGAwMGDQkHCQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0NDQ0N/90ABAAB/9oADAMBAAIRAxEAPwD2yiiiv5cbP9GD/9k=",
"document_filename": "custom.jpeg"
}
]
}
{
"batch_id": "f75d45bb47898abbd2b6f08769a186f7",
"transactions": [
{
"id": null,
"policy_number": "CA20170228-05",
"transaction_id": 8514658,
"status": 0,
"status_message": "Success",
"warnings": {
"slTax": "SL tax values don't match. Provided - 117.00. Calculated - 93.26",
"stampingFee": "Stamping fee values don't match. Provided - 7.80. Calculated - 5.60",
"associatedProducer": "Missing Associated Producer",
"rpgName": "Purchasing group name not provided (RPG = 'yes')"
}
}
]
}
{
"message": "Validation error!",
"errors": {
"transaction.transaction_documents[0].cookie_url": "The cookie URL must be a valid URL or null."
},
"metadata": [
"string"
]
}
Fields Names and Definitions
Field Title | Definition | Data Type |
---|---|---|
id | Unique ID used for tracking imported transactions. This number is used to identify possible duplicate transactions. Identified duplicate transactions are excluded from being imported. | string |
policy_number | Policy number for transaction (Non-unique field). InsCipher character limitation may be different than the state limitation for batch filing. | string |
policy_effective_date | Policy effective date. If omitted, transaction effective date is used as policy effective date. | string($date) |
policy_expiration_date | Policy expiration date. If omitted, the default value will be calculated to be 12 months from the Policy Effective Date. | string($date) |
transaction_effective_date | Transaction effective date. For endorsements, this is the endorsement effective date. For New or Renewal Policies, this is equal to the Policy Effective Date. | string($date) |
expiring_policy_number | Expiring Policy Number. Only required for Renewal Type Policies. | string |
invoice_date | This is the date that the policy was invoiced in most states. In GA, this is the Revenue Recognition Date, in HI, this is the Date Issued. | string($date) |
invoice_number | The 'Invoice ID' field on the Tracking tab in the filing details page of a Filing Agent User. Typically only used by InsCipher Connect clients. | string |
transaction_type | Transaction types with enumerated values: PN, PR, APE, RPE, AE, FC, ZPE, BD, RW, EE, OS, PC | string |
policy_type | Either 'standard' or 'master'. | string |
account_written_as | Account Written values. If omitted, the default Agency setting will be used. Values: B, DC | string |
rpg | Risk Purchasing Group? Yes = 1 No = 0. If omitted, NO (0) value will be used. | number($integer) |
layered_risk | Layered Risk Yes = 1 No = 0 | number($integer) |
broker_of_record | Broker of Record Change Yes = 1 No = 0 | number($integer) |
risk_retention_group | Risk Retention Group Yes = 1 No = 0 | integer |
purchasing_group_name | Required if RPG (rpg field) is set to Yes (or 1). If not included and RPG = Yes, then transaction will still import but will show RPG error. | string |
risk_description | Description of Risk. For NY, OH, and PA specific import codes are required. | string |
ecp | Exempt Commercial Purchaser? Yes = 1 No = 0. If omitted, 0 (zero) value will be imported. | integer |
exempt | Is the coverage considered tax exempt by the state? Yes = 1, No = 0. Currently required only for the state of Utah. | integer |
multi_state | Does the insured's liability reside in multiple states? Yes = 1, No = 0. Currently only required for the state of Utah. | integer |
policy_limit | Aggregate policy limit/liability amount associated with the policy. Requirement depends on State and Agency settings. | number($float) |
property_limit | Property Policy Limit. Requirement depends on State and Agency settings. | number($float) |
line_of_business_list | If multiple lines of business apply, use the line of business list breakdown. Contains item and coverage amount for each line of business. | array |
insurance_company_list | For policies with multiple insurance companies, provide the NAIC import code list. Contains item (NAICS) and coverage percentage. | array |
syndicate_list | For policies with multiple syndicates, provide the NAIC import code list. Contains item (NAICS) and coverage percentage. | array |
premium | Policy premium. If omitted, 0 (zero) amount will be imported. | number($float) |
agency_fee | Policy / Broker / Agency Fee. If omitted, 0 (zero) amount will be imported. | number($float) |
inspection_fee | Inspection / Audit / Underwriting Fee. If omitted, 0 (zero) amount will be imported. | number($float) |
collection_fee | Collection Fee. | number($float) |
sl_tax | Surplus Lines Tax (name may vary slightly by state). The requirement depends on Agency account setting if tax import is optional. | number($float) |
stamping_fee | Stamping Fee (name may vary, such as FSLO fee in Florida or Fire Marshal Tax in Oregon). | number($float) |
sl_service_charge | Currently active only in the state of Oregon and Mississippi. | number($float) |
municipal_fee | Currently active only in Kentucky. | number($float) |
fm_tax | Fire Marshal Tax based on Line of Business. Active in the state of Illinois and is based off premium amount. | number($float) |
empa_tax | EMPA tax. Active in the state of Florida and is based on Line of Business. | number($float) |
total | Total amount = premium + all taxes + all policy fees. If omitted, the system will sum up and import the total automatically. | number($float) |
commission_received | Is commission received? Currently only applies to NH. Yes = 1, No = 0. | integer($int32) |
mailing_insured_name | Insured name as it appears in policy documents. | string |
mailing_address | Mailing address. Required if at least one mailing address field is provided and if client has setting 'Full address optional' enabled. | string |
mailing_address2 | Mailing address line 2 (if applicable) | string |
mailing_city | Mailing city | string |
mailing_zip_code | Mailing zip code. Required if at least one mailing address field is provided and if client has setting 'Full address optional' enabled. | string |
mailing_state_code | Mailing state. 2-letter state code. Required if at least one mailing address field is provided. | string |
insured_entity | Mailing Entity Type. Options include: individual, commercial, governmental, federal, tribal, hospital_alliance, state_approved_tax_exempt. | string |
insured_email | Mailing Insured Email | string |
insured_phone | Mailing Insured Phone | string |
insured_county | Mailing County | string |
physical_same_as_mailing | If the Physical State is the same as the Mailing State, set this value = 1. If not, set this value = 0. | integer |
physical_address | Physical address. Required if Physical State is NOT the same as Mailing State and if client has setting Full address optional disabled. | string |
physical_address2 | Physical address line 2 | string |
physical_city | Physical city. Required if Physical State is NOT the same as Mailing State and if client has setting Full address optional disabled. | string |
physical_zip_code | Physical zip code. Required if Physical State is NOT the same as Mailing State and if client has setting Full address optional disabled. | string |
physical_state_code | Physical state. 2-letter state code. Required if Physical State is NOT the same as Mailing State. | string |
agent_id | Each Agency and Agent user is assigned an Agent ID. This value associates the transaction to a specific user. | integer |
agent_notes | Populates the Agent Notes section on the Filing Details page of a Filing Agent/Filing Agency Admin user. | string |
transaction_documents | Section for uploading transaction documents during API submission. Contains document code, URL, ID, type, and other document-related fields. | array |
transaction_documents[].code | Document code for the transaction document. | string |
transaction_documents[].url | URL of the document to be uploaded. | string, character limit: 4096 |
transaction_documents[].id | Document ID associated with the transaction. | string |
transaction_documents[].type | Type of document, specifying whether it's a URL or a base64 string. Enum: [ url, base64 ] | string |
transaction_documents[].cookie_url | An optional URL for cookies related to the document, if applicable. | string |
transaction_documents[].document_payload | Base64 encoded string for the document payload. Required if 'type' is set to 'base64'. | string |
transaction_documents[].document_filename | Document File Name for Base64 payload. | string |
sop_name | Service Of Process Name. Service of Process is a clause used in the event of a failure to pay amounts claimed under the policy. Currently applicable for the state of Alabama. | string |
sop_address | Service Of Process Address. | string |
sop_address_2 | Service Of Process Address 2 (if applicable). | string |
sop_city | Service Of Process City. | string |
sop_state | Service Of Process State. 2 letter state code. | string |
sop_zip | Service Of Process Zip Code. | string |
declining_carriers | Array of declining carrier details. | array |
dc_who_received_the_declinations | Who Received Declinations. Must be among the options provided in the admin interface. | string |
dc_other_person_in_office | Who Received Declinations Explanation. This field is saved and visible only if the 'who_received_the_declinations' option selected has the 'enable text box for explanation' checkbox checked. | string |
dc_who_performed_diligent_search | Who Completed Diligent Search: Surplus Lines Broker = 1, Retail Producer = 2 | integer |
retail_producer_name | Retail Producer Name. Required in WA, OR, and AK only if the business is written through a Retail Agent/Producer. | string |
retail_agency_name | Retail Agency Name. Required in WA, OR, and AK only if the business is written through a Retail Agent/Producer. | string |
retail_address | Retail Producer's Address Line 1. Required in WA, OR, and AK only if the business is written through a Retail Agent/Producer. | string |
retail_address2 | Retail Producer's Address Line 2. Required in WA, OR, and AK only if the business is written through a Retail Agent/Producer. | string |
retail_city | Retail Producer City Location. Required in WA, OR, and AK only if the business is written through a Retail Agent/Producer. | string |
retail_state | Retail Producer State Location. Required in WA, OR, and AK only if the business is written through a Retail Agent/Producer. | string |
retail_zip | Retail Producer Zip Code Location. Required in WA, OR, and AK only if the business is written through a Retail Agent/Producer. | string |
retail_producer_license | Retail Producer License. Depends on state retail producer settings. | string |
retail_agency_license | Retail Agency License. Depends on state retail producer settings. | string |
retail_phone_number | Retail Producer Phone Number. Depends on state retail producer settings. | string |
retail_email_address | Retail Producer Email Address. Depends on state retail producer settings. | string |
wind_storm_exclusion | Windstorm Exclusion Flag. Indicates if windstorm exclusion applies. Only applicable to certain property coverages in TX and FL. TRUE = 1, FALSE = 0 | integer |
wind_storm_eligible_for_pool | Windstorm Pool Exclusion Flag. TRUE = 1, FALSE = 0 | integer |
wind_storm_deduction | Windstorm/Hurricane Deductible. Amount of windstorm/hurricane deductible related to certain property coverages. Only applicable in FL. | number($float) |
wind_storm_primary_amount | Windstorm Primary Amount (Coverage A). Amount related to certain property coverages. Only applicable in FL. | number($float) |
wind_storm_other_coverages_deductible | All Other Perils Deductible. Amount related to all other deductibles not mentioned in the other fields above. Only applicable in FL. | number($float) |
lloyds_cover_holder_number | According to Lloyd's, a Cover Holder is a company or partnership authorized by a Managing Agent to enter into contracts of insurance underwritten by members of a syndicate. | string |
lloyds_cover_holder_name | According to Lloyd's, a Cover Holder is a company or partnership authorized by a Managing Agent to enter into contracts of insurance underwritten by members of a syndicate. | string |
migrated | Internal use only. | integer |
associated_producer | License Number of Associated Producer. Applies only if Associated Producer is enabled for the selected physical state and the selected license type is Agency. | string |
stamping_fee_invoice_id | Stamping Fee Invoice ID field on the Tracking tab in the filing details page of a Filing Agent User. Only applies to InsCipher Connect clients. | string |
sl_tax_invoice_id | SL Tax Invoice ID field on the Tracking tab in the filing details page of a Filing Agent/Filing Agency Admin User. Only applies to InsCipher Connect clients. | string |
business_group_id | Business Group ID. This is for assigning divisions, regions, or other business groups to a transaction for tracking purposes. Only applies to InsCipher Connect clients. | string |
customer_code | Customer Code. Used for associating specific customer classifications from your management system to a transaction for tracking purposes. Only applies to InsCipher Connect clients. | string |
transaction_status | Transaction Status. Not applicable to Utah and Idaho; this field will be ignored in those states, and default logic will be used. | integer($int32) |
license_number | License Number. Default logic will be used if the license is not found or multiple licenses are found. | string |
filing_admin | Filing Admin Name. Default logic will be used if the filing admin is not found or multiple filing admins are found. | string |
date_filed | Date Filed. If the transaction is imported with a 'Date Filed', it will automatically be imported in a 'Filed' status. | string($date) |
umr_number | UMR Number | string |
sla_transaction_number | SLA Transaction Number. Must be in valid format: XXXXX-XX-XXXXX (first five symbols can be letters and/or digits, others - only digits). | string |
unique_id | Unique ID | string |
stamping_fee_date_paid | Stamping Fee Date Paid | string($date) |
sl_tax_paid_date | SL Tax Paid Date | string($date) |
other_taxes_paid_date | Other Taxes Paid Date | string($date) |
dba | Doing Business As | string |
FAQ's ❓
Updated 4 days ago