AL3 API (Data Extraction and AL3 File Creation)

API Base URL: https://apis.winsurtech.com/al3/v2

API Site URL: https://developer.winsurtech.com/

Terms and Conditions: https://winsurtech.com/terms-and-conditions/

SLA: https://winsurtech.com/winsurtech-rest-apis-service-level-agreement/

Introduction:

Data Extraction and Al3 File Creation API makes it very easy to create an AL3 file from CSV templates and extract specific data you need from an AL3 file in the form of JSON. The API endpoints work for both Policy Transaction files and Direct Bill Commission Files. In addition there are endpoints to fetch all the valid values (according to ACORD) for code lists and map NAIC code to the Carrier.

Convert CSV to ACORD AL3 Endpoints take a CSV file as an input and convert it to an ACORD AL3 file or DAT file. There is one endpoint to generate a CSV template for different lines of business and another endpoint to convert this template to an AL3 file. Code List Names and Values Endpoints generates all the code list names and as a response, contains al3_reference_id along with a description. You can copy the reference id from here and paste that to the Code List Values endpoint and use the required code from the output to add it to the Value column in the CSV Template for the AL3 file. Carrier Details endpoint will help you to get the information of the Carrier. The generated output contains the Carrier Name and NAIC Code for the carrier that matches the substring entered.

Extract AL3 to JSON Endpoints makes it very easy to extract different types of Policy data and Direct Bill Commission data from the AL3 file.

An AL3 file can contain various types of information, like:

Transaction Information
Insured Information
Basic Policy Information
What is covered (location and covered items)
Coverages, limits, deductibles, options, etc
Additional interests, their types, related amounts
Other and Prior Policy Information
Forms, Remarks, and Attachments
Carrier Questions
Claim History and Violations
Commission Summary and Details

Using the set of endpoints available in our API, you can extract each of the above information one by one as required.

In addition, for Direct Bill commission files you can extract:

Commission Summary Data
Commission Details Data

To view the AL3 files, you can use WinsurTech AL3 Viewer or WinsurTech Web Viewer.

Links:

WinsurTech AL3 Viewer: https://winsurtech.com/al3-desktop-viewer/

WinsurTech Web Viewer: https://products.winsurtech.com/

Some important points:

AL3 / DAT files are created by Carriers and they may have any extension although the most common extensions are .DAT and .AL3. Sometimes the files may have extensions like .001, .002, etc or even .ZIP. Our API examines each file irrespective of its extension.
AL3 format is ACORD’s proprietary format to pack Policy and Direct Bill commission data into this format and the files are sent from Carriers to their agencies (mostly view IVANS).
Although Claim Download files also have .DAT or .AL3 extension but these files are in ACORD XML format not in AL3 format. Claim data is parsed by a separate product of ours. Contact us at contact@winsurtech.com for that.
AL3 files for Policies can contain a variable amount of data. Some files contain only a single policy but some files can contain a large number of policies. Each policy in an AL3 file can be of a different line of business.
Most of the AL3 files are in KBs in their size, not in MBs. But “initial load” files from IVANS can be larger, like 2 MB or more. Our main /conversion endpoint can convert max up to 1 MB sized AL3 file. For a larger file use our /callBack-conversion endpoint.
Files with 10 to 200 KB size can be converted in less than 5 seconds but files that are 200+Kb and up to 1 Mb can take anywhere between 5 seconds to 40 seconds for conversion depending on the exact file size and traffic.
/callBack-conversion is not a real-time endpoint. It converts the data in the background and POSTS the response back to the CALLBACK URL you provide of your own application. Make sure the URL works, is open for the external traffic and you have written the code to receive JSON and process that.
/callBack-conversion can be used with any sized file. There are no restrictions related to file size in it.
To make it easy to extract data of specific nature like Additional Interests, Coverages, What is Covered, etc, we provide per-policy endpoints. We call them per-policy because you can use these endpoints to get data of a single policy from the AL3 file based on the policy number, although you can make use of per-policy endpoints to fetch data of multiple policies also that match different types of criteria - like all policies having the same transaction type, all policies having the same line of business, etc.
We store JSON output for a 2 hour period so as to serve per-policy endpoints. We do not store any AL3 files on our server. The JSON data is removed after a 2 hour period and the transaction id expires after this.
You need the User Secret to call the API endpoints. Check the steps given below to find your User Secret.

Key points about “per-policy” endpoints:

Always call /al3/conversion endpoint before calling the “per-policy” endpoints
Per-policy endpoints are not applicable to the Direct Bill Commission AL3 files ( /al3/conversion endpoint is applicable in this case which will give you the entire output or DB Commission Endpoints which will give you commission summary and commission details).
“Transaction_id” that you got in response to the /conversion endpoint is always required for calling any per-policy endpoint

From the other 3 parameters (transaction type, policy number, LOB type) the output will depend on what parameter values are passed.

When none of three parameters is passed, then it will return data corresponding to the endpoint for all the policies included in the AL3 file.
When the only lob_type is passed, it will return the data for all the policies that have the matching LOB type.
When the only transaction_type is passed, it will return the data for all the policies that have the matching Transaction type.
When only policy number is passed, it will return the data for the policy that has the matching Policy Number
If multiple parameter values are passed, then it will return the data for all the policies that match all the passed parameter values.

How to download postman collection and reset User Secret Key:

Login to the site with your credentials - https://developer.winsurtech.com/signin
Go to subscriptions tab- https://developer.winsurtech.com/subscription_list
On this page, click on the Download Postman Collection link as shown in the screenshot below:

Import this collection to Postman. After importing, the secret key is automatically included in the postman collection.
To reset your secret key click on Click to reset

** Click over the eye icon to view the secret key, you will need this key to call the Endpoints.**

Update this key in postman under the authorization tab.

Convert CSV to ACORD Al3

Description:

CSV to ACORD AL3 or DAT File Conversion takes a CSV file as input and converts it to an ACORD AL3 file. There is an endpoint to get the CSV format for different lines of business. Fill data in the CSV and upload it back to create the AL3 file. One CSV template can also contain data of multiple transactions but not of different LOBs. For packing multiple transactions of more than one LOB in the same AL3 file, upload a zip file containing all the CSV files packed in this ZIP. You can also optionally upload a HEADER file that contains the header groups only which are needed only once even if you pack multiple transactions in the same AL3 file. For generating the template (CSV file) for the HEADER groups use the LOB = HEADER_GROUPS with the Generate CSV Template API. You can add the coded values to the CSV file as input by using Code List Names and Code List Values API calls. NAIC Codes of carriers and their names can be retrieved by using Carrier Search API.

AL3 Creation Process is comprised of two steps:

Template Generation & AL3 Creation: By using the endpoint (Template Generation) available in this collection you can get the CSV template for the Line of Business relevant to your Policy Transaction (or for DB Commission). Each CSV template contains one row per element (like for Policy Number, Effective Date, etc). Templates are available in a shorter & simpler format of important elements only, as well as in FULL format (which means all the possible elements for the LOB are shown in the template). You can also specify the count of transactions for the passed LOB while generating the template (by default it is 1).

Create AL3 File: Add values in the template that you have against the matching rows in the template. If you have fewer data fill only that and leave the other rows blank. Then upload the data-filled CSV to AL3 Creation endpoint and the resulting AL3 file comes back in the output. Your programmer can easily access the AL3 content in the JSON response and save it into a file with the extension of .AL3 or .DAT. If you test the API in Postman you can manually copy and paste the content (excluding double quotes) into notepad and save it with .AL3 or .DAT file extension to test.

Supported Lines of Business

Personal Line Of Business (use these codes while creating the template)

Dwelling Fire - DFIREP

Homeowners - HOMEP

Inland Marine - INMARP

Mobile Home - MHOMEP

Watercraft - WATERCRAFTP

Automobile - AUTOP

Umbrella - UMBP

Flood (Personal or Commercial) - FLOODP

Header Groups- HEADER_GROUPS

Commercial Line Of Business (use these codes while creating the template)

Direct Bill Commission - DBC

Business Automobile - AUTOC

Worker’s Compensation - WCC

Commercial General Liability - LIABC

Property - PROPC

Crime - CRIMEC

Inland Marine - INMARC

Umbrella - UMBC

Header Groups- HEADER_GROUPS

Endpoint Information

User Authentication: Each Endpoint needs USER_SECRET parameter in the HEADER while making the request

Template Generation & AL3 Creation

Generate CSV Template

Request Method: GET
Endpoint: BaseURL/template

Description:

This endpoint helps you to get the Template for the Line of Business you want. For e.g. if you have to create an AL3 file for Personal Homeowners (HOMEP) transactions the pass HOMEP in the LOB parameter. By default, CSV is generated for a single transaction, but you can pass any value for the Transaction Count input variable (max 50 for generating the template although you can manually extend the template file contents if you need more no. of transactions in the same AL3 file. Alternatively, you can create multiple copies of the same template file and pack all in a zip file to put all the transactions in the same AL3).

By default, full_format is set to false which gives a shorter and simpler template of most common elements for each LOB. If you want the full format pass full_format= yes. The AL3 file also contains some Header Groups which surround the actual data. If you are not comfortable with the AL3 structure then keep the header_groups parameter to blank or false as our code can automatically add the header groups & elements with blank values. If you want to set data in header group elements also then pass header_groups=true and it will work only if full_format is set to true. A better way to specify the header is to generate the header groups template separately with Templates API using LOB = HEADER_GROUPS as input for the LOB parameter. This single header file can be uploaded as input to the AL3 Creation API endpoint for input_header_file parameter. header_groups=true is useful only when full_format is set to true and it is the case of a single CSV file upload to create the AL3 file. In case of ZIP upload, a separate header file is always required (header elements from inside the data file are ignored in this case, a separate file is always expected).

Line of Business codes:

Personal Line Of Business (use these codes while creating the template)

Dwelling Fire - DFIREP

Homeowners - HOMEP

Inland Marine - INMARP

Mobile Home - MHOMEP

Watercraft - WATERCRAFTP

Automobile - AUTOP

Umbrella - UMBP

Flood (Personal or Commercial) - FLOODP

Header Groups- HEADER_GROUPS

Commercial Line Of Business (use these codes while creating the template)

Business Automobile - AUTOC

Worker’s Compensation - WCC

Commercial General Liability - LIABC

Property - PROPC

Crime - CRIMEC

Inland Marine - INMARC

Umbrella - UMBC

Header Groups- HEADER_GROUPS

Input Parameters:

Parameter Name	Data type	Is Mandatory	Description
LOB	text	true	Input the Line of Business Code to generate a template.
transaction_count	text	false	No. of transactions required in a single Al3 file.
header_groups	text	false	If passed true, it will add the header group elements also to the generated template.
full_format	text	false	If passed true, the full format of the template will be generated, i.e. a template including all the possible AL3 elements for the passed LOB.

By default, transaction_count is set to 1. You can add a value upto 50.
By default, header_groups is false (No).

**header_groups parameter will only work for full format template**

By default, full_format is false (No).

Sample Output:

In the above screenshot, the CSV template is generated for the Personal Homeowners Line of Business (HOMEP) with 2 transactions.
In postman, save this response by clicking on Save Response → Save to a file and save it to your disk with .csv extension.
Add values to the CSV Template and save it. This file can be uploaded in the next endpoint “Create Al3 File” to create an Al3 File.

Create Al3 File

Request Method: POST
Endpoint: BaseURL/creation

Description:

Fill data in the template generated from our Generate API Template endpoint call (fill whatever data you have and leave the rest of it blank. Don’t change the template columns but you can remove the rows you do not need. Note that all the mandatory fields are auto-filled with question marks at AL3 generation time according to the width of the element, but if you want to explicitly keep the field value blank then type {Blank} in the CSV cell for it. One CSV template can also contain data of multiple transactions but not of different LOBs. For packing multiple transactions of different LOBs in the same AL3 file, upload a zip file containing all the CSV files packed in this ZIP. You can also optionally upload a HEADER file that contains the header groups which are needed only once even if you pack multiple transactions in the same AL3 file.

Upload the data-filled CSV file to this API endpoint and save the response with the .al3 extension, thus creating the al3 file. The resulting AL3 file comes back in the output. Your programmer can easily access the AL3 content in the JSON response and save it into a file with the extension of .AL3 or .DAT. If you test the API over Postman you can manually copy and paste the output (excluding " ") into notepad and save it with .AL3 or .DAT file extension to test.

Input Parameters:

Parameter Name	Data type	Is Mandatory	Description
input_file	binary	true	.csv file or .zip file that needs to be converted.
input_header_file	binary	false	.csv header file.

Sample Output:

Here the HOMEP Template.csv is given as an input file and the data in the file is converted to an AL3 file.
Save the output within “ “ to a notepad file on your disk with .al3 or .dat extension.
The Al3 file created can now be viewed in any AL3 viewer, links to our AL3 viewers are mentioned above in the document.

Code List Names & Values

Code List Names

Request Method: GET
Endpoint: BaseURL/code-list-names

Description:

This API call will generate all the code list names, the response contains al3_reference_id along with a description. You can copy the reference id from here and paste that to the next API (Code List Values).

Sample Output:

Code List Values

Request Method: GET
Endpoint: BaseURL/code-list-values

Description:

This API call will generate all the code list values under the specific reference id (code list name) that you have entered and you can use the required code from the output to add it to the Value column in the CSV Template for the AL3 file. Also, the value "null" is not a code value, it only depicts that the value can be left blank if needed.

Input Parameters:

Parameter Name	Data type	Is Mandatory	Description
reference_id	text	true	Use the valid reference id (code list name) to get all the related code list values under that code list name.

Sample Output:

Here “CBPUR” is passed as an input and all the codes that can be used are returned.

Carrier Details

Carrier Information

Request Method: GET
Endpoint: BaseURL/carrier-search

Description:
This endpoint will help you to get the information of the Carrier. The generated output contains the Carrier Name and NAIC Code for the carrier that matches the substring entered.

Sample Output:

Here the information of all the carriers matching the substring “123” is returned as an output.

Extract Al3 to Json

In this version 2 of AL3 to JSON/AMS_MAP API calls, we are making it very easy to extract different types of Policy and Direct Bill Commission data from the AL3 file.

Endpoint Information

These endpoints are comprised with three sets those are discussed below:

Conversion & Policy Transaction Endpoints
Per-Policy Endpoints
DB Commission Endpoints

User Authentication: Each Endpoint needs USER_SECRET parameter in the HEADER while making the request

Suggested flow is these steps:

Conversion- To convert al3 to JSON/AMS_MAP and get the transaction id back

Transaction Summary- To get the summary of all the transactions contained within the AL3 file based on the transaction id obtained through Conversion API

Per Policy Endpoints- Using the output of Transaction Summary Endpoint.

Conversion & Policy Transaction Endpoints

Al3 to Json Conversion

Request Method: POST
Endpoint: BaseURL/conversion

Description:

This is the main endpoint that converts AL3 to JSON. This must be called before calling other endpoints. This call gives you a unique transaction id for your request that you need for the subsequent calls. It also gives you the entire JSON output together and you can use it if you do not prefer to call subsequent endpoints. After making this call, note down the transaction id you get back in the JSON output and use that to call the per-policy endpoints to extract specific pieces of information. Note that per-policy calls are supported only for Policy Transaction AL3 files.

Input Parameters:

Key (Body Parameter)	Value
input_file	example: MHOME.al3
output_format	ams_map/JSON
omit_blank_values	true/false

In the Body Parameter input_file: Upload the AL3 file you want to convert
In output_format: Enter the format you want the al3 to convert to i.e ams_map or JSON.
In omit_blank_values: Enter the value as true if you want to omit the blank values from the output else enter false. The default value is assumed to be true.

Postman Screenshot:

Sample Output:

"http_code": 200,

"total_time": "0.868842601776123",

"status": "successful",

"message": "output has been generated",

"input_file_name": "Auto new.al3",

"output_format": "ams_map",

"transaction_id": "81881af4-3199-4b3a-bad2-4367aabf6c5f",

"output": {

policies": [

{

"Transaction Header": {

"Transaction Structure Standard Version Number": "98",

"Automation Level": "Machinable",

"Transaction Category": "Policy",

"Policy Type Routing Code": "Commercial Lines",

"Line of Business Routing Code": "Automobile",

"Transaction Function": "Master File Image",

"Processing Cycle Status": "Both initial and final",

"Initial Transaction Mode": "Notification",

"Special Response Option": "Normal response only.",

"Formal Transaction Address (Sender)": "CL DOWN",

"Informal Transaction Address (Sender)": "AMTRUST",

"Special Handling": "APPLIED",

"Transaction Sequence Number": "8651",

"Deleted - Transaction Date (See 2TRG32)": "07/08/14",

"Processing Cycle Number": "8651",

"Deleted - Transaction Effective Date (See 2TRG33)": "01/01/14",

"Cycle/Business Purpose": "New Business",

"Transaction Date": "07/08/2014",

"Transaction Effective Date": "01/01/2014"

"Transaction Control": {

"First Standard Number": "501",

"First Version Number": "4B",

"Second Standard Number": "520",

"Second Version Number": "6H",

"Third Standard Number": "920",

"Third Version Number": "7L",

"Fourth Standard Number": "922",

"Fourth Version Number": "24"

"Basic Insured Information": {

"Insured's Name": "Brady's Moving and Storage, Inc.",

"Insured's Name_seperate": {

"name_type": "C",

"prefix": "",

"first_name": "",

"middle_name": "",

"last_name": "",

"combined_name": "",

"suffix": "",

"company_name": "Brady's Moving and Storage, Inc.",

"file_name": "",

"name1": "",

"name2": "",

"dec_name": ""

"Legal Entity Code": "Corporation",

"Loss History": [

{

"Loss History ID Number": "21",

"Loss Location Number": "02",

"Claim Settled Indicator": "Y",

"Catastrophe Indicator": "N",

"Total Losses Amount": "600",

"Loss Date": "01/05/2010"

}

The output continues...

Policy Transaction Summary

Request Method: POST
Endpoint: BaseURL/all-transaction-summary
* Use this API endpoint only for Policy Transaction AL3 files, not for Direct Bill Commission files. Before calling this API call the /al3/conversion API only then it will work **

Description:
This endpoint is to fetch the summary of all the policy transactions contained within the AL3 file which you just converted. From “summary“ the meaning is, only the following parameters for each policy transaction will be returned in the JSON output:

Policy Number
LOB type
Transaction Type

Input Parameters:

Key (Body Parameter)

Value

transaction_id

Transaction id value from conversion endpoint output

eg: 81881af4-3199-4b3a-bad2-4367aabf6c5f

Sample Output:

policies": [

{

"Transaction Header": {

"Transaction Type": "New Business"

"Basic Insured Information": {

"Basic Policy Information": {

"Policy Number": "SPP1108052",

"Line of Business Code": "Business automobile"

}

]

}

Callback Conversion

Request Method: POST
Endpoint: BaseURL/callBack-conversion

Description:

To convert files greater than 1MB, this endpoint is used. It is not a real-time endpoint. It converts the data in the background and POSTS the response back to the CALLBACK URL you provide of your own application. Make sure the URL works, is open for the external traffic and you have written the code to receive JSON and process that.

Input Parameters:

Key (Body Parameter)	Value
input_file	example: MHOME.al3
output_format	ams_map/JSON
callback_url	Static URL
omit_blank_values	true/false

In the Body Parameter input_file: Upload the AL3 file you want to convert
In output_format: Enter the format you want the al3 to convert to i.e ams_map or JSON.
In callback_url: Enter the static url where you want to call back the response.
In omit_blank_values: Enter the value as true if you want to omit the blank values from the output else enter false. The default value is assumed to be true.

Postman Screenshot:

Per-Policy Endpoints

Using the transaction id obtained in the output of the Conversion API call, and the transaction summary parameters, call any endpoint in this group in any order to fetch the specific details.

From the Transaction Summary API, you will get the following parameters for each transaction contained in the AL3 file:

Policy Number
LOB type
Transaction Type

For the per-policy API endpoints, use a combination of these 3 parameters as required. The output will depend on what parameter values are passed.

When none of three parameters is passed, then it will return data corresponding to the endpoint for all the policies included in the AL3 file
When only lob_type is passed, it will return the data for all the policies that have the matching LOB type
When only transaction_type is passed, it will return the data for all the policies that have the matching Transaction type
When only policy number is passed, it will return the data for the policy that has the matching Policy Number.

If multiple parameter values are passed, then it will return the data for all the policies that match all the passed parameter value

** Use these API endpoints only for Policy Transaction AL3 files, not for Direct Bill Commission files. Before calling this API call the /al3/conversion API only then it will work **

Input Parameters: Input Parameters remain the same for every per-policy endpoint hence mentioned only once here.

Parameter Name	Data Type	Is Mandatory	Description
transaction_id	text	true	Use the transaction id returned by the conversion API
lob_type	text	false	Enter the valid lob_type. You can use any Lob_type value returned by the Policy transaction Summary API
policy_Number	text	false	Enter the valid policy number. You can use any policy_number returned by the Policy transaction Summary API
transaction_type	text	false	Enter the valid transaction_type. You can use any transaction_type returned by the Policy transaction Summary API
omit_blank_values	boolean	false	true or false Note - if on /conversion level you passed omit_blank_values:true then omit_blank_values at per-policy level endpoints will not have any effect

Insured Details

Request Method: POST
EndPoint: BaseURL/per-policy/insured

Description:
This endpoint is to retrieve the Insured data contained within the AL3 file, llike: Insured’s Name, Address, Country Name, City Name, Insured's Date of Birth, etc.

Postman Screenshot for Insured Details

Sample Output:

policies": [

{

"Transaction Header": {

"Transaction Type": "New Business"

"Basic Insured Information": {

"Insured's Name": "Brady's Moving and Storage, Inc.",

"Name Identifier": {

"Federal Employer Identification Code": "942254171"

"Basic Policy Information": {

"Policy Number": "SPP1108052",

"Line of Business Code": "Business automobile"

"Basic Insured Information Extension": {

"Address line 1": "251 Boeing Avenue",

"City Name": "Chico",

"Insured's State/Province Abbreviation": "CA",

"ZIP Code": "95973"

The output continues..

Policy Summary

Request Method: POST
Endpoint: BaseURL/per-policy/current-policy

Description:
This endpoint is to fetch Policy summary data of all the policies contained within the AL3 file. Policy summary comprises the details like Policy Number, Policy Effective Date, Policy Expiration Date, Carrier NAIC Code, etc.

Sample Output:

policies": [

{

"Transaction Header": {

"Transaction Type": "New Business"

"Basic Insured Information": {

"Basic Policy Information": {

"Policy Number": "SPP1108052",

"Carrier NAIC Code": "Security National Insurance Company {19879}",

"Line of Business Code": "Business automobile",

"Policy Effective Date": "01/01/2014",

"Policy Expiration Date": "01/01/2015",

"Current Term Amount": "+7626.00",

"Net Change Amount": "+7626.00",

"Billing Method Code": "Agency Billed",

"Mail to Code": "Company Responsibility",

"Payment Plan Information": {

"Payment Plan Code": "Full Pay"

"Commercial Lines Policy Information": [

{

"Operation Business Description": "Moving and Storage"

}

"State Summary": [

The output continues…

Covered Items with Locations

Request Method: POST
Endpoint: BaseURL /per-policy/location-covered-items

Description:
This endpoint is to retrieve all the details of Covered items (Risks) along with their locations contained within the AL3 file. The details include Location Number, State/Province Code, Zip Code, Covered item’s Type, Model, Description, Construction Year, Year of Occupancy, etc.

Sample Output:

policies": [

{

"Transaction Header": {

"Transaction Type": "New Business"

"Basic Insured Information": {

"Basic Policy Information": {

"Policy Number": "SPP1108052",

"Line of Business Code": "Business automobile",

"Business Automobile and Truckers Underwriting": [

{

"Number of Vehicles in Fleet": "9"

}

"State Summary": [

{

"Location Address": [

{

"Commercial Lines Automobile Unit At Risk": [

{

"Company Vehicle Number": "01",

"Vehicle Year": "1985",

"Vehicle Make": "INTERNATIONAL",

"Vehicle Body Type Code": "Truck-Tractor",

"Vehicle Identification Number": "1HTLDUGN2FHA14461",

"Vehicle Registration State": "CA",

"Rating Territory": "31",

"Symbol/Age": "23",

"Vehicle Use Code": "Service",

"Radius of Use": "50",

"Gross Vehicle Weight /Gross Combined Weight": "20000",

"Primary Class": "214",

"Secondary Class Code": "99",

"Business Automobile and Truckers Vehicle Supplement": {

The output continues…

Coverages

Request Method: POST
Endpoint: BaseURL/per-policy/coverage

Description:
This endpoint is to retrieve the data of coverages, limits, deductibles, options, etc. contained within the AL3 file. The data in it includes Coverage Code, Full Term Premium, Limit Amount, Liabilities, etc

Sample Output:

policies": [

{

"Transaction Header": {

"Transaction Type": "New Business"

"Basic Insured Information": {

"Basic Policy Information": {

"Policy Number": "SPP1108052",

"Line of Business Code": "Business automobile",

"Commercial Lines Coverage": [

{

"Coverage Code": "Combined Single Limit",

"Limit 1": "1000000",

"Deductible 1": "1000"

{

"Coverage Code": "Medical Payments",

"Limit 1": "5000"

{

"Coverage Code": "Collision with Trailer Interchange",

"Limit 1": "60000",

"Deductible 1": "1000"

{

"Coverage Code": "Comprehensive with Trailer Interchange",

"Limit 1": "60000"

}

"Business Automobile and Truckers Covered Auto Symbol": [

{

"Effective Date": "01/01/14",

"Liability Symbol 1": "01",

"Auto Medical Payments Symbol 1": "07",

"Comprehensive Symbol 1": "07",

"Comprehensive Symbol 2": "08",

"Collision Symbol 1": "07",

"Collision Symbol 2": "08",

"Policy Effective Date": "01/01/2014"

}

"State Summary": [

{

"Location Address": [

{

"Commercial Lines Automobile Unit At Risk": [

{

"Commercial Lines Coverage": [

{

"Coverage Code": "Combined Single Limit",

"Limit 1": "1000000",

"Deductible 1": "1000",

"Current Term Amount": "+478.00"

The output continues...

Additional Interests

Request Method: POST
Endpoint: BaseURL/per-policy/additional-interests

Description:
This endpoint is used to retrieve all the data of additional interests and their types contained within the AL3 file. The details in it comprise Additional Interest Name, Address, Zip Code, Nature of Interest Code, etc.

Sample Output:

policies": [

{

"Transaction Header": {

"Transaction Type": "New Business"

"Basic Insured Information": {

"Basic Policy Information": {

"Policy Number": "SPP1108052",

"Line of Business Code": "Business automobile",

"Additional/Other Interest": [

{

"Interest ID Number": "001",

"Nature of Interest Code": "Lienholder",

"Additional/Other Interest Name": "Penske Truck Leasing Co. Lp and Its Partners",

"Additional/Other Interest Extension": {

"Address line 1": "P.O. Box 563",

"City Name": "Reading",

"Insured's State/Province Abbreviation": "PA",

"ZIP Code": "19603"

}

{

"Interest ID Number": "002",

"Nature of Interest Code": "Lienholder",

"Additional/Other Interest Name": "CXtra Lease",

"Additional/Other Interest Extension": {

"Address line 1": "601 Harbor Blvd",

"City Name": "West Sacramento",

"Insured's State/Province Abbreviation": "CA",

The output continues...

Remarks and Attachments

Request Method: POST
Endpoint: BaseURL/per-policy/remarks-and-attachments

Description:
This endpoint is to fetch the data of available remarks and names of the attachments (if any) contained within the AL3 file. The details in it will be like Remark Number, Remark Text, Attachment Type Code, Attachment Description.

Sample Output:

policies": [

{

"Transaction Header": {

"Transaction Type": "New Business"

"Basic Insured Information": {

"Basic Policy Information": {

"Policy Number": "SPP1108052",

"Line of Business Code": "Business automobile"\

"Remarks": [{

"Remarks Number": "1",

The output continues…

Forms

Request Method: POST
Endpoint: BaseURL/per-policy/forms

Description:
This endpoint is to retrieve the data of all the related forms contained within the AL3 file. The form data includes the details like Form Name, Form Number, Form Edition Date, etc.

Sample Output:

policies": [

{

"Transaction Header": {

"Transaction Type": "New Business"

"Basic Insured Information": {

"Basic Policy Information": {

"Policy Number": "SPP1108052",

"Line of Business Code": "Business automobile",

"Forms": [

{

"Form Iteration Number": "001",

"Form Number": "300714",

"Form Name": "Policy Holders Notice",

"Form Edition Date": "01/07/2009"

{

"Form Iteration Number": "001",

"Form Number": "300807",

"Form Name": "Consumer Affairs Disclosure",

The output continues...

Carrier Questions

Request Method: POST
Endpoint: BaseURL/per-policy/general

Description:
This endpoint is to retrieve data of the questionnaire (carrier questions) contained within the AL3 file.

Sample Output:

policies": [

{

"Transaction Header": {

"Transaction Type": "Cancel/DNR Transaction Structure"

"Basic Insured Information": {

"Basic Policy Information": {

"Policy Number": "L47148438",

"Line of Business Code": "Homeowners",

"Underwriting Question": [

{

"Question Code Number14": "HODW10",

"Answer Indicator Number14": "Y",

"Question Code Number15": "HODW11",

"Answer Indicator Number15": "Y",

"Question Code Number16": "HODW12"

The output continues...

Claim History and Violations

Request Method: POST
Endpoint: BaseURL/per-policy/claim-history

Description:
This endpoint is to retrieve the history of all the previous claims and violations contained within the AL3 file. The data includes Loss Date, Loss Type, Loss Description, Claim Settled Indicator, etc.

Sample Output:

policies": [

{

"Transaction Header": {

"Transaction Type": "New Business"

"Basic Insured Information": {

"Loss History": [

{

"Loss History ID Number": "21",

"Loss Location Number": "02",

"Claim Settled Indicator": "Y",

"Catastrophe Indicator": "N",

"Total Losses Amount": "600",

"Loss Date": "01/05/2010"

The output continues...

Prior Policy Information

Request Method: POST
Endpoint: BaseURL/per-policy/prior-policy

Description:
This endpoint is to retrieve the data of Prior policy contained within the AL3 file. Here the Prior policy means, if a policy existed before the current policy then this endpoint will give the details accordingly. The details in it will be like Line of Business of Prior Policy, Policy Number, Carrier Name, Policy Expiration Date, etc.

Sample Output:

"policies": [

{

"Transaction Header": {

"Transaction Type": "New Business"

"Basic Insured Information": {

"Basic Policy Information": {

"Policy Number": "SPP1108052",

"Line of Business Code": "Business automobile",

"Prior Policy History": [

{

"Reserve Total Amount": "4213",

"Policy Terminated Reason": "The Reason",

"Policy Year": "2015",

"Full Term Premium": "+5632.25",

"Continuity Date": "05/11/2015"

The output continues…

Other Policy Information

Request Method: POST
Endpoint: BaseURL/per-policy/other-policy

Description:
This endpoint is to retrieve the data of other policies contained within the AL3 file. Here the other policy means, if Insured is having one or more policies from the same or any other company then this endpoint will give the details accordingly. For example Other Policy Number, Line of Business, Carrier Name, etc.

Sample Output:

policies": [

{

"Transaction Header": {

"Transaction Type": "New Business"

"Basic Insured Information": {

"Basic Policy Information": {

"Policy Number": "SPP1108052",

"Line of Business Code": "Business automobile",

"Other Insurance With Company": {

"Policy Number": "PSP1108052",

"Carrier NAIC Code": "15874",

"Policy Effective Date": "08/11/2015",

The output continues…

DB Commission Endpoints

Commission Summary

Request Method: POST
Endpoint: BaseURL/commission-summary

Description:

This endpoint is to retrieve the data of the Commissionary Summary contained within the AL3 file. For example Account Date, a Total number of items, Agency Contract Number, etc.

Sample Output:

policies": [
{
"Direct Bill Commission Statement Summary": [

{

"Agency Contract Number": "0009999",

"Account Date": "04/30/2017",

"Total Number of Items": "0017",

"Total Gross Amount": "+38105.00",

"Total Commission Amount": "+3465.60"

}

]

The output continues…

Commission Details

Request Method: POST
Endpoint: BaseURL/commission-details

Description:

This endpoint is to retrieve the data of the Commissionary Details contained within the AL3 file. For example NAIC code for Company, Item Number, Commission Rate, etc.

Sample Output:

policies": [

{

"Direct Bill Commission Statement Detail": [

{

"Item Number": "0001",

"Insured's Short Name": "TREVOSE FAMILY SHOE",

"Policy/Binder Number": "BSD 8936775",

"NAIC Code for Company ": "13692",

"Transaction Effective Date": "04/21/2017",

"Transaction Type Code": "Cancellation",

"Gross Amount Charged to Insured": "-64.00",

"Commission Rate": "12.000%",

"Commission Amount": "-7.68",

"Line of Business Code": "Business owners",

"Policy Effective Date": "09/07/2026",

"Policy Expiration Date": "04/28/2027"

{

"Item Number": "0002",

"Insured's Short Name": "TREVOSE FAMILY SHOE",

"Policy/Binder Number": "BSD 8936775",

"NAIC Code for Company ": "13692",

"Transaction Effective Date": "04/21/2017",

The output continues…