Batch Import Status

Retrieve import status updates and details on missing data on a single transaction batch submitted into the InsCipher platform.

Introduction

Depending on the size of the data import, it may take 1 second to 30 minutes for a policy transaction import batch to complete. Once complete, you can receive the specific batch status including errors such as tax calculation errors, missing fields, and missing documents.

🚧

Before Getting Started:

InsCipher utilizes data tables outside of the documentation for every request to provide the most up to date requirements for your integration. Depending on your configuration, you may need to reference the following tables, which will be mentioned further down in the documentation.

Feel free to open these in a new window or bookmark for future use:

Request Method - GET

Authentication and URL

A user is authenticated using an API key, which is provided by your InsCipher implementation specialist. The API key is typically around 40 characters.

API Key: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX

ENDPOINT URL

https://surpluslines.inscipher.com/api/v4/transaction-import-results.json?apikey=xxxxx&batch_id=yyyyyy

Sucess Response Sample

 {
"batch_id": "912a654e961bb083981145c344ca40c6",
"status": "processed",
"transactions": [
{
"id": "201909240000000001",
"policy_number": "CA20170228-05",
"transaction_id": 34859,
"status": 0,
"status_message": "Success"
}]
}

Success Response + Warnings Sample

 {
"batch_id": "912a654e961bb083981145c344ca40c6",
"status": "processed",
"transactions": [
{
"id": "201909240000000001",
"policy_number": "CA20170228-05",
"transaction_id": 34859,
"status": 0,
"status_message": "Success",
"warnings": {
"lineOfBusiness": "Line of business is invalid.",
"total": "Transaction total values don't match. Provided - 4224.80. Calculated - 3407.98",
"slTax": "SL tax values don't match. Provided - 117.00. Calculated - 93.26",
"stampingFee": "Stamping fee values don't match. Provided - 7.80. Calculated - 6.22"
}
}]
}

Error Response Sample

 {
"batch_id":"f6272344cc2b5dccdaf24c9120ab77de",
"status": "processed",
"transactions":[
{
"id":"00001",
"policy_number":"ABC 0099",
"status":1001,
"status_message":"Error: missing required document with code 'POLIC'."
}]
}

Response Status (Batch) Codes

StatusDescription
acceptedThe batch is accepted and scheduled for processing (transactions are not imported yet)
waiting_for_processingBatch is waiting for processing
in_progressBatch processing is in progress
partial_processedBatch is partially processed - part of the import processing failed (this status is very unlikely - force majeure)
processedBatch is processed
failedBatch processing failed

Response Status Codes

CodeName
0OK, accepted (Step 1), success (Step 2)
1001Error: Missing required documents
1002Error: Transaction type not found
1003Error: Transaction line of business is missing or invalid
1004Error: Department not found
1005Error: Unable to assign tax rule
1006Error: ECP (Exempt commercial purchaser) not provided
1010Error: Insurance company not provided
1011Error: Multi-State value not provided
1012Error: Customer physical state code is invalid
1013Error: Description of risk not found by real state and import code
1014Error: Transaction invoice number already exists in the system
1015Error: Missing state is required when physical address same as mailing
2001Error: Missing required fields
3001Error: Duplicate transaction is submitted
5001Error: Mailing insured name cannot be empty
5003Error: Agent cannot file in state
6001Error: upload document … size is too big, xMB is allowed
6002Error: document … are not reachable

Available Warning Messages

MessageDescription
totalTransaction total values don't match. Provided - %.2f. Calculated - %.2f

"Transaction total values don't match. Provided - 4224.80. Calculated - 4100.00"
policyLimitpolicyLimit value %s are empty or not numerical. "policyLimit value * are empty or not numerical"
insuranceCompany"Insurance company is invalid."
"Insurance company is missing."
slTaxSL tax values don't match. Provided - %.2f. Calculated - %.2f "SL tax values don't match. Provided - 117.00. Calculated - 0.00"
stampingFeeStamping fee values don't match. Provided - %.2f. Calculated - %.2f

"Stamping fee values don't match. Provided - 7.80. Calculated - 0.00"
premiumState requires to round %spremium amount to nearest dollar. Imported %.2f, required %.2f
fmTaxFM tax values don't match. Provided - %.2f. Calculated - %.2f "FM tax values don't match. Provided - 5.00. Calculated - 0.00"
slServiceCharge"SL service charge values don't match. Provided - 5.00. Calculated - 0.00"

SL service charge values don't match. Provided - %.2f. Calculated - %.2f
empaTax"Empa tax values don't match. Provided - 7.00. Calculated - 0.00"

Empa tax values don't match. Provided - %.2f. Calculated - %.2f
syndicateList"Total syndicate list coverage has to be 100%. (5 digits

precision are supported)"

Total syndicate list coverage has to be 100%%. (%s digits

precision are supported)

"Syndicate list breakdown is missing."
lineOfBusiness"Line of business is missing."

"Line of business is invalid."

"Line of business breakdown is missing."
insuranceCompanyItems"Total insurance company list coverage has to be 100%. (5 digits precision are supported)"

Total insurance company list coverage has to be 100%%. (%s digits precision are supported)

"Insurance Company List breakdown is missing, or incorrect list codes provided."
rpgName"Purchasing group name not provided (RPG = 'yes')."
ecp"ECP not provided."

How Do I View And Correct Batch Import Errors Manually?

If there are errors, you can go to the "Filings Import Log" page to identify the transactions that have errors and correct them.

If there are many errors that came through on a batch, you can delete the entire batch by clicking the "Delete" button on the batch:

You can also click under the "Not Imported Filings" or the "Error Log" to download a list of errors in the batch.

When pulling up the error code list, you will see the reason for the error followed by the policy number that was trying to be uploaded.

You will then need to go into the batch and correct the error.