ACORD Standards Converter API (AL3, ACORD XML, ELabels)  

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

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

Personal Package - PKGP

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

Garage & Dealers- GARAGEC

Umbrella - UMBC

Commercial Package- PKGC

Business Owner’s Policy (BOP)-BOPC

Commercial Package with BOP- PKGC_BOPC

Agriculture/Farm Package- AGRIC

  • Agriculture/Farm Property- AGPR
  • Agriculture/Farm Scheduled & Unscheduled Personal Property- AGPP
  • Agriculture/Farm Liability- AGLIA
  • Commercial General Liability - LIABC
  • Business Automobile - AUTOC
  • Umbrella - UMBC
  • Inland Marine - INMARC
  • Homeowners- HOMEP
  • Boiler and Machinery- BMC
  • Heder Groups- HEADER_GROUPS

Introduction

WinsurTech AL3 API  makes it very easy to accomplish the following:

  1. Download Files from IVANS mailbox
  2. Convert AL3 files to JSON/CSV
  3. Create AL3 files from CSV templates
  4. Extract data and attachememnts from Claim Files

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.

Download Files from IVANS mailbox set of endpoints allow users to login to IVANS with their respective mailbox credentials (IVANS Secret Key, IVANS Client Id, Mailbox Account Name, Mailbox User Id and Mailbox Password). After login, users can fetch the details of all the files available in their respective mailbox account and then fetch each available file from the mailbox.

AL3 to JSON/CSV Endpoints make it effortless to extract various Policy data and Direct Bill Commission data from the AL3 file.

An AL3 file usually consists of various details, 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, users can extract each of the above mentioned information one by one as required.

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

  • Commission Summary Data
  • Commission Details Data

Convert CSV to ACORD AL3 Endpoints take a CSV file as an input and convert it into 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 the generated templates into an AL3 file. What users have to do is fill the available values in the “Value” column and upload the CSV back into our AL3 Creation endpoint to create the AL3 file. It is not required to fill the values for the rows that are not applicable in your case.

There are Code list endpoints and Carrier Name endpoints available to help the users further during the process of preparing the CSV. Making the entire process more effective for them.

Code List Names endpoint generates all the code list names as a response and contains al3_reference_id along with a description. Users 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.

The Carrier Details endpoint will help the users to get the details related to the Carrier. The generated output contains the Carrier Name and NAIC Code for the carrier that matches the substring entered.

 

Claims/ACORD XML to JSON Endpoints make it feasible to extract data from Claims download in JSON format, and also to extract images and documents embedded inside the Claim files. Claim files are also downloaded from the users ,respective, IVANS mailbox.

How to view AL3 file contents on UI?

To view the AL3 files on screen, users 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:

  1. 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.
  2. 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).
  3. Although Claims Download files also have .DAT or .AL3 extension but these files are in ACORD XML format not in AL3 format. Claims data is parsed by a separate product of ours. Contact us at contact@winsurtech.com  for that.
  4. AL3 files for Policies can contain a variable amount of data. Some files contain only a single policy but some files may contain large number of policies. Each policy in an AL3 file may be of a different Line of Business.
  5. Most of the AL3 files are in KBs rather than MBs. But"initial load" files from IVANS can be larger, like 2 MB or more. Our main /conversion endpoint can convert AL3 files of any size up to 1 MB. For a larger file, use our /callBack-conversion endpoint.
  6. 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.
  7. / 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.
  8. / callBack-conversion  can be used with any sized file. There are no restrictions related to file size in it.
  9. To make it easy to extract data of a specific nature, like additional interests, coverages, what is covered, etc., we provide per-policy endpoints. We call them per-policy endpoints because users can use them to retrieve data from the AL3 file for a single policy based on the policy number, though they can also be used to retrieve data for multiple policies that meet various criteria, such as all policies having the same transaction type, all policies having the same line of business, and so on.
  10. 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 hours period and the transaction id expires after this.
  11. 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:

  1. Always call /al3/conversion endpoint before calling the “per-policy” endpoints
  2. Per-policy endpoints are not applicable for the Direct Bill Commission AL3 files ( /al3/conversion endpoint is applicable in the case which will provide users the  entire output or DB Commission Endpoints which will provide the users the commission summary and commission details).
  3. “Transaction_id” that users will get in response to the /conversion  endpoint is always required for calling any per-policy endpoint
  4. From the other 3 parameters (transaction type, policy number, LOB type) the output will depend on what parameter values are passed :
  1. When none of the three parameters is passed, it will return data corresponding to the endpoint for all the policies included in the AL3 file.
  2. When,only,the lob_type is passed, it will return the data for all the policies that have the matching LOB type.
  3. When,only,the transaction_type is passed, it will return the data for all the policies that have the matching Transaction type.
  4. When,only,the policy number is passed, it will return the data for the policy that has the matching Policy Number
  5. 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


  • Import this collection to Postman. 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.


A. AL3 Parser Real Time API

Introduction

AL3 Parser Real-Time API makes it effortless for users to extract Distinct Policy Data and Direct Bill Commission Data from AL3 Files. Below mentioned are the various endpoints offered by this API.

1. Download Files From IVANS Mailbox



Description

These endpoints allow users to login to IVANS with their,respective, mailbox credentials and fetch the information of all the files available in their mailbox account and then fetch each available file from the mailbox one by one. Both Policy Transaction Files and Direct Bill Commission Files can be downloaded and fetched.

Endpoint Information

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

IVANS login

Request Method: POST
Endpoint: BaseURL /ivans/login

Description

This endpoint enables the users to get the access token from IVANS for the pupose of authorization, to access other API endpoints. Users need to provide IVANS Secret Key,IVANS Client Id,Mailbox Account Name,Mailbox User Id and Mailbox Password.After providing these details, an access_token is generated to pull files andtheir content from the mailbox.

Input Parameters

Key (Body Parameter)

Value

Default Value

mailbox_account

eg: XX88B

null

mailbox_user_id

eg: AB112YZ

null

mailbox_password

eg: Summer2010!

null

ivans_api_client_id

eg: 11AB1234-2345-12D2-A235-2AC05A12B345

null

ivans_api_client_secret

eg: 1233d254f-6e98-2df2-aa62-jc1234a2b121

null

In the Body Parameters (all required):

  • mailbox_account: User's mailbox account provided by IVANS
  • mailbox_user_id: User's mailbox user id provided by IVANS
  • mailbox_password: User's mailbox password provided by IVANS
  • ivans_api_client_id: User's API client id provided by IVANS
  • ivans_api_client_secret: User's API client secret key provided by IVANS

Postman Screenshot


Copy this access token in the pre-request script and with the help of this access token users can pull files and file content from the other two endpoints.

Pull Files Information

Request Method: GET
Endpoint: BaseURL /ivans/pull-files-info

Description

This endpoint is used to fetch details about all the files available in the IVANS mailbox. Information of the available files is returned with details like file id, original name, remote name, status date, etc. File id returned here is used to call the next endpoint to fetch the file.

Input Parameters

Key (Params Parameter)

Value

Default Value

mailbox_account

eg: XX99A

null

mailbox_user_id

eg: AB111XY

null


Postman Screenshot


Pull File Content

Request Method: GET
Endpoint: BaseURL /ivans/pull-file

Description

User can fetch details of a particular file with the help of this endpoint, by providing its file_id received in the output of pull-files-info endpoint.

In mark_as_received ,enter the value as true if you want to mark the file as received and not to show in file_info list of"Pull Files Information" endpoint in future. The default value is assumed to be false.

Input Parameters

Key (Params Parameter)

Value

Default Value

file_id

eg: 3374be-c57f-4b97-b4c6-16fde72f6e

null

mark_as_received

eg: true/false

false

Postman Screenshot


  • The file content is returned back in the output.
  • Save the file_content 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 below:

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

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


    2. Convert AL3 Files to JSON/CSV

With AL3 to JSON/AMS_MAP/AMS_MAP1/CSV/AMS_MAP_RAW API endpoints, we make it easy going to extract various types of Policy and Direct Bill Commission data from the AL3 file.

Endpoint Information

AL3 to JSON endpoints are comprised of three sets that are discussed below:

  1. Conversion & Policy Transaction Endpoints
  2. Per-Policy Information Endpoints
  3. DB Commission Endpoints

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

The suggested flow for Policy transaction files is mentioned below:

  1. Conversion - To convert the AL3 File into either JSON/AMS_MAP/AMS_MAP_RAW/AMS_MAP1 or CSV file with Zip extension. The users would get the transaction id back in case of   JSON/AMS_MAP/AMS_MAP_RAW/AMS_MAP1.
  2. Transaction Summary - To get the summary of all the transactions contained within respective AL3 files based on the transaction id obtained  through Conversion API.
  3. Per Policy Endpoints - With the help of Transaction Summary Endpoint's output, users may call these per-policy endpoints to fetch policy specific data.

The suggested flow for DB Commission files is mentioned below:

  1. Conversion - To get the transaction id back, by converting the AL3 File in either JSON or AMS_MAP or AMS_MAP_RAW or AMS_MAP1 output.
  2. DB Commission endpoints- To view the summary and details of DB Commission files.

    a. Conversion and Policy Transaction Endpoints


AL3 to JSON/CSV 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. Once this call is made, users must note down the transaction id they get back in the JSON Output, and use that id to call the per-policy endpoints to extract specific pieces of information. Nothe that Per-Policy calls are supported only for Policy Transaction AL3 Files. With the help of a single call, the output can be obtained for both Policy Transaction Files as well as Direct Bill Commission Files.

In case, the output size is 6MB or more than that, then the users will be notified in the output, regarding the same. In this scenario, the users are required to use the Download AL3 Conversion Output endpoint with the transaction id to download the output.

For package policies where multiple LOBs are packed within the same AL3 file, the output in CSV format is a zip file where each CSV has data of one sub-policy contained within the package.


Input Parameters for Al3 to CSV conversion

Key (Body Parameter)

Value

Default Value

input_file

eg: AUTOP_4_masked.al3

null

output_format

eg: CSV/ams_map/JSON/ams_map_raw/ams_map1

null

omit_blank_values

eg: true/false

true

keep_alive

eg: true/false

true

replace_code

eg: true/false

true

  • In input_file: Users upload the required AL3 file which they want to convert.
    • In output_format: Enter the desired format you want the AL3 File to convert to i.e CSV,ams_map,ams_map_raw,ams_map1 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 .
    • In keep_alive: Enter the value as true if you want the output file to be saved for 2 hours at WinsurTech end so that you could call the specific  endpoints to extract a part of the output (like Policy Summary, Insured Details, etc.) or else enter false if you want to immediately remove the  output file. The default value is assumed to be true.
    • In replace_code: Enter the value as true, if you want to replace coded values in place of descriptive values, For instance,(like  AUTOP will appear as Private Passenger Automobile, XLC will appear as Cancellation Confirmation). If false, the original code values will  appear in the output.
    • The maximum file size limit for this API is 1MB.

    Postman Screenshot

    Sample Output

     

    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 be used in order to get a hold of the summary of all the policy transaction summaries contained within the AL3 Files which just got converted. A user has to call the AL3 Conversion API,before using this endpoint, only then will it work.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

    Default Value

    transaction_id

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

    null

    Sample Output

     

    Download AL3 Conversion Output

    Request Method: GET
    Endpoint: BaseURL /download-al3-conversion-output

    Description

    If the size of the output is 6MB or more than that, then instead of direct output, users will be notified in the output regarding the same. The users are required to use this endpoint to download the output


    Postman Screenshot


    The output will be in a compressed format and users are required to save it to their disk with a filename having a .gz extension and later on decompress the file. Transaction Id is required to download the output.

    Sample Python Code to Unzip .gz Extension

     

    import gzip import shutil import requests import compress_json url = "https://apis.webnerserver.com/al3/v2/download-al3-conversion-output" payload={'transaction_id': 'nu6tbt6bt-dy56-fgh656-vdrr55-asd2345fgds'} files=[] headers = {'user-secret': 'zcv3457h-as34-df54f-12sdf-nh675cggvtfvftv'} response = requests.request("GET", url, headers=headers, data=payload, files=files) import gzip import shutil with open('geojson.gz','wb') as f: f.write(response.content) with gzip.open('geojson.gz', 'rb') as gz_in: with open('geo.json', 'wb') as json_out: shutil.copyfileobj(gz_in, json_out)

    Postman Screenshot

    For Windows, kindly use Winzip to decompress the file.

    JSON extension needs to be provided in case it is not visible after decompressing.

      b. 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.

    **Note that our server does not store the AL3 file and the JSON output is retained only for 2 hours duration. After that transaction id expires and you need to call the conversion API again to convert the file again**

    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 a 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.

    Output formats suppoted for Per-Policy Endpoints are Json, ams_map and ams_map_raw

    **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.

    key (Body Parameter)

    Value

    Default Value

    transaction_id

    eg: k895623-cv63-896L-g4d4-u33891y7e26s

    null

    lob_type

    eg: AUTOP

    null

    policy_Number

    eg: 515612

    null

    transaction_type

    eg: NBS

    null

    omit_blank_values

    eg: true/false

    true

    flatten

    eg: true/false

    false

  • in case,for conversion endpoint, if you passed omit_blank_values: true then the the per policy endpoint's output will not be affected.
    • in case,for conversion endpoint, if you passed flatten: false then the per policy endpoint's output will not be affected.
    • Insured Details

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

      Description
      This endpoint is to retrieve the Insured's data contained within the AL3 file. Related data would be like Insured's Name, Address, Country Name, City Name, Insured's Date of Birth, etc.

      Sample Output

       

      Policy Summary

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

      Description
      Use 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

       

      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

       

      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 it entails include Coverage Code, Full Term Premium, Limit Amount, Liabilities, etc

      Sample Output

       

      Additional Interests

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

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

      Sample Output

       

      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

       

      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

       

      Carrier Questions

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

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

      Sample Output

       

      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

       

      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

       

      Other Policy Information

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

      Description
      This endpoint is used to retrieve the data of other policies contained within the AL3 file. Here the other policy means, that 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

       

        c. 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 Direct Bill Commission AL3 file. For example Total Gross Amount, Total Commission Amount, Total number of items/policies, Agency Contract Number, etc.

      Sample Output

       

      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 Policy Number, Commission Rate, Commission Amount, Policy Binder Number,  etc.

      Sample Output

       

        3. Code List Names and Values

      Code List Names

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

      Description

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

      Postman Screenshot


      Code List Values

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

      Description

      This API call will generate all the code list values of the specific reference ID you have entered and you can input the required code to the CSV file from the list. Also, the value "null" is not a code value it only depicts that the value could be left blank if needed, for that you should add the value {Blank} to it not"null".

      Input Parameters

      Key (Body Parameter)

      Value

      Default Value

      reference_id

      eg: ACADC

      null

      Postman Screenshot



        4. Carrier Details

      Carrier Information

      Request Method: GET
      Endpoint: BaseURL /carrier-search

      Description

      This endpoint is gonna help the users by fetching the details about the Carrier. The generated output will comprise5 the carrier's name and the NAIC code. Users are required to enter the substring they want to search.

      Postman Screenshot



      5. API Quota Consumption Information


      a. The number of policies,in each uploaded file,is counted in case of every endpoint

      b. In case of any failed transaction the quota is increased by 1.


      B. AL3 Parser Callback API

      Introduction

      AL3 Parser Callback API is not a real-time endpoint. It converts the AL3 file in the background and POSTS the response back to the CALLBACK URL provided by the users, of their own application.This API converts Transaction Information, Insured Information, Basic Policy Information, Coverages, limits, deductibles, options, etc. Using the set of endpoints available in our API, users can extract this information one by one as required. In addition, for Direct Bill commission files users can extract Commission Summary Data and Commission Details Data.

      1. Download Files From IVANS Mailbox



      Description

      Through this endpoint, users log in to IVANS with their mailbox credentials and fetch the information of all the files available in their mailbox account and then fetch each available file from the mailbox one by one. Both policy transaction files and direct bill commission files can be downloaded and fetched.

      Endpoint Information

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

      IVANS login

      Request Method: POST
      Endpoint: BaseURL /callback/ivans/login

      Description

      This endpoint enables the users to get the access token from IVANS for the pupose of authorization, to access other API endpoints. Users need to provide IVANS Secret Key,IVANS Client Id,Mailbox Account Name,Mailbox User Id and Mailbox Password.After providing these details, an access_token is generated to pull files andtheir content from the mailbox.

      Input Parameters

      Key (Body Parameter)

      Value

      Default Value

      mailbox_account

      eg: RR44A

      null

      mailbox_user_id

      eg: YB333CJ

      null

      mailbox_password

      eg: Summer2010!

      null

      ivans_api_client_id

      eg: 11AB1234-2345-12D2-A235-2AC05A12B345

      null

      ivans_api_client_secret

      eg: 1233d254f-6e98-2df2-aa62-jc1234a2b121

      null

      In the Body Parameters (all required):

      • mailbox_account: User's mailbox account provided by IVANS
      • mailbox_user_id: User's mailbox user id provided by IVANS
      • mailbox_password: User's mailbox password provided by IVANS
      • ivans_api_client_id: User's API client id provided by IVANS
      • ivans_api_client_secret: User's API client secret key provided by IVANS

      Postman Screenshot


      Copy this access token in the pre-request script and with the help of this access token users can pull files and file content from the other two endpoints.

      Pull Files Information

      Request Method: GET
      Endpoint: BaseURL /callback/ivans/pull-files-info

      Description

      This endpoint is used to get information about all the files available in the IVANS mailbox. Information of the available files is returned with details like file id, original name, remote name, status date, etc. The file Id returned here is used to call the following endpoint to fetch the file.

      Input Parameters

      Key (Params Parameter)

      Value

      Default Value

      mailbox_account

      eg: ZZ82B

      null

      mailbox_user_id

      eg: DV566XY

      null

      Postman Screenshot

      Pull File Content

      Request Method: GET
      Endpoint: BaseURL /callback/ivans/pull-file

      Description

      This endpoint is used to download a particular file by providing its file_id received in the output of pull-files-info endpoint. In mark_as_received ,enter the value as true if you want to mark the file as received and not to show in file_info list of "Pull Files Information" endpoint in future. The default value is assumed to be false.

      Input Parameters

      Key (Params Parameter)

      Value

      Default Value

      file_id

      eg: 3374be83-c57f-4b97-b4c6-16fde72f6e6f

      null

      mark_as_received

      eg: false

      false

      Postman Screenshot

      • The file content is returned back in the output.
      • Save the file_content 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 below:

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

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


      2. Convert AL3 Files to JSON/CSV

      With AL3 to JSON/AMS_MAP/CSV/AMS_MAP_RAW API endpoints, we make it easy going to extract various types of Policy and Direct Bill Commission data from the AL3 file.

      Endpoint Information

      AL3 to JSON endpoints are comprised of three sets that are discussed below:

      1. Conversion & Policy Transaction Endpoints
      2. Per-Policy Information Endpoints
      3. DB Commission Endpoints

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

      The suggested flow for Policy transaction files is mentioned below:

      1. Conversion - To convert the AL3 File into either JSON/AMS_MAP/AMS_MAP_RAW or CSV file with Zip extension. The users would get the transaction id back in case of   JSON/AMS_MAP/AMS_MAP_RAW.
      2. Transaction Summary - To get the summary of all the transactions contained within respective AL3 files based on the transaction id obtained  through Conversion API.
      3. Per Policy Endpoints - With the help of Transaction Summary Endpoint's output, users may call these per-policy endpoints to fetch policy specific data.

      The suggested flow for DB Commission files is mentioned below:

      1. Conversion - To get the transaction id back, by converting the AL3 File in either JSON or AMS_MAP or AMS_MAP_RAW output.
      2. DB Commission endpoints- To view the summary and details of DB Commission files.

          a. Conversion and Policy Transaction Endpoints

        Callback Conversion

        Request Method: POST
        EndPoint: BaseURL /callBack-conversion

        Description
        This endpoint converts the Al3 file into JSON/ams_map/ams_map_raw/ams_map1/excel. This endpoint provides the users with a complete response in these formats. This endpoint is to be used if your file is more than 1 MB since the conversion endpoint will support the file less than or equal to 1 MB. So if you are looking forward to converting files of size larger than 1MB you may call /callBack-conversion endpoint. Also, you are required to give the callback URL as input to this endpoint since the response so generated will be displayed and stored on the URL you entered.

        Key (Body Parameter)

        Value

        Default Value

        input_file

        eg: AUTOP_4_masked.al3

        null

        output_format

        eg: JSON/ams_map/ams_map_raw/ams_map1/excel

        null

        callback_url

        eg: https://google.com

        null

        omit_blank_values

        eg: true/false

        true

        keep_alive

        eg: true/false

        false

        replace_code

        eg: true/false

        true

        • In input_file: Users need to upload the AL3 File, they want to convert
          • In output_format: Users may opt for either JSON or ams_map or ams_map_raw or ams_map1 or excel.
          • In callback_url: The URL where the users are looking forward to storing 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 .
          • In keep_alive:Enter the value as true if you want to keep the transaction Id alive else enter false. The default value is assumed to be false.
          • In replace_code: Enter the value as true if you are looking forward to replacing coded values with descriptive ones, else enter false. The default value is assumed to be true.
          • Postman Screenshot

          Callback Conversion S3 Output

          Request Method: POST
          EndPoint: BaseURL /callBack-conversion-s3output

          Description
          This endpoint converts the AL3 File into JSON or ams_map or ams_map_raw or ams_map or ams_map1 or excel and will display the complete response in the required format. This endpoint is to be used if your file size is more than 1 MB since the /conversion endpoint will support the file less than or equal to 1 MB. So if you want to convert files of size higher than 1MB you may call /callBack-conversion-s3output endpoint.

          Key (Body Parameter)

          Value

          Default Value

          input_file

          eg: HOMEP_6_masked.al3

          null

          output_format

          eg: JSON/ams_map/ams_map_raw/ams_map1/excel

          null

          notification_url

          eg: https://83hg65yhlobs56lrclnknkjviud56ojlk0okpag.lambda-url.us-east-1.on.aws/al3/v2/callbackTesing

          null

          omit_blank_values

          eg: true/false

          true

          s3_bucket_url

          eg: callback-response

          null

          aws_acces_key

          eg: DFGHYWE59KL66P

          null

          aws_access_secret

          eg: tjkd6rTYa6lSRu5R5SRPzL+BoPj2rcUyxL9bHJrty

          null

          folder_path

          eg: json_files/

          null

          keep_alive

          eg: true/false

          true

          replace_code

          eg: true/false

          true

          • In input_file: Users need to upload the AL3 File, they want to convert
            • In output_format: Users may opt for either JSON or ams_map or ams_map_raw or ams_map1 or excel.
            • In notification_url: URL in which users will be informed about parsed file
            • 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 .
            • In s3_bucket_url: Name of the s3 bucket
            • In aws_acces_key: Users are required to provide the aws access key
            • In aws_access_secret: Users are required to provide the aws secret key
            • In folder_path: The folder path in which users want to store their file.
            • In keep_alive: Enter the value as true if you want to keep the transaction Id alive else enter false. The default value is assumed to be true.
            • In replace_code: Enter the value as true if you are looking forward to replacing coded values with descriptive ones, else enter false. The default value is assumed to be true.
            • Postman Screenshot

            Callback Conversion S3

            Request Method: POST
            EndPoint: BaseURL /callback-conversion-s3

            Description
            The users need to provide their input file's URL from S3 Bucket. Consequently, this endpoint will help the users by providing them the desired output in the required format.

            Input Parameters

            Key (Body Parameter)

            Value

            Default Value

            input_file_url

            eg: https://s3Conversion.sd.nsaff4598

            null

            output_format

            eg: JSON/ams_map/ams_map_raw/ams_map1/excel

            null

            keep_alive

            eg: true/false

            true

            replace_code

            eg: true/false

            true

            omit_blank_values

            eg: true/false

            true

          • In input_file_URL: Users need to provide the required file’s URL.
          • In output_format: Enter the desired putput format among JSON,ams_map,ams_map_raw,ams_map1 and excel.
          • In keep_alive: Enter the value as trueif you want the output file to be saved for 2 hours at the WinsurTech end so that you could call the specific endpoints to extract a part of the output (like Policy Summary, Insured Details, etc.) or else enter false if you want to remove the output file immediately. The default value is true.
          • In replace_code: Enter the value as true if you want to replace coded values with descriptive values, For instance(AUTOP will appear as Private Passenger Automobile, and XLC will appear as Cancellation Confirmation). If false, the original code values will appear in the output.
          • 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

             

            Callback Conversion Azure

            Request Method: POST
            EndPoint: BaseURL /callback-conversion-azure

            Description
            The users need to provide their input file's URL from Azure, and along with it, they need to provide the required access key. Consequently, this endpoint will help the users by providing them the desired output in the required format.

            Input Parameters

            Key (Body Parameter)

            Value

            Default Value

            input_file_url

            eg:https://wbstesting.MRB.JJD.SKJF_100.al3

            null

            account_key

            eg: 1sjngjskJHdUIKNQOEJPOJKWQPEK123==

            null

            output_format

            eg: JSON/ams_map/ams_map_raw/ams_map1/excel

            null

            omit_blank_values

            eg: true/false

            true

            keep_alive

            eg: true/false

            true

            replace_code

            eg: true/false

            true

          • In input_file_URL: Users need to provide the required file’s URL.
          • In account_key: Users need to provide the access key
          • In output_format: Enter the desired putput format among JSON,CSV,ams_map,ams_map_raw,ams_map1 or excel.
          • In keep_alive: Enter the value as true if you want the output file to be saved for 2 hours at the WinsurTech end so that you could call the specific endpoints to extract a part of the output (like Policy Summary, Insured Details, etc.) or else enter false if you want to remove the output file immediately. The default value is true.
          • In replace_code: Enter the value as true if you want to replace coded values with descriptive values, For instance(AUTOP will appear as Private Passenger Automobile, and XLC will appear as Cancellation Confirmation). If false, the original code values will appear in the output.
          • 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

            Callback Transaction Status

            Request Method: POST
            EndPoint: BaseURL /get-callback-transaction-status

            Description
            This endpoint will let the users know about the transaction’s status,i.e., whether the transaction is passed or failed.

            Postman Screenshot

            Callback Transaction Output

            Request Method: POST
            EndPoint: BaseURL /get-callback-transaction-output

            Description
            This endpoint will display the entire output in the requested format. If a users wants to view the output in JSON format, than the entire output is going to be displayed in the desired format.

            Postman Screenshot

            Policy Transaction Summary

            Request Method: POST
            EndPoint: BaseURL /callback/all-transaction-summary

            Description
            This endpoint is used to fetch the summary of all the policy transactions contained within the AL3 file that the users just converted. From “summary“ the meaning is, that only the following parameters for each policy transaction will be returned in the JSON output:
            - Policy Number
            - LOB Type
            - Transaction Type

            Postman Screenshot


            b. 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.

      **Note that our server does not store the AL3 file and the JSON output is retained only for 2 hours duration. After that transaction id expires and you need to call the conversion API again to convert the file again**

      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 a 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

      Output formats suppoted for Per-Policy Endpoints are Json, ams_map and ams_map_raw

      **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.


      Key (Body Parameter)

      Value

      Default Value

      transaction_id

      eg: 98833ce8-f1bb-4e65-bffd-844296ef2e36

      null

      lob_type

      eg: FLOOD

      null

      policy_Number

      eg: 56-546541-237816

      null

      transaction_type

      eg: PCH

      null

      omit_blank_values

      eg: true/false

      true

      flatten

      eg: true/false

      false

      • in case,for conversion endpoint, if you passed omit_blank_values: true then the the per policy endpoint's output will not be affected.
        • in case,for conversion endpoint, if you passed flatten: false then the per policy endpoint's output will not be affected.

        • Insured Details

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

          Description
          This endpoint is to retrieve the data related to insured , contained within the AL3 file. Related data will consist: Insured’s Name, Address, Country Name, City Name, Insured's Date of Birth, and various information related to the Insured.

        • Users may fill in the details of all the three parameters i.e., policy_number, lob_type and transaction_type. They may even fill either the combination of mentioned paramaeters or may fill in a single parameter. The output will be generated accordingly.
        • Sample Output

           

          Policy Summary

          Request Method: POST
          Endpoint: BaseURL /callback/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.

          • Users may fill in the details of all the three parameters i.e., policy_number, lob_type and transaction_type. They may even fill either the combination of mentioned paramaeters or may fill in a single parameter. The output will be generated accordingly.
          • Sample Output

             

            Covered Items with Locations

            Request Method: POST
            Endpoint: BaseURL /callback/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.

            • Users may fill in the details of all the three parameters i.e., policy_number, lob_type and transaction_type. They may even fill either the combination of mentioned paramaeters or may fill in a single parameter. The output will be generated accordingly.
            • Sample Output

               

              Coverages

              Request Method: POST
              Endpoint: BaseURL /callback/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

              • Users may fill in the details of all the three parameters i.e., policy_number, lob_type and transaction_type. They may even fill either the combination of mentioned paramaeters or may fill in a single parameter. The output will be generated accordingly.
              • Sample Output

                 

                Additional Interests

                Request Method: POST
                Endpoint: BaseURL /callback/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, and much more.

                • Users may fill in the details of all the three parameters i.e., policy_number, lob_type and transaction_type. They may even fill either the combination of mentioned paramaeters or may fill in a single parameter. The output will be generated accordingly.
                • Sample Output

                   

                  Remarks and Attachments

                  Request Method: POST
                  Endpoint: BaseURL /callback/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, etc, and Attachment Description.

                  • Users may fill in the details of all the three parameters i.e., policy_number, lob_type and transaction_type. They may even fill either the combination of mentioned paramaeters or may fill in a single parameter. The output will be generated accordingly.
                  • Sample Output

                     

                    Forms

                    Request Method: POST
                    Endpoint: BaseURL /callback/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.

                    • Users may fill in the details of all the three parameters i.e., policy_number, lob_type and transaction_type. They may even fill either the combination of mentioned paramaeters or may fill in a single parameter. The output will be generated accordingly. .
                    • Sample Output

                       

                      Carrier Questions

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

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

                      • Users may fill in the details of all the three parameters i.e., policy_number, lob_type and transaction_type. They may even fill either the combination of mentioned paramaeters or may fill in a single parameter. The output will be generated accordingly.

                      • Sample Output

                         

                        Claim History and Violations

                        Request Method: POST
                        Endpoint: BaseURL /callback/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.

                        • Users may fill in the details of all the three parameters i.e., policy_number, lob_type and transaction_type. They may even fill either the combination of mentioned paramaeters or may fill in a single parameter. The output will be generated accordingly.
                        • Sample Output

                           

                          Prior Policy Information

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

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

                          • Users may fill in the details of all the three parameters i.e., policy_number, lob_type and transaction_type. They may even fill either the combination of mentioned paramaeters or may fill in a single parameter. The output will be generated accordingly.
                          • Sample Output

                             

                            Other Policy Information

                            Request Method: POST
                            Endpoint: BaseURL /callback/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, that 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.

                            • Users may fill in the details of all the three parameters i.e., policy_number, lob_type and transaction_type. They may even fill either the combination of mentioned paramaeters or may fill in a single parameter. The output will be generated accordingly.
                            • Sample Output

                               

                                c. DB Commission Endpoints

                              Commission Summary

                              Request Method: POST
                              Endpoint: BaseURL /callback/commission-summary

                              Description

                              This endpoint is used to retrieve the data of the Commissionary Summary contained within the DBC or AL3 File. For example Total Gross Amount, Total Commission Amount, Total number of items/policies, Agency Contract Number, etc.

                              Sample Output

                               

                              Commission Details

                              Request Method: POST
                              Endpoint: BaseURL /callback/commission-details

                              Description

                              This endpoint is used to fetch all the commissionary details contained within the AL3 File that the user just converted.

                              Sample Output

                               

                                3. Code List Names and Values


                              Code List Names

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

                              Description

                              This API call will generate all the code list names, the response comprises 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)

                              Postman Screenshot



                              Code List Values

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

                              Description

                              This API call will generate all the code list values of the specific reference ID you have entered and you can input the required code to the CSV file from the list. Also, the value"null" is not a code value it only depicts that the value could be left blank if needed, for that you should add the value {Blank} to it not"null".


                              Input Parameters

                              Key (Body Parameter)

                              Value

                              Default Value

                              reference_id

                              eg: CBPUR

                              null

                              Postman Screenshot


                                4. Carrier Details

                              Carrier Information

                              Request Method: GET
                              Endpoint: BaseURL /callback/carrier-search

                              Description:
                              This endpoint will help you to get the information about the Carrier. The Output will comprise of both the carrier's name and the NAIC code.

                              Sample Output

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


                                5. API Quota Consumption Information


                              a. These endpoints count the number of policies in each file that is uploaded. For example: If you convert an AL3 file with 10 policies, 10 will be added to your previously used quota after you make the call.

                              b. This calculation is done for all the endpoints. In case of a failed transaction, the used quota is increased by 1.


                              C. AL3 Creator Real Time API

                              Introduction

                              AL3 Creator Real Time API takes a CSV file as an input and converts 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. All you have to do is fill available values in the “Value” column and upload the CSV back into our AL3 Creation endpoint to create the AL3 file. No need to fill values for the rows not applicable in your case.There are Code list endpoints and Carrier Name endpoints to help you further during the process of preparing the CSV.

                              AL3 Creation Process is comprised of two steps:

                              1. Template Generation & AL3 Creation: By using the endpoint (Template Generation) available in this collection users 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).

                              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

                              Personal Package - PKGP

                              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

                              Garage & Dealers- GARAGEC

                              Umbrella - UMBC

                              Commercial Package- PKGC

                              Business Owner’s Policy (BOP)-BOPC

                              Commercial Package with BOP- PKGC_BOPC

                              Agriculture/Farm Package- AGRIC

                              • Agriculture/Farm Property- AGPR
                              • Agriculture/Farm Scheduled & Unscheduled Personal Property- AGPP
                              • Agriculture/Farm Liability- AGLIA
                              • Commercial General Liability - LIABC
                              • Business Automobile - AUTOC
                              • Umbrella - UMBC
                              • Inland Marine - INMARC
                              • Homeowners- HOMEP
                              • Boiler and Machinery- BMC
                              • Heder Groups- HEADER_GROUPS

                              1. Create AL3 Files from CSV



                              Endpoint Information

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

                              a. Template Generation & AL3 Creation

                              Generate CSV Template

                              Request Method: GET
                              Endpoint: BaseURL /template

                              Description:
                              This endpoint enables the users to get the Template for their required LOB. For Instance, if a user has to create an AL3 file for an AUTOP transaction, pass the AUTOP LOB. By default, CSV is generated for a single transaction. But users can pass any value for the Transaction Count. A user can pass a variable count of up to 50 if he or she has to pack data of multiple transactions in the same AL3 File. AL3 File also contains some Header Groups which surround the actual data. If users are not comfortable with the AL3 structure, keep the headgroups parameter to ‘No’ as our code can automatically add the header groups & elements with blank values. If users want to set data in header group elements also then pass it as Yes. By default, the value is 'No'. By default, the full format is set to false since we give you a shorter simpler template of most common elements only for a particular LOB. AL3 File can contain several hundreds of elements and it may be confusing for your team but if you want the full format pass full_format=yes.


                              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

                              Personal Package - PKGP

                              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

                              Garage & Dealers - GARAGEC

                              Umbrella - UMBC

                              Commercial Package - PKGC

                              Business Owner’s Policy (BOP) - BOPC

                              Commercial Package with BOP - PKGC_BOPC

                              Agriculture/Farm Package- AGRIC

                              • Agriculture/Farm Property- AGPR
                              • Agriculture/Farm Scheduled & Unscheduled Personal Property- AGPP
                              • Agriculture/Farm Liability- AGLIA
                              • Commercial General Liability - LIABC
                              • Business Automobile - AUTOC
                              • Umbrella - UMBC
                              • Inland Marine - INMARC
                              • Homeowners- HOMEP
                              • Boiler and Machinery- BMC
                              • Heder Groups- HEADER_GROUPS

                              Boiler & Machinery - BMC

                              Header Groups - HEADER_GROUPS

                              Input Parameters

                              Key (Body Parameter)

                              Value

                              Default Value

                              LOB

                              eg: PKGP

                              null

                              transaction_count

                              eg: 25

                              null

                              header_groups

                              eg: true/false

                              false

                              full_format

                              eg: true/false

                              false

                              • In LOB: To obtain the required template, users must enter the required Line Of Business Code.
                                • In transaction_count: Users are required to enter the required number of transactions. By default transaction count is 1. The users can add upto 50 transacations,maximum.
                                • In header_groups: If true, it will include the header group elements in the generated template as well.
                                  • In full_format: 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.

                                  • Postman screenshot

                                    • 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 or .zip  extension in case of package policies.
                                    • 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 received from our Template API call (fill whatever data you have and leave the rest of it blank, do not change the template columns or rows). 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 only which are needed only once even if you pack multiple transactions in the same AL3 file. For getting the template (CSV file) for the HEADER groups use the LOB = HEADER_GROUPS with the Generate CSV Template API. 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 .AL3 or .DAT. If you test the API over RapidAPI or Postman you can manually copy and paste the content into notepad and save it with a .AL3 or .DAT file extension to test.

                                    Input Parameters

                                    Key (Body Parameter)

                                    Value

                                    Default Value

                                    input_file

                                    eg: .csv/.zip

                                    null

                                    input_header_file

                                    eg: any header file

                                    null

                                    contains_pkg_or_bopc

                                    eg: true/false

                                    null

                                    is_strict_mode

                                    eg: on/off

                                    off

                                    • In is_strict_mode user can also fill true/false, yes/no or Y/N apart from on/off
                                    • Postman Screenshot

                                      • 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.

                                      2. Code List Names and Values

                                      Code List Names

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

                                      Description

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

                                      Postman Screenshot

                                      Code List Values

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

                                      Description

                                      This API call will generate all the code list values of the specific reference ID you have entered and you can input the required code to the CSV file from the list. Also, the value "null" is not a code value it only depicts that the value could be left blank if needed, for that you should add the value {Blank} to it not "null".

                                      Input Parameters

                                      Key (Body Parmaeter)

                                      Value

                                      Default Value

                                      reference_id

                                      eg: INTCD

                                      null

                                      Postman Screenshot

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

                                      3. Carrier Details

                                      Carrier Information

                                      Request Method: GET
                                      Endpoint: BaseURL /al3creator/carrier-search

                                      Description:
                                      This endpoint will help users to get all the essential details about the Carrier. The generated output contains the Carrier Name and NAIC Code for the carrier that matches the substring entered.

                                      Postman Screenshot


                                          4. API Quota Consumption Information


                                        a. For the Generation of CSV TEMPLATE Endpoint, the quota used is increased by 1.

                                        b. Create AL3 File Endpoint counts the number of Policies (Transactions) that are being converted into a single AL3 file.
                                        For instance, If a user converts a file with 10 policies (transactions), 10 will be added to the user’s previously used quota after they convert the file to AL3.


                                        D. Claims Messages and eDocs API

                                        Introduction

                                        Claims, Messages, and eDocs API makes it possible to extract data from Claims download file to JSON format with easy to understad JSON keys, and also to extract images and documents embedded inside the Claim files.

                                        1. Claims/Acord XML to Json



                                        Description
                                        With the help of these endpoints Claims Messages and other eDocs can be converted into JSON format, effortlessly. Along with this, users are able to pull the required attachments.

                                        Conversion to Json

                                        Request Method: POST
                                        EndPoint: BaseURL /acord-xml/conversion-to-json

                                        Description
                                        This endpoint enables the users to convert Claims/ACORD XML files into JSON output format making it easy for the users to understand the content contained within the Claims/ACORD XML files. A unique attachment Id will be provided once the users convert their Claims/ACORD XML Files into their desired format. This attachment Id is used to extract the attachment files present in the user's provided input file.

                                        Input Parameters

                                        Key (Body Parameter)

                                        Value

                                        Default Value

                                        input_file

                                        eg: xyz.dat

                                        null

                                        replace_code

                                        eg: true/false

                                        true

                                        • In the Body Parameters (all required): Input_file: Upload a valid Claims/ACORD XML file.
                                        • replace_code: Enter the value as true if you want to replace coded values with descriptive values. otherwise enter false in case the coded value is required. The default value is assumed to be true.

                                        Sample JSON for ActivityNoteRs file:

                                         

                                        Sample JSON for AlertDownloadRs file:

                                         

                                        Sample JSON for ClaimDownloadRs file:

                                         

                                        Pull Attachment

                                        Request Method: GET
                                        Endpoint: BaseURL /acord-xml/attachment

                                        Description

                                        This endpoint is used to extract a particular attachment file from a Claims/ACORD XML file using the unique attachment_id received in the output. The attachment is saved in a zip format.

                                        Input Parameters

                                        Key (Body Parameter)

                                        Value

                                        Default Value

                                        transaction_id

                                        eg: 1aa4a459-050b-4126-90f6-333bc507f30a

                                        null

                                        attachment_id

                                        eg: 8971fea0-e4ac-4c54-9bc6-5b926dc9c2b

                                        null

                                        delete_after_fetch

                                        eg: true/false

                                        false

                                          In the Body Parameter:
                                        • transaction_id (required): Transaction id getting from “Conversion to Json” api endpoint in elabel json output.
                                        • attachment_id (required): Attachment id getting from “Conversion to Json” api endpoint in elabel json output.
                                        • delete_after_fetch (optional): True, if you want to download the attachment only once.

                                          2. API Quota Consumption Information


                                        a. For Conversion to Json Endpoint the used quota is increased by the number of Requests. For example: If you convert a file with 10 requests, then 10 will be added to your previously used quota after you make the call.


                                        b. For Pull Attachment Endpoint the used quota is updated by 1 for every call. In case of a failed transaction, the used quota is increased by 1.


                                        To check your used limit go to Subscriptions