NAV Navbar
(701) 538-8394
  • Introduction
  • Authentication
  • Account
  • 228-861-6369
  • Policies
  • Users
  • 732-754-7228
  • Quote
  • Sample Request Payloads
  • 431-301-4802
  • Introduction

    Welcome to Attune's API documentation.

    Authentication

    Authenticate requests to the API by setting the X-AUTH-TOKEN header with your secret token. To get a secret token, use the login and/or refresh endpoints, documented below. Tokens expire quickly, so you should generally use the refresh endpoint liberally to make sure you have a fresh, valid token.

    All endpoints require authentication, unless otherwise specified.

    Account

    These endpoints are used to retrieve create Insured Accounts. Insured Accounts are used to create BOP quotes.

    Retrieve account details

    Example Request

    new Request("/test.myattune.com/bookingServices/v1/pc/account?accountNumber=1234567890&user=jsnow@example.com", {
      method: "GET",
      headers: { "X-AUTH-TOKEN": "itsasecret" },
    });
    

    Selected Response Headers

    HTTP/1.1 200 OK
    Access-Control-Expose-Headers: X-AUTH-TOKEN
    Content-Type: application/json;charset=UTF-8
    

    Example Response

    {
      "return": {
        "Account": {
          "AccountHolderContact": {
            "entity-Person": null,
            "AddressBookUID": null,
            "EmailAddress1": "tcs@example.com",
            "Name": "Example Account Name",
            "PrimaryAddress": {
              "AddressLine1": "123 W Something Ave",
              "AddressLine2": null,
              "AddressType": "business",
              "City": "Athens",
              "County": null,
              "PostalCode": "30601",
              "State": "GA"
            },
            "Subtype": "Company",
            "WorkPhone": "1231231234"
          },
          "AccountNumber": "1234567890",
          "AccountOrgType": "individual",
          "AllPoliciesSummary_HUSA": {
            "Entry": [
              {
                "AccountNumber": "1234567890",
                "CancellationDate": null,
                "InsuredDisplayName": "Example Account Name",
                "Job": {
                  "IsIndicativeQuote_HUSA": true,
                  "JobNumber": "0005455454",
                  "QuoteName_HUSA": "Test Quote",
                  "UpdateTime": 1520969436718
                },
                "LatestPeriodStatus_HUSA": "Quoted",
                "PeriodEnd": 1552449660000,
                "PeriodStart": 1520913660000,
                "PolicyNumber": null,
                "PolicyPackageDocLine_HUSA": "",
                "ProducerName": "AABB",
                "Product": {
                  "DisplayName": "Commercial Excess Liability Policy"
                },
                "QuotePackageDocLine_HUSA": "",
                "QuoteRequestHistories_HUSA": {
                  "Entry": [
                    {
                      "QuoteName_HUSA": "Example Account Name Quote",
                      "RequestID": "0001234567",
                      "Subtype": "QuoteRequestHistory_HUSA",
                      "TransactionType": "Declined"
                    }
                  ]
                },
                "Status": "Quoted",
                "TotalCostRPT": 350
              },
            ]
          },
          "IndustryCode": null,
          "IssuedPoliciesAsArray": null,
          "MathedBusinessName_HUSA": null,
          "DoesBusinessAs_HUSA": "ABC Cool Sprockets",
          "OFACStatus_HUSA": "NO",
          "ProducerCodes": {
            "Entry": [
              {
                "ProducerCode": {
                  "Code": "SIATEST00001"
                }
              }
            ]
          },
          "QuoteRequestHistories_HUSA": {
            "Entry": [
              {
                "QuoteName_HUSA": null,
                "RequestID": "0012345678",
                "Subtype": "QuoteRequestHistory_HUSA",
                "TransactionType": "Quoted"
              },
            ]
          }
        }
      }
    }
    

    This endpoint retrieves Insured Account details.

    Required Query Parameters

    Key Value
    user the username for the Insured Account
    accountNumber the account number for the Insured Account

    Required Request Headers

    Key Value
    X-AUTH-TOKEN your authentication token

    Get account list

    Example Request

    new Request("/test.myattune.com/bookingServices/v1/pc/account/filter", {
      method: "POST",
      headers: {
        "X-AUTH-TOKEN": "itsasecret",
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        userName: "jsnow@xample.com",
        start: 0,
        limit: 100,
        accountSearchCriterialModel: {
          AccountSearchCriteria: {
            FirstNameExact: false,
            LastNameExact: false,
          }
        }
      })
    });
    

    Selected Response Headers

    HTTP/1.1 200 OK
    Access-Control-Expose-Headers: X-AUTH-TOKEN
    Content-Type: application/json;charset=UTF-8
    

    Example Response

    {
        "return": {
            "Entry": [
                {
                    "Account": {
                        "AccountHolderContact": {
                            "entity-Person": {
                                "FirstName": "Travis",
                                "LastName": "Touchdown"
                            },
                            "AddressBookUID": null,
                            "EmailAddress1": "travis@no.more.heroes",
                            "Name": null,
                            "PrimaryAddress": {
                                "AddressLine1": "111 Jackson blvd",
                                "AddressLine2": null,
                                "AddressType": "business",
                                "City": "Santa Destroy",
                                "County": null,
                                "PostalCode": "90221",
                                "State": "CA"
                            },
                            "Subtype": "Person",
                            "WorkPhone": "5552559876"
                        },
                        "AccountNumber": "15058462",
                        "AccountOrgType": "commonownership",
                        "AllPoliciesSummary_HUSA": {
                            "Entry": [
                                {
                                    "AccountNumber": "15058462",
                                    "CancellationDate": null,
                                    "InsuredDisplayName": "travis touchdown",
                                    "Job": {
                                        "IsIndicativeQuote_HUSA": false,
                                        "JobNumber": "0000270735",
                                        "QuoteName_HUSA": "Quote Test Name",
                                        "UpdateTime": 1517137205137
                                    },
                                    "LatestPeriodStatus_HUSA": "Expired",
                                    "PeriodEnd": 1544677260000,
                                    "PeriodStart": 1513141260000,
                                    "PolicyNumber": null,
                                    "PolicyPackageDocLine_HUSA": "",
                                    "ProducerName": "SIAA",
                                    "Product": {
                                        "DisplayName": "Businessowners (v7)"
                                    },
                                    "QuotePackageDocLine_HUSA": "",
                                    "QuoteRequestHistories_HUSA": {
                                        "Entry": [
                                            {
                                                "QuoteName_HUSA": "Some old quote",
                                                "RequestID": "3f930125-8941-4c35-9e3a-b21993f281d6",
                                                "Subtype": "QuoteRequestHistory_HUSA",
                                                "TransactionType": "Draft"
                                            }
                                        ]
                                    },
                                    "Status": "Expired",
                                    "TotalCostRPT": null
                                }
                            ]
                        },
                        "IndustryCode": null,
                        "IssuedPoliciesAsArray": null,
                        "MathedBusinessName_HUSA": null,
                        "OFACStatus_HUSA": "NO",
                        "QuoteRequestHistories_HUSA": {
                            "Entry": [
                                {
                                    "QuoteName_HUSA": "Some old quote",
                                    "RequestID": "3f930125-8941-4c35-9e3a-b21993f281d6",
                                    "Subtype": "QuoteRequestHistory_HUSA",
                                    "TransactionType": "Draft"
                                }
                            ]
                        },
                        "QuoteStatuses_HUSA": {
                            "Declined": 0,
                            "Draft": 0,
                            "InForce": 0,
                            "InProgress": 1,
                            "Quoted": 0
                        }
                    }
                }
            ]
        }
    }
    

    This endpoint retrieves Insured Accounts based on search criteria.

    Required Request Headers

    Key Value
    Content-Type "application/json"
    X-AUTH-TOKEN itsasecret

    Request Body Fields

    Field Data Type Required? Description
    accountSearchCriterialModel.AccountSearchCriteria.AccountNumber String No Exact account number of an account to match
    accountSearchCriterialModel.AccountSearchCriteria.AddressLine1 String No Partial Address Line 1 of an account to match
    accountSearchCriterialModel.AccountSearchCriteria.AddressLine2 String No Exact Address Line 2 of an account to match
    accountSearchCriterialModel.AccountSearchCriteria.City String No Partial City of an account to match
    accountSearchCriterialModel.AccountSearchCriteria.CompanyName String No Partial or exact Name of an account to match
    accountSearchCriterialModel.AccountSearchCriteria.CompanyNameExact Boolean No Specify if CompanyName match is exact or partial
    accountSearchCriterialModel.AccountSearchCriteria.Country String No Exact Country of an account to match. Uses ISO-2 country codes
    accountSearchCriterialModel.AccountSearchCriteria.FirstName String No Partial or exact First Name of an account to match
    accountSearchCriterialModel.AccountSearchCriteria.FirstNameExact Boolean No Specify if FirstName match is exact or partial
    accountSearchCriterialModel.AccountSearchCriteria.LastName String No Partial or exact Last Name of an account to match
    accountSearchCriterialModel.AccountSearchCriteria.LastNameExact Boolean No Specify if LastName match is exact or partial
    accountSearchCriterialModel.AccountSearchCriteria.PostalCode String No Partial Postal Code of an account to match
    accountSearchCriterialModel.AccountSearchCriteria.State String No Exact State of an account to match. Uses state codes such as "FL"
    limit Number No The maximum number of accounts to return in the response
    start Number No The starting cursor of records to return (think "offset")
    userName String No No apparent use.

    Create a new account

    Example Request

    new Request("/test.myattune.com/bookingServices/v1/pc/account/create", {
      method: "POST",
      headers: {
        "X-AUTH-TOKEN": "itsasecret",
        "Content-Type": "application/json"
      },
      body: JSON.stringify({
        accountModel: {
          Account: {
            AccountHolderContact: {
              EmailAddress1: 'jsnow@example.com',
              Name: 'Company ABC',
              PrimaryAddress: {
                AddressLine1: '123 Greene St.',
                AddressLine2: '2nd Fl',
                AddressType: 'Business',
                City: 'New York',
                PostalCode: '10007',
                State: 'NY',
              },
              Subtype: 'Company',
              WorkPhone: '917-555-1212',
            },
            AccountOrgType: 'corporation',
            DoesBusinessAs_HUSA: 'ABC Cool Sprockets',
          }
        }
      })
    });
    

    Selected Response Headers

    HTTP/1.1 200 OK
    Access-Control-Expose-Headers: X-AUTH-TOKEN
    Content-Type: application/json;charset=UTF-8
    

    Example Response

    {
        "return": {
            "Account": {
                "AccountHolderContact": {
                    "entity-Person": null,
                    "AddressBookUID": null,
                    "EmailAddress1": "jsnow@example.com",
                    "Name": "Company ABC",
                    "PrimaryAddress": {
                        "AddressLine1": "123 Greene St.",
                        "AddressLine2": "2nd Fl",
                        "AddressType": "business",
                        "City": "New York",
                        "County": null,
                        "PostalCode": "10007",
                        "State": "NY"
                    },
                    "Subtype": "Company",
                    "WorkPhone": "9175551212"
                },
                "AccountNumber": "4410137812",
                "AccountOrgType": "corporation",
                "IndustryCode": null,
                "MathedBusinessName_HUSA": null,
                "DoesBusinessAs_HUSA": "ABC Cool Sprockets",
                "OFACStatus_HUSA": "NO",
                "ProducerCodes": {
                    "Entry": [
                        {
                            "ProducerCode": {
                                "Code": "SIATEST00011"
                            }
                        }
                    ]
                },
                "QuoteRequestHistories_HUSA": null,
                "TSRequestID_HUSA": null
            }
        }
    }
    

    This endpoint creates an Insured Account.

    Required Request Headers

    Key Value
    Content-Type "application/json"
    X-AUTH-TOKEN itsasecret

    Request Body Fields

    Field Data Type Required? Description
    accountModel.Account.AccountHolderContact.entityPerson.FirstName String No MyAttune does not send this.
    accountModel.Account.AccountHolderContact.entityPerson.LastName String No MyAttune does not send this.
    accountModel.Account.AccountHolderContact.AddressBookUID Unknown (UUID?) No MyAttune does not send this.
    accountModel.Account.AccountHolderContact.EmailAddress1 String Yes This is the email address of the Insured Account contact.
    accountModel.Account.AccountHolderContact.Name String Yes First and Last name of the of the Insured Account contact.
    accountModel.Account.AccountHolderContact.PrimaryAddress.AddressLine1 String Yes For the Insured Account contact.
    accountModel.Account.AccountHolderContact.PrimaryAddress.AddressLine2 String No For the Insured Account contact.
    accountModel.Account.AccountHolderContact.PrimaryAddress.AddressType String Yes Always set to 'Business'.
    accountModel.Account.AccountHolderContact.PrimaryAddress.City String Yes For the Insured Account contact.
    accountModel.Account.AccountHolderContact.PrimaryAddress.PostalCode String Yes For the Insured Account contact.
    accountModel.Account.AccountHolderContact.PrimaryAddress.State String Yes Two letter state code.
    accountModel.Account.AccountHolderContact.Subtype String Yes Always set to 'Company'.
    accountModel.Account.AccountHolderContact.WorkPhone String Yes In the format of xxx-xxx-xxxx
    accountModel.Account.AccountNumber Unknown (int?) No Only seems required for updates.
    accountModel.Account.AccountOrgType String Yes One of
    • commonownership
    • corporation
    • executortrustee
    • government
    • individual
    • jointventure
    • limitedpartnership
    • llc
    • llp
    • nonprofit
    • other
    • partnership
    • religious
    • solepropship
    • trustestate
    accountModel.Account.IndustryCode.Code Unknown No Does not seem relevant to Specialty.
    accountModel.Account.IndustryCode.Domain Unknown No Does not seem relevant to Specialty.
    accountModel.Account.TSRequestID_HUSA UUID No This is just for already-persisted accounts.
    accountModel.Account.QuoteRequestHistories_HUSA Array This is just for already-persisted accounts.
    accountModel.Account.DoesBusinessAs_HUSA String No Alternative name for the business.
    accountModel.Account.MathedBusinessName_HUSA String No Does not seem relevant to Specialty.
    userName Does not seem relevant to Specialty No No apparent use.

    Login

    Log in & retrieve token

    Example Request

    const loginParams = new URLSearchParams({
      username: 'jsnow@example.com',
      password: 'password123'
    });
    
    new Request("/test.myattune.com/bookingServices/login", {
      method: "POST",
      headers: { "Content-Type": "application/x-www-form-urlencoded" },
      body: loginParams
    });
    

    Selected Response Headers

    HTTP/1.1 200 OK
    Access-Control-Expose-Headers: X-AUTH-TOKEN
    X-AUTH-TOKEN: itsasecret
    Content-Type: text/plain; charset=UTF-8
    

    Example Response

    "John"
    

    This endpoint is used to authenticate a user against the list of approved users. In this context, a "user" is an insurance-broker who will create Quotes on behalf of their Insured Accounts.

    If the request was successful and the user exists in the system, the response headers will contain an X-AUTH-TOKEN that should be used to authenticate requests made by this user, and the response body will simply be the user's first name.

    The X-AUTH-TOKEN value is used throughout the application to verify requests are made by a logged-in user.

    Required Request Headers

    Key Value
    Content-Type "application/x-www-form-urlencoded"

    Required Request Body Params

    Key Value
    username string
    password string

    Policies

    Get Policies

    Example Request

    new Request("/test.myattune.com/bookingServices/v1/pc/AllPolicyperiods", {
      method : "POST",
      headers : {
        "X-AUTH-TOKEN" : "itsasecret",
        "Content-Type" : "application/json",
      },
      data : {
        policySearchCriteria: {
          PolicySearchCriteria : {
            "AccountNumber" : "1",
            "PolicyNumber" : "P0L1CY-NUMB3R",
            "SearchObjectType" : "Submission"
          }
        }
      }
    });
    

    Selected Response Headers

    HTTP/1.1 200 OK
    Content-Type: application/json; charset=utf-8
    

    Example Response

    {
      "return" : {
        "Entry" : [
          {
            "PolicyPeriodSummaryPOGO" : {
              "AccountNumber" : "0123456789",
              "AssociatedPolicyPeriods" : null,
              "BaseState" : "FL",
              "CancellationDate" : null,
              "ExcessEligible" : false,
              "InsuredName" : "Hedy Lamarr",
              "IsIndicativeQuote" : false,
              "JobNumber" : "0001234567",
              "PaymentPlanID" : "onepay_husa",
              "PeriodEnd" : 1544418060000,
              "PeriodStart" : 1512882060000,
              "PolicyNumber" : "112233445",
              "ProducerName" : "SIAA",
              "ProductDisplayName" : "SpecialtyXS",
              "QuoteName" : null,
              "SpecialtyPolicyLimit" : "$1,000,000",
              "Status" : "InForce",
              "TotalCostRPT" : 500,
              "TotalPremiumRPT" : 500,
              "UpdateTime" : 1512687201478
            }
          }
        ]
      }
    }
    

    This endpoint is used to retrieve details of a specific Policy for an Insured Account.

    If the User is logged in and has a valid auth token, and the request was successful, the response body will be a JSON Object containing an Array of Objects containing individual Policy details.

    Required Request Headers

    Key Value
    X-AUTH-TOKEN itsasecret
    Content-Type application/json

    PolicySearchCriteria Fields

    Field Data Type Description
    AccountNumber string Not Required - Unique ID of the Insured Account
    PolicyNumber string Unique Policy number
    SearchObjectType string Not Required - The type of Job in GuideWire

    Response Body Fields

    Field Data Type Description
    return { object Wrapper object for response
         Entry [ array Array of individual Policy details
             {
                 PolicyPeriodSummaryPOGO object Wrapper object for Policy details
                 {
                     AccountNumber string Unique number for the Insured Account who owns the Policy
                     AssociatedPolicyPeriods array Array of summaries of any associated Specialty Excess Policies
                     BaseState string Account-level US state for the Insured Account
                     CancellationDate number Numerical representation of when the Policy was cancelled
                     ExcessEligible boolean Whether this Policy is eligible for Specialty Excess?
                     InsuredName string Name associated with the Insured Account?
                     IsIndicativeQuote boolean Used for MainStreet Excess to indicate if the Quote is an initial quote with basic information
                     JobNumber string Unique identifier for the Quote
                     PaymentPlanID string Indicates Policy payment plan from HUSA
                     PeriodEnd number Numerical representation of the end of the Policy period
                     PeriodStart number Numerical representation of the start of the Policy period
                     PolicyNumber string Unique identifier for this Policy
                     ProducerName string The Organization of the broker who bound the Policy
                     ProductDisplayName string The product of the Policy (eg: BOP, MainStreet Excess)
                     QuoteName string Identified for a Quote
                     SpecialtyPolicyLimit string Limit of the Policy in comma-separated dollar amount
                     Status string The status of the Policy (Ex: "Quoted", "Bound", etc)
                     TotalCostRPT number Total cost for the Policy and taxes
                     TotalPremiumRPT number Premium for the Policy
                     UpdateTime number Numerical representation of when the Policy was last updated
                 }
             }
         ]
    }

    Users

    Get User

    Example Request

    new Request("/test.myattune.com/bookingServices/v1/user/user", {
      method: "GET",
      headers: { "X-AUTH-TOKEN": "itsasecret" },
    });
    
    

    Selected Response Headers

    Access-Control-Expose-Headers: X-AUTH-TOKEN
    

    Example Response

    {
        "firstName": "Shuri",
        "husaUserName": "shuri.wright",
        "lastName": "Wright",
        "producer": "imaproducer",
        "userName":"shuri.wright"
    }
    

    This endpoint is used to retrieve information about a logged-in User. In this context, a User is an insurance-broker who will create Quotes on behalf of their Insured Accounts.

    If the User exists in the system, is logged in and has a valid auth token, and the request was successful, the response body will be JSON containing the User's firstName, husaUserName, lastName, userName, and producer attributes.

    Required Request Headers

    Key Value
    X-AUTH-TOKEN itsasecret

    Refresh User

    Example Request

    new Request("/test.myattune.com/bookingServices/v1/user/refresh", {
      method: "GET",
      headers: { "X-AUTH-TOKEN": "itsasecret" },
    });
    
    

    Selected Response Headers

    Access-Control-Expose-Headers: X-AUTH-TOKEN
    X-AUTH-TOKEN: itsatotallynewsecret
    

    Example Response

    {
        "firstName": "Shuri",
        "husaUserName": "shuri.wright",
        "lastName": "Wright",
        "producer": "imaproducer",
        "userName": "shuri.wright"
    }
    

    This endpoint is used to refresh a logged-in User's X-AUTH-TOKEN. The response contains the new X-AUTH-TOKEN in the headers and information about a logged-in User in the body.

    If the User exists in the system, is logged in and has a valid auth token, and the request was successful, the response body will be JSON containing the User's firstName, husaUserName, lastName, userName, and producer attributes.

    The X-AUTH-TOKEN value is used throughout the application to verify requests are made by a logged-in User.

    Required Request Headers

    Key Value
    X-AUTH-TOKEN itsasecret

    Invoice

    Retrieve invoice details

    Example Request

    new Request("/test.myattune.com/bookingServices/v1/invoice/getinvoicedetails", {
      method: "POST",
      headers: { "Content-Type": "application/json" },
      body: '{ "invoiceId": "INVOICE_ID", "eTransID": "TRANSACTION_ID" }'
    });
    

    Selected Response Headers

    HTTP/1.1 200 OK
    Access-Control-Expose-Headers: X-AUTH-TOKEN
    Content-Type: application/json;charset=UTF-8
    

    Example Response

    {
       "return": {
          "InvoiceResDto": {
             "InvoiceDetails": {
                "InvoiceItems": {
                   "Entry": [
                      {
                         "LineOfBusiness" : "Commercial Excess Liability Policy",
                         "ChargeType" : "Policy Issuance Premium",
                         "InvoiceItemAmount" : 600,
                         "PolicyNumber" : "testPolicyCom"
                      }
                   ]
                },
                "eTransID": "TRANSACTION_ID",
                "AgentName": "Flower-3-Eagle",
                "InvoiceDueOn": 1522209600000,
                "TotalChargesOutstandingAmount": 2528.02,
                "TotalInvoiceAmountDue": 904,
                "InvoiceNumber": "INVOICE_ID",
                "AccountNumber": "Satellite-2-Bass",
                "UnbilledAmount": 799.98
             },
             "ResponseCode": "Sucess",
             "ResponseMessage": null
          }
       }
    }
    

    This endpoint is used to retrieve Invoice details.

    Request Body Fields

    Key Value
    invoiceID the id of the Invoice
    accountNumber the transaction id of the Invoice

    Required Request Headers

    Key Value
    Content-Type application/json

    Response Body Fields

    Field Data Type Description
    return { object Wrapper object for response
         InvoiceResDto { object Wrapper object for response
             InvoiceDetails { object Top Level Details of Invoice
                 InvoiceItems { object Individual Invoice Items
                     Entry [ array Array of Individual Invoice Items
                         {
                             LineOfBusiness string Line Of Business of Invoice Item
                             ChargeType string Description of Invoice Item Charge
                             InvoiceItemAmount number Invoice Item Amount
                             PolicyNumber string Policy number corresponding to Invoice Item
                         }
                     ]
                 }
                 eTransID string Transaction ID Submitted With Request
                 AgentName string Name of the agent
                 InvoiceDueOn number Unix Timestamp of Invoice Due Date
                 TotalChargesOutstandingAmount number Total outstanding charges for Insured Account
                 TotalInvoiceAmountDue number Amount due for this invoice
                 InvoiceNumber string Invoice ID submitted with request
                 AccountNumber string Insured Account Number of Invoice
                 UnbilledAmount number Unbilled Amount of Invoice
             }
             ResponseCode string Status of Response
             ResponseMessage unknown Unknown
         }
    }

    Quote

    Submit Quote

    Example Request

    new Request("/test.myattune.com/bookingServices/submission/quote", {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        "X-AUTH-TOKEN": "itsasecret"
      },
      body: '<QUOTE OBJECT GOES HERE>'
      / documentation for this object can be found in the Sample Request Payloads section of the documentation
    });
    

    Selected Response Headers

    HTTP/1.1 200 OK
    Content-Type: application/json;charset=utf-8
    

    Example Response on Success

    {
      "return": {
        "SubmissionResponse": {
          "SubmissionResults": {
            "Entry": [
              {
                "Period": {
                  "AllCosts": {
                    "Entry": [
                      {
                        "ActualAmount_amt": 119,
                        "Coverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine:117106"
                        },
                        "DisplayName": "Business Liability coverage on Businessowners Line"
                      },
                      {
                        "ActualAmount_amt": 20,
                        "Coverable": {
                          "TypeIDString": "entity.BP7Building:117306"
                        },
                        "DisplayName": "Wind coverage on 1: Building, 1: Location"
                      },
                      {
                        "ActualAmount_amt": 8.25,
                        "Coverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine:117106"
                        },
                        "DisplayName": "StateFee: New York Fire Insurance Fee"
                      },
                      {
                        "ActualAmount_amt": 336,
                        "Coverable": {
                          "TypeIDString": "entity.BP7Classification:116806"
                        },
                        "DisplayName": "Business Personal Property on 1: Dental Offices, 1: Building, 1: Location"
                      },
                      {
                        "ActualAmount_amt": 23,
                        "Coverable": {
                          "TypeIDString": "entity.BP7Building:117306"
                        },
                        "DisplayName": "Equipment Breakdown Coverage (Including Electronic Circuitry Impairment) coverage on 1: Building, 1: Location"
                      },
                      {
                        "ActualAmount_amt": 110,
                        "Coverable": {
                          "TypeIDString": "entity.BP7Classification:116806"
                        },
                        "DisplayName": "Classification Additional Coverage on 1: Dental Offices, 1: Building, 1: Location"
                      },
                      {
                        "ActualAmount_amt": 271,
                        "Coverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine:117106"
                        },
                        "DisplayName": "Line Additional Coverage coverage on Businessowners Line"
                      }
                    ]
                  },
                  "CosOptions": null,
                  "Forms": {
                    "Entry":[
                      {
                        "FormDescription": "Fungus Bacteria And Mold Exception – New York",
                        "FormNumber_HUSA": "SM 02 01 05 15"
                      },
                      {
                        "FormDescription": "Aluminum Wiring Exclusion",
                        "FormNumber_HUSA": "SM 10 12 02 16"
                      },
                      {
                        "FormDescription": "Windstorm Or Hail Percentage Deductibles",
                        "FormNumber_HUSA": "SM 03 01 05 15"
                      },
                      {
                        "FormDescription": "PolicyHolder Disclosure Acceptance/Rejection of Terrorism Insurance Coverage Notice of Terrorism",
                        "FormNumber_HUSA": "HU 01 04 03 15"
                      },
                      {
                        "FormDescription": "Asbestos Exclusion",
                        "FormNumber_HUSA": "SM 21 02 05 15"
                      },
                      {
                        "FormDescription": "Computer Fraud And Funds Transfer Fraud",
                        "FormNumber_HUSA": "BP 05 47 01 10"
                      },
                      {
                        "FormDescription": "Abuse Or Molestation Exclusion",
                        "FormNumber_HUSA": "BP 04 39 07 02"
                      },
                      {
                        "FormDescription": "Spoilage Coverage",
                        "FormNumber_HUSA": "BP 04 15 01 10"
                      },
                      {
                        "FormDescription": "Business Liability Coverage - Property Damage Liability Deductible (Per Occurrence Basis)",
                        "FormNumber_HUSA": "BP 07 04 01 06"
                      },
                      {
                        "FormDescription": "New York Changes",
                        "FormNumber_HUSA": "BP 01 15 09 15"
                      },
                      {
                        "FormDescription": "Service Of Suit",
                        "FormNumber_HUSA": "HU 01 05 05 15"
                      },
                      {
                        "FormDescription": "Fraud Statement",
                        "FormNumber_HUSA": "IL N 001 09 03"
                      },
                      {
                        "FormDescription": "Businessowners Policy Declarations",
                        "FormNumber_HUSA": "SM DS 01 01 10"
                      },
                      {
                        "FormDescription": "Equipment Breakdown Coverage (Including Electronic Circuitry Impairment)",
                        "FormNumber_HUSA": "HU 10 03 05 15"
                      },
                      {
                        "FormDescription": "Common Policy Declarations - Schedule",
                        "FormNumber_HUSA": "HU DS 13 05 15"
                      },
                      {
                        "FormDescription": "Exclusion Of Certified Acts Of Terrorism",
                        "FormNumber_HUSA": "BP 05 24 01 15"
                      },
                      {
                        "FormDescription": "Businessowners Enhancement – New York",
                        "FormNumber_HUSA": "SM 04 09 05 15"
                      },
                      {
                        "FormDescription": "Professional Medical Services Exclusion",
                        "FormNumber_HUSA": "SM 21 04 06 16"
                      },
                      {
                        "FormDescription": "Fire Department Service Contract",
                        "FormNumber_HUSA": "BP 12 02 07 02"
                      },
                      {
                        "FormDescription": "Business Liability Coverage - Property Damage Liability Deductible (Per Claim Basis)",
                        "FormNumber_HUSA": "BP 07 03 01 06"
                      },
                      {
                        "FormDescription": "New York Hurricane, Windstorm Or Hail   Deductible Notice",
                        "FormNumber_HUSA": "HU N 115 05 15"
                      },
                      {
                        "FormDescription": "Employment-Related Practices Exclusion",
                        "FormNumber_HUSA": "BP 04 17 01 10"
                      },
                      {
                        "FormDescription": "New York - Exclusion Of Loss Due To Virus Or Bacteria Advisory Notice To Policyholders",
                        "FormNumber_HUSA": "BP P 007 01 07"
                      },
                      {
                        "FormDescription": "U.S. Treasury Department's Office Of Foreign Assets Control (\"Ofac\") Advisory Notice To Policyholders",
                        "FormNumber_HUSA": "IL P 001 01 04"
                      },
                      {
                        "FormDescription": "Policyholder Notice",
                        "FormNumber_HUSA": "HU 01 06 03 15"
                      },
                      {
                        "FormDescription": "Total Pollution Exclusion With A Building Heating Equipment Exception And A Hostile Fire Exception",
                        "FormNumber_HUSA": "BP 04 93 01 06"
                      },
                      {
                        "FormDescription": "Common Policy Declarations",
                        "FormNumber_HUSA": "HU DS 05 05 15"
                      },
                      {
                        "FormDescription": "Businessowners Coverage Form",
                        "FormNumber_HUSA": "BP 00 03 01 10"
                      },
                      {
                        "FormDescription": "New York Changes - Calculation Of Premium",
                        "FormNumber_HUSA": "BP 15 01 01 10"
                      },
                      {
                        "FormDescription": "Signature Endorsement",
                        "FormNumber_HUSA": "HU DS 06 05 15"
                      }
                    ]
                  },
                  "Job": {
                    "JobNumber": "0007430009"
                  },
                  "PolicyNumber": null,
                  "PolicyPackageDocLink_HUSA": null,
                  "QuoteLetterCombinedDocLink_HUSA": "",
                  "QuoteLetterDocLink_HUSA": "/mfrplxhmtapd01.hamiltonusa.corp:8080/pc/service/ViewQuoteProposalLetterForm?jobNumber=0007430009",
                  "RequestID_HUSA": null,
                  "Status": "Quoted",
                  "TotalCostRPT": "198.00 usd",
                  "TotalPremiumRPT": "188.00 usd",
                  "TotalTaxesAndFees_HUSA": "10.00 usd",
                  "UWIssuesIncludingSoftDeleted": null,
                  "ValidQuote": true
                },
                "ValIssues":null
              }
            ]
          }
        }
      }
    }
    

    Example Response on Failure

    {
      "return": {
        "SubmissionResponse": {
          "SubmissionResults": {
            "Entry": [
              {
                "Period": {
                  "AllCosts": null,
                  "CosOptions": null,
                  "Forms": null,
                  "Job": {
                    "JobNumber": "0001333769"
                  },
                  "PolicyNumber": null,
                  "PolicyPackageDocLink_HUSA": null,
                  "QuoteLetterCombinedDocLink_HUSA": "",
                  "QuoteLetterDocLink_HUSA": "\/\/mfrplxhmtapd01.hamiltonusa.corp:8080\/pc\/service\/ViewQuoteProposalLetterForm?jobNumber=",
                  "RequestID_HUSA": null,
                  "Status": "Draft",
                  "TotalCostRPT": null,
                  "TotalPremiumRPT": null,
                  "TotalTaxesAndFees_HUSA": "0 usd",
                  "UWIssuesIncludingSoftDeleted": {
                    "Entry": [
                      {
                        "ApprovalValue": null,
                        "IssueType": {
                          "APIDisplayMessage": "Quote has been blocked as an underwriting question is answered incorrectly",
                          "APIDisplayPriority": "max",
                          "Code": "SXSUWQuestionsReferral",
                          "Comparator": "None"
                        },
                        "ShortDescription": "Insured has a total loss more than $500k in aggregate in past 5 years"
                      },
                      {
                        "ApprovalValue": null,
                        "IssueType": {
                          "APIDisplayMessage": "Quote declines due to inappropriate answer to an underwriting question",
                          "APIDisplayPriority": "Max",
                          "Code": "SXSUWQuestionsDecline",
                          "Comparator": "None"
                        },
                        "ShortDescription": "Answered No to : Are the local facilties in compliance with all local and state building codes ?"
                      }
                    ]
                  },
                  "ValidQuote": false
                },
                "ValIssues": {
                  "Entry": [
                    {
                      "Level": "default",
                      "Reason": "Underlying policy period should overlap with Excess period.",
                      "Type": "error"
                    },
                    {
                      "Level": "default",
                      "Reason": "The selected limit for GL does not meet our minimum required limits. If you'd like to proceed please revise the selected limits.",
                      "Type": "error"
                    }
                  ]
                }
              }
            ]
          }
        }
      }
    }
    

    This endpoint takes a payload of parameters related to creating a Quote, and returns the result of the submission.

    If a Quote is successfully returned from the submission, the response will contain multiple Coverages and their amounts, relevant forms, a Quote number (JobNumber), and costs for the Quote.

    If a Quote is not made successfully, the response will be structured similarly, but with different information in the top-level Entry array, including objects that represent the underwriting issues with the submission.

    Request Body

    Documentation for an example Quote request payload is located here

    Required Request Headers

    Key Value
    X-AUTH-TOKEN your authentication token

    Response Body Fields (on success)

    Field Data Type Description
    return { object
         SubmissionResponse { object
             SubmissionResults { object
                 Entry [ array
                     { object
                         Period { object
                             AllCosts { object
                                 Entry [ array
                                     { object
                                         ActualAmount_amt number
                                         Coverable { object
                                             TypeIdString string
                                         }
                                         DisplayName string
                                     }
                                     ...
                                 ]
                             }
                             CosOptions null
                             Forms { object
                                 Entry [ array
                                     { object
                                         FormDescription string
                                         FormNumber_HUSA string
                                     }
                                     ...
                                 ]
                             }
                             Job { object
                                 JobNumber string
                             }
                             PolicyNumber null Null for Quote.
                             PolicyPackageDocLink_HUSA null
                             QuoteLetterCombinedDocLink_HUSA string
                             QuoteLetterDocLink_HUSA string
                             RequestID_HUSA null
                             Status string
                             TotalCostRPT string
                             TotalPremiumRPT string
                             TotalTaxesAndFees_HUSA string
                             UWIssuesIncludingSoftDeleted null Null for successful Quote.
                             ValidQuote boolean
                         }
                         ValIssues null Null for successful Quote.
                     }
                 ]
             }
         }
    }

    Response Body Fields (on failure)

    Field Data Type Description
    ...
                 Entry [ array
                     { object
                         Period { object
                             AllCosts null
                             CosOptions null
                             Forms null
                             Job { object
                                 JobNumber string
                             }
                             PolicyNumber null
                             PolicyPackageDocLink_HUSA null
                             QuoteLetterCombinedDocLink_HUSA string This link has an empty query parameter for the Job Number
                             QuoteLetterDocLink_HUSA string
                             RequestID_HUSA null
                             Status string The status for a failed Quote will be "Draft"
                             TotalCostRPT string
                             TotalPremiumRPT null
                             TotalTaxesAndFees_HUSA string
                             UWIssuesIncludingSoftDeleted { object
                                 Entry [ array
                                     { object
                                         Approval Value null
                                         Issue Type { object
                                             APIDisplayMessage string
                                             APIDisplayPriority string
                                             Code string
                                             Comparator string
                                         }
                                         ShortDescription string
                                     }
                                     ...
                                 ]
                             }
                             ValidQuote boolean
                         }
                         ValIssues { object
                             Entry [ array
                                 {
                                     Level string
                                     Reason string
                                     Type string
                                 }
                                 ...
                             ]
                         }
                     }
                 ]
    ...

    Get Wind deductible options

    Example Request

    new Request("/sandbox.myattune.com/bookingServices/v1/pc/submission/windoptions", {
      method: "POST",
      headers: {
        "X-AUTH-TOKEN": "itsasecret",
        "Content-Type": "application/json"
      },
      body: JSON.stringify(
        {  
         "windDeductibleRequestModel":{  
            "WindDeductibleRequest":{  
               "BuildingState":"NJ",
               "ConstructionType":"FrameConstruction",
               "MilesToOcean":"16",
               "PropertyDeductible":1000
            }
         }
      }
    });
    
    

    Selected Response Headers

    Access-Control-Expose-Headers: X-AUTH-TOKEN
    

    Example Response

    {  
       "return":{  
          "WindDeductibleResponse":{  
             "Options":{  
                "Entry":[  
                   {  
                      "DollarAmountDeductible":null,
                      "PercentDeductible":"NotApplicable"
                   },
                   {  
                      "DollarAmountDeductible":"10000",
                      "PercentDeductible":"5%"
                   },
                   {  
                      "DollarAmountDeductible":"10000",
                      "PercentDeductible":"6%"
                   },
                   {  
                      "DollarAmountDeductible":"5000",
                      "PercentDeductible":"3%"
                   },
                   {  
                      "DollarAmountDeductible":"5000",
                      "PercentDeductible":"4%"
                   },
                   {  
                      "DollarAmountDeductible":"10000",
                      "PercentDeductible":"9%"
                   },
                   {  
                      "DollarAmountDeductible":"10000",
                      "PercentDeductible":"10%"
                   },
                   {  
                      "DollarAmountDeductible":"10000",
                      "PercentDeductible":"7%"
                   },
                   {  
                      "DollarAmountDeductible":"10000",
                      "PercentDeductible":"8%"
                   },
                   {  
                      "DollarAmountDeductible":"2500",
                      "PercentDeductible":"1%"
                   },
                   {  
                      "DollarAmountDeductible":"2500",
                      "PercentDeductible":"2%"
                   }
                ]
             }
          }
       }
    }
    

    This endpoint is used to retrieve wind deductible percentage and dollar amout based on the location state, proximity to ocean and construction type. This API needs to be used to populate wind values for Building wind coverage (BP7BuildWind_HUSA) clause. The response indicates the percentage value as well as dollar amount deductible for each percentage value. Only percentage value can be selected by user and the corresponding dollar amount deductible needs to be sent in the quote request.

    Required Request Headers

    Key Value
    X-AUTH-TOKEN itsasecret

    Request POST Parameters

    Describe query parameters here.

    Parameter Data Type Required? Description
    { object Wrapper object for request
         windDeductibleRequestModel:{ object Wrapper object for request
             WindDeductibleRequest:{ object Wrapper object for request entity
                 BuildingState string Y Two letter state code for this building state
                 ConstructionType string Y Construction type from the construction type table below.
                 MilesToOcean string Y Miles to Ocean code from the prefill response (1-16)
                 PropertyDeductible string Y Property deductible selected for this location. This corresponds to the BP7LocationPropertyDeductibles > Base deductible selected
             }
         }
    }

    Response Body Fields

    Field Data Type Description
    { object Wrapper object for response
         return:{ object Wrapper object for response
             WindDeductibleResponse:{ object Wrapper object for response
                 Options:{ object Wrapper object for response
                 Entry:[ array array object for response
                         { object object for response entries
                             DollarAmountDeductible. array Dollar amount corresponding to this percentage deductible
                             PercentDeductible: array Percentage option, value should be used as it is including '%'symbol
                         }
                 }
             }
         }
    }

    Get EQ deductible options

    Example Request

    new Request("/sandbox.myattune.com/bookingServices/v1/pc/submission/earthquakecovparams", {
      method: "POST",
      headers: {
        "X-AUTH-TOKEN": "itsasecret",
        "Content-Type": "application/json"
      },
      body: JSON.stringify(
        {  
         "earthQuakeCovParamsRequestModel":{  
            "EarthQuakeCovParamsRequest":{  
               "EarthquakeMMI100Year":"3.0",
               "EarthquakeSoilType":"Soft Rock",
               "State":"NJ"
            }
         }
        }
    });
    
    

    Selected Response Headers

    Access-Control-Expose-Headers: X-AUTH-TOKEN
    

    Example Response

    {  
       "return":{  
          "EarthQuakeCovParamsResponse":{  
             "DeductibleOptions":{  
                "Entry":[  
                   {  
                      "OptionCode":"1",
                      "OptionDescription":"1%"
                   },
                   {  
                      "OptionCode":"3",
                      "OptionDescription":"3%"
                   },
                   {  
                      "OptionCode":"5",
                      "OptionDescription":"5%"
                   },
                   {  
                      "OptionCode":"10",
                      "OptionDescription":"10%"
                   },
                   {  
                      "OptionCode":"20",
                      "OptionDescription":"20%"
                   },
                   {  
                      "OptionCode":"25",
                      "OptionDescription":"25%"
                   },
                   {  
                      "OptionCode":"1000",
                      "OptionDescription":"$1,000"
                   },
                   {  
                      "OptionCode":"2000",
                      "OptionDescription":"$2,000"
                   },
                   {  
                      "OptionCode":"5000",
                      "OptionDescription":"$5,000"
                   },
                   {  
                      "OptionCode":"10000",
                      "OptionDescription":"$10,000"
                   },
                   {  
                      "OptionCode":"25000",
                      "OptionDescription":"$25,000"
                   },
                   {  
                      "OptionCode":"50000",
                      "OptionDescription":"$50,000"
                   },
                   {  
                      "OptionCode":"75000",
                      "OptionDescription":"$75,000"
                   },
                   {  
                      "OptionCode":"100000",
                      "OptionDescription":"$100,000"
                   }
                ]
             },
             "Eligible":true,
             "EQSubLimitCapacity":5000000.00
          }
       }
    }
    

    This endpoint is used to retrieve EQ deductible options based on the location state, EarthquakeMMI100Year and EarthquakeSoilType. This API needs to be used to populate EQ values when EQ coverage is selected. EarthquakeMMI100Year and EarthquakeSoilType are returned in prefill response.

    Required Request Headers

    Key Value
    X-AUTH-TOKEN itsasecret

    Request POST Parameters

    Describe query parameters here.

    Parameter Data Type Required? Description
    { object Wrapper object for request
         earthQuakeCovParamsRequestModel:{ object Wrapper object for request
             EarthQuakeCovParamsRequest:{ object Wrapper object for request entity
                 EarthquakeMMI100Year string Y EarthquakeMMI100Year from prefill response
                 EarthquakeSoilType string Y EarthquakeSoilType from prefill response
                 State string Y State
             }
         }
    }

    Response Body Fields

    Field Data Type Description
    { object Wrapper object for response
         return:{ object Wrapper object for response
             EarthQuakeCovParamsResponse:{ object Wrapper object for response
                 DeductibleOptions:{ object Wrapper object for response
                 Entry:[ array array object for response
                         { object object for response entries
                             OptionCode. string Option code to be sent in payload for quote , in coverage pattern BP7EQSubLimitLocation_HUSA and term pattern BP7PercentageDeductible
                             OptionDescription string Option code description to be displayed in UI
                         }
                             Eligible boolean Is this location eligible for this coverage?
                             EQSubLimitCapacity string Sub limit available for this risk, to be sent in quote request, in coverage pattern BP7EQSubLimitLocation_HUSA and term pattern BP7EQSubLimitCapacity
                 }
             }
         }
    }

    Get EQ Sprinkler leakage deductible options

    Example Request

    new Request("/sandbox.myattune.com/bookingServices/v1/pc/submission/sprinklerleakeqcovparams", {
      method: "POST",
      headers: {
        "X-AUTH-TOKEN": "itsasecret",
        "Content-Type": "application/json"
      },
      body: JSON.stringify(
        {  
         "sprinkLeakCovParamsRequestModel":{  
            "SprinklerLeakageCovParamsRequest":{  
               "EarthquakeMMI100Year":"3.0",
               "EarthquakeSoilType":"Soft Rock",
               "State":"NJ"
            }
         }
        } 
    });
    
    

    Selected Response Headers

    Access-Control-Expose-Headers: X-AUTH-TOKEN
    

    Example Response

    {  
       "return":{  
          "SprinklerLeakageCovParamsResponse":{  
             "DeductibleOptions":{  
                "Entry":[  
                   {  
                      "OptionCode":"1",
                      "OptionDescription":"1%"
                   },
                   {  
                      "OptionCode":"3",
                      "OptionDescription":"3%"
                   },
                   {  
                      "OptionCode":"5",
                      "OptionDescription":"5%"
                   },
                   {  
                      "OptionCode":"10",
                      "OptionDescription":"10%"
                   },
                   {  
                      "OptionCode":"20",
                      "OptionDescription":"20%"
                   },
                   {  
                      "OptionCode":"25",
                      "OptionDescription":"25%"
                   },
                   {  
                      "OptionCode":"1000",
                      "OptionDescription":"$1000"
                   },
                   {  
                      "OptionCode":"2000",
                      "OptionDescription":"$2000"
                   },
                   {  
                      "OptionCode":"5000",
                      "OptionDescription":"$5000"
                   },
                   {  
                      "OptionCode":"10000",
                      "OptionDescription":"$10000"
                   },
                   {  
                      "OptionCode":"25000",
                      "OptionDescription":"$25000"
                   },
                   {  
                      "OptionCode":"50000",
                      "OptionDescription":"$50000"
                   },
                   {  
                      "OptionCode":"75000",
                      "OptionDescription":"$75000"
                   },
                   {  
                      "OptionCode":"100000",
                      "OptionDescription":"$100000"
                   },
                   {  
                      "OptionCode":"ineligible",
                      "OptionDescription":"N/A-ineligible"
                   }
                ]
             },
             "Eligible":true,
             "SLSubLimitCapacity":5000000.00
          }
       }
    }
    

    This endpoint is used to retrieve EQ sprinkler coverage deductible options based on the location state, EarthquakeMMI100Year and EarthquakeSoilType. This API needs to be used to populate EQ values when EQ coverage is selected. EarthquakeMMI100Year and EarthquakeSoilType are returned in prefill response.

    Required Request Headers

    Key Value
    X-AUTH-TOKEN itsasecret

    Request POST Parameters

    Describe query parameters here.

    Parameter Data Type Required? Description
    { object Wrapper object for request
         earthQuakeCovParamsRequestModel:{ object Wrapper object for request
             EarthQuakeCovParamsRequest:{ object Wrapper object for request entity
                 EarthquakeMMI100Year string Y EarthquakeMMI100Year from prefill response
                 EarthquakeSoilType string Y EarthquakeSoilType from prefill response
                 State string Y State
             }
         }
    }

    Response Body Fields

    Field Data Type Description
    { object Wrapper object for response
         return:{ object Wrapper object for response
             EarthQuakeCovParamsResponse:{ object Wrapper object for response
                 DeductibleOptions:{ object Wrapper object for response
                 Entry:[ array array object for response
                         { object object for response entries
                             OptionCode. string Option code to be sent in quote request, in coverage pattern BP7LocSprinklerLeakageEQExtISO_HUSA and term pattern BP7SLPercentageDeductibleISO_HUSA, or for corresponding clase for non ISO states
                             OptionDescription string Option code description to be displayed in UI
                         }
                             Eligible boolean Is this location eligible for this coverage?
                             SLSubLimitCapacity string Sub limit available for this risk, to be sent in quote request, in coverage pattern BP7LocSprinklerLeakageEQExtISO_HUSA and term pattern BP7EQSLSubLimitCapacityISO_HUSA, or for corresponding clase for non ISO states
                 }
             }
         }
    }

    Get utility services sublimit

    Example Request

    new Request("/sandbox.myattune.com/bookingServices/v1/pc/submission/utilityserviceslimits", {
      method: "POST",
      headers: {
        "X-AUTH-TOKEN": "itsasecret",
        "Content-Type": "application/json"
      },
      body: JSON.stringify(
        {  
           "utilityLimitRequestModel":{  
              "UtilityLimitRequest":{  
                 "BuildingState":"CA",
                 "MilesToOcean":"16"
              }
           }
        }
    });
    
    

    Selected Response Headers

    Access-Control-Expose-Headers: X-AUTH-TOKEN
    

    Example Response

    {  
       "return":{  
          "UtilityLimitResponse":{  
             "directDamageSubLimit":100000,
             "timeElementSubLimit":50000
          }
       }
    }
    

    This endpoint is used to retrieve sub limits for utility services direct damage or time element coverages based on the location state and distance to coast. This API needs to be used to populate sublimit values when utility services direct damage or time element coverages are selected. Distance to coast is available in prefill response (default to 16 when not available)

    Required Request Headers

    Key Value
    X-AUTH-TOKEN itsasecret

    Request POST Parameters

    Describe query parameters here.

    Parameter Data Type Required? Description
    { object Wrapper object for request
         utilityLimitRequestModel:{ object Wrapper object for request
             UtilityLimitRequest:{ object Wrapper object for request entity
                 BuildingState string Y Building state
                 MilesToOcean string Y Miles to Ocean code from the prefill response (1-16)
             }
         }
    }

    Response Body Fields

    Field Data Type Description
    { object Wrapper object for response
         return:{ object Wrapper object for response
             UtilityLimitResponse:{ object Wrapper object for response
                 directDamageSubLimit string sublimit to be sent in payload for quote if direct damage is selected, BP7UtilitySrvcsDirectDamageForBuilding > BP7UtilitySrvcsDirectDamageScheduleItem > BP7UtilitySrvcsDirectDamageSubLimit
                 timeElementSubLimit string sublimit to be sent in payload for quote if time element is selected, BP7UtilitySrvcsTimeElement1 > BP7UtilitySrvcsTimeElementScheduleItem > BP7UtilitySrvcsTimeElementSubLimit
             }
         }
    }

    Sample Request Payloads

    Quote

    Example Payload

    {
      "quoteRequestModel": {
        "QuoteSubmissionRequest": {
          "Account": {
            "AccountHolderContact": {
              "EmailAddress1": "test@example.com",
              "Name": "Successful Company",
              "PrimaryAddress": {
                "AddressLine1": "65 Greene St.",
                "AddressLine2": "Suite 123",
                "AddressType": "Business",
                "City": "New York",
                "PostalCode": "10012",
                "State": "NY"
              },
              "Subtype": "Company",
              "WorkPhone": "555-555-5555",
              "AddressBookUID": null,
              "entity-Person": null
            },
            "AccountOrgType": "commonownership",
            "AccountNumber": 1,
            "IndustryCode": null,
            "MathedBusinessName_HUSA": null,
            "OFACStatus_HUSA": "NO",
            "ProducerCodes": {
              "Entry": [
                {
                  "ProducerCode": {
                    "Code": "SIATEST00011"
                  }
                }
              ]
            }
          },
          "Periods": {
            "Entry": [
              {
                "AddlNamedInsureds_HUSA": null,
                "BaseState": "NY",
                "BP7Line": {
                  "AdditionalInsureds": {
                    "Entry": [
    
                    ]
                  },
                  "AllClauses": {
                    "Entry": [
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Classification:0.0.0"
                        },
                        "Pattern": {
                          "Code": "BP7_ClassAdditionalCov_HUSA"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 2500,
                              "PatternCode": "BP7Limit39"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Classification:0.0.0"
                        },
                        "Pattern": {
                          "Code": "BP7ClassificationOutdoorProperty"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 101000,
                              "PatternCode": "BP7BusnPrsnlPropLimit"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Classification:0.0.0"
                        },
                        "Pattern": {
                          "Code": "BP7ClassificationBusinessPersonalProperty"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 10000,
                              "PatternCode": "BP7Limit1"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Classification:0.0.0"
                        },
                        "Pattern": {
                          "Code": "BP7ClassificationBPPTemporarilyInPortableStorageUn"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 5000,
                              "PatternCode": "BP7Limit38"
                            },
                            {
                              "CovTermValueForRating_HUSA": false,
                              "PatternCode": "BP7BusinessIncomeFromSecondaryDependentProperties"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Classification:0.0.0"
                        },
                        "Pattern": {
                          "Code": "BP7ClassificationBusinessIncomeFromDependentProps"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 10000,
                              "PatternCode": "BP7Limit"
                            },
                            {
                              "CovTermValueForRating_HUSA": 5000,
                              "PatternCode": "BP7AccountsReceivableOffLimit_HUSA"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Classification:0.0.0"
                        },
                        "Pattern": {
                          "Code": "BP7ClassificationAccountsReceivable"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 10000,
                              "PatternCode": "BP7Limit3"
                            },
                            {
                              "CovTermValueForRating_HUSA": 5000,
                              "PatternCode": "BP7ValuablePapersOffLimit_HUSA"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Classification:0.0.0"
                        },
                        "Pattern": {
                          "Code": "BP7ClassificationValuablePapers"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 2500,
                              "PatternCode": "BP7Limit14"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Classification:0.0.0"
                        },
                        "Pattern": {
                          "Code": "BP7TheftLimitations"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 25000,
                              "PatternCode": "BP7Limit32"
                            },
                            {
                              "CovTermValueForRating_HUSA": "PowerOutage",
                              "PatternCode": "BP7CovType2"
                            },
                            {
                              "CovTermValueForRating_HUSA": "Pharmaceuticals",
                              "PatternCode": "BP7Class"
                            },
                            {
                              "CovTermValueForRating_HUSA": "NotApplicable",
                              "PatternCode": "BP7MaintenanceAgreement1"
                            },
                            {
                              "CovTermValueForRating_HUSA": "All medicines and pharmaceuticals requiring refrigeration as used in the course of the insured's business operations.",
                              "PatternCode": "BP7PerishableStockDesc"
                            },
                            {
                              "CovTermValueForRating_HUSA": 500,
                              "PatternCode": "BP7SpoilageDeductible_HUSA"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Classification:0.0.0"
                        },
                        "Pattern": {
                          "Code": "BP7SpoilgCov"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": "25.0000",
                              "PatternCode": "BP7BPPSeasonalIncrease2_HUSA"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Building:0.0"
                        },
                        "Pattern": {
                          "Code": "BP7BPPSeasonalIncrease_HUSA"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Building:0.0"
                        },
                        "Pattern": {
                          "Code": "BP7_BuildAddCov_HUSA"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 50000,
                              "PatternCode": "BP7EBDataRestoration2_HUSA"
                            },
                            {
                              "CovTermValueForRating_HUSA": 50000,
                              "PatternCode": "BP7EBExpeditingExpenses2_HUSA"
                            },
                            {
                              "CovTermValueForRating_HUSA": 50000,
                              "PatternCode": "BP7EBHazSubstances2_HUSA"
                            },
                            {
                              "CovTermValueForRating_HUSA": 25000,
                              "PatternCode": "BP7EBOffPremEquipBreakdowns2_HUSA"
                            },
                            {
                              "CovTermValueForRating_HUSA": 5000,
                              "PatternCode": "BP7EBPublicRelations2_HUSA"
                            },
                            {
                              "CovTermValueForRating_HUSA": 50000,
                              "PatternCode": "BP7EBSpoilage2_HUSA"
                            },
                            {
                              "CovTermValueForRating_HUSA": 1000,
                              "PatternCode": "BP7EBDirectCoverages2_HUSA"
                            },
                            {
                              "CovTermValueForRating_HUSA": 72,
                              "PatternCode": "BP7EBIndirectCoverages2_HUSA"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Building:0.0"
                        },
                        "Pattern": {
                          "Code": "BP7EquipmentBreakdownCoverage2"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": "1%",
                              "PatternCode": "BP7WindOrHailDed_HUSA"
                            },
                            {
                              "CovTermValueForRating_HUSA": "2500.0000",
                              "PatternCode": "BP7MinWinDedAmt_HUSA"
                            },
                            {
                              "CovTermValueForRating_HUSA": "BP7_WindstormorHailPercDeductible",
                              "PatternCode": "BP7WindHurCoverForm_HUSA"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Building:0.0"
                        },
                        "Pattern": {
                          "Code": "BP7BuildWind_HUSA"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": "2",
                              "PatternCode": "BP7AutomaticIncreasePct"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Location:0"
                        },
                        "Pattern": {
                          "Code": "BP7LocationAutomaticIncreasePct"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": "Yes",
                              "PatternCode": "BP7EmployeeDishtyApply"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Location:0"
                        },
                        "Pattern": {
                          "Code": "BP7LocationEmployeeDishty"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 2500,
                              "PatternCode": "BP7Limit9"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Location:0"
                        },
                        "Pattern": {
                          "Code": "BP7LocationFireDeptService"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Location:0"
                        },
                        "Pattern": {
                          "Code": "BP7_LocAdditionalCov_HUSA"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Location:0"
                        },
                        "Pattern": {
                          "Code": "BP7LocWind_HUSA"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 500,
                              "PatternCode": "BP7BaseDeductible"
                            },
                            {
                              "CovTermValueForRating_HUSA": 1000,
                              "PatternCode": "BP7OptionalDeductible"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7Location:0"
                        },
                        "Pattern": {
                          "Code": "BP7LocationPropertyDeductibles"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": null,
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7BusinessOwnersEnhacement"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7AbuseMolestationExcl"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7AccsDisclConfidPersonInfoDataRelatedLiabNoBIExcepIncl_HUSA"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": "60",
                              "PatternCode": "BP7BusnIncomeOrdinaryPayrollNumDays"
                            },
                            {
                              "CovTermValueForRating_HUSA": "false",
                              "PatternCode": "BP7Exempt"
                            },
                            {
                              "CovTermValueForRating_HUSA": "60",
                              "PatternCode": "BP7BusnIncomeExtddPeriodNumDays"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7BusinessIncome"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 1000000,
                              "PatternCode": "BP7EachOccLimit"
                            },
                            {
                              "CovTermValueForRating_HUSA": 5000,
                              "PatternCode": "BP7OptionalMedicalCovLimitPerPerson"
                            },
                            {
                              "CovTermValueForRating_HUSA": 100000,
                              "PatternCode": "BP7TenantsFireLiabLimit"
                            },
                            {
                              "CovTermValueForRating_HUSA": 2000000,
                              "PatternCode": "BP7AggregateLimit"
                            },
                            {
                              "CovTermValueForRating_HUSA": 2000000,
                              "PatternCode": "BP7ProdCompldOpsAggregateLimit"
                            },
                            {
                              "CovTermValueForRating_HUSA": "NoDeductible",
                              "PatternCode": "BP7PropDamageLiabDed"
                            },
                            {
                              "CovTermValueForRating_HUSA": "NotApplicable",
                              "PatternCode": "BP7PropDamageLiabDedType"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7BusinessLiability"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 10000,
                              "PatternCode": "BP7Limit5"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7ElectronicData"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 5000,
                              "PatternCode": "BP7Limit6"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7EmployeeDishty"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7EmploymentRelatedPracticesExcl"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": null,
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7ExclSilicaSilicaRelatedDust"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": "2500",
                              "PatternCode": "BP7Limit7"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7ForgeryAlteration"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7FungiBacteriaExclLiability"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 10000,
                              "PatternCode": "BP7Limit8"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7InterruptionComputerOps"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": true,
                              "PatternCode": "BP7AccptCertifiedActs_HUSA"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7Terrorism_HUSA"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7_LineAdditionalCov_HUSA"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": 25000,
                              "PatternCode": "BP7Limit4"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7ComputerFraudFundsTransferFraud"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7MinimumPremiumAdjustment_HUSA"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7AsbestosExclusion_HUSA"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
                            {
                              "CovTermValueForRating_HUSA": null,
                              "PatternCode": "BP7AdditionalInfo"
                            }
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7DisclosurePursuantToTRIA2002"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7TotPolltnExclHeatEquipAndHostileFireExcptn"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": {
                          "Entry": [
    
                          ]
                        },
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7ExclCertfdActsTerrsmCovFireLosses"
                        },
                        "ScheduledItems_HUSA": null
                      },
                      {
                        "CovTerms": null,
                        "OwningCoverable": {
                          "TypeIDString": "entity.BP7BusinessOwnersLine"
                        },
                        "Pattern": {
                          "Code": "BP7CapLossesFromCertfdActsTerrsm"
                        },
                        "ScheduledItems_HUSA": null
                      }
                    ]
                  },
                  "Blankets": {
                    "Entry": [
    
                    ]
                  },
                  "BP7LineBusinessType": "Office",
                  "BP7ContractorsCovEligible_HUSA": false,
                  "BP7Locations": {
                    "Entry": [
                      {
                        "AdditionalInsureds_HUSA": {
                          "Entry": [
    
                          ]
                        },
                        "Buildings": {
                          "Entry": [
                            {
                              "AdditionalInterests_HUSA": {
                                "Entry": [
    
                                ]
                              },
                              "Building": {
                                "BuildingAnswers_HUSA": {
                                  "Entry": [
                                    {
                                      "AnswerValueAsString": "2014",
                                      "QuestionCode": "BP7_Building_Built_Year"
                                    },
                                    {
                                      "QuestionCode": "BP7_South_Carolina_Windstorm_Loss",
                                      "AnswerValueAsString": false
                                    }
                                  ]
                                },
                                "BuildingNum": 1,
                                "PolicyLocation": {
                                  "LocationNum": 1
                                },
                                "RoofYear_HUSA": null,
                                "YearBuilt": "2014"
                              },
                              "Classifications": {
                                "Entry": [
                                  {
                                    "AmusementArea": false,
                                    "Area": 2000,
                                    "ClassDescription": "AccountingServicesCPAs",
                                    "ClassificationNumber": "63631",
                                    "ClassPropertyType": "Office",
                                    "Exposure": "100000",
                                    "ExposureBasis": "AnnualGrossSales",
                                    "NumClubHouses_HUSA": "0",
                                    "NumExcerciseRooms_HUSA": "0",
                                    "NumOfAmuseAreas_HUSA": "0",
                                    "NumOfPlayGrounds_HUSA": "0",
                                    "NumOfSpas_HUSA": "0",
                                    "NumSwimmingPools": "0",
                                    "Playground": "None",
                                    "TypeIDString": "entity.BP7Classification:0.0.0"
                                  }
                                ]
                              },
                              "ConstructionType": "FrameConstruction",
                              "NumOfStories": 1,
                              "PctOwnerOccupied": "NotApplicable",
                              "PropertyType": "Office",
                              "Sprinklered": true,
                              "TypeIDString": "entity.BP7Building:0.0"
                            }
                          ]
                        },
                        "Location": {
                          "LocationNum": 1,
                          "EarthquakeMMI100Year_HUSA": "3.0",
                          "EarthquakeSoilType_HUSA": {
                            "Name": "Soft to Firm Rock(stiff soil)"
                          },
                          "EarthquakeTerritoryCode_HUSA": "21"
                        },
                        "TypeIDString": "entity.BP7Location:0"
                      }
                    ]
                  },
                  "TypeIDString": "entity.BP7BusinessOwnersLine"
                },
                "BP7LineExists": true,
                "CP7Line": null,
                "CP7LineExists": false,
                "GeneralLiabilityLine_GLE": null,
                "GeneralLiabilityLine_GLEExists": false,
                "Job": {
                  "QuoteName_HUSA": "Test Quote",
                  "JobNumber": null
                },
                "MonoLinePolicyLine_HUSA": {
                  "HamiltonCodes_HUSA": null,
                  "IndustryGroup_HUSA": null,
                  "Subtype": "BP7BusinessOwnersLine"
                },
                "Offering": null,
                "PeriodAnswers": {
                  "Entry": null
                },
                "PeriodEnd": 1554350400000,
                "PeriodStart": "2018-04-04T04:00:00.000Z",
                "PolicyContactRoles": {
                  "Entry": [
    
                  ]
                },
                "PolicyLocations": {
                  "Entry": [
                    {
                      "AccountLocation": {
                        "AddressLine1": "123 Main Street",
                        "AddressLine2": "Floor 2",
                        "AddressLine3": null,
                        "AddressType": "business",
                        "City": "Chattanooga",
                        "Country": null,
                        "County": null,
                        "PostalCode": "37415",
                        "State": "TN",
                        "Subtype": "AccountLocation"
                      },
                      "EmployeeCount": 42,
                      "DistanceToOcean_HUSA": "15",
                      "LocationNum": 1,
                      "PrimaryLoc": true
                    }
                  ]
                },
                "PrimaryNamedInsured": {
                  "ContactDenorm": {
                    "EmailAddress1": "test@example.com",
                    "Name": "Successful Company",
                    "PrimaryAddress": {
                      "AddressLine1": "65 Greene St.",
                      "AddressLine2": "Suite 123",
                      "AddressType": "Business",
                      "City": "New York",
                      "PostalCode": "10012",
                      "State": "NY"
                    },
                    "Subtype": "Company",
                    "WorkPhone": "555-555-5555",
                    "AddressBookUID": null,
                    "entity-Person": null
                  },
                  "Subtype": "PolicyPriNamedInsured"
                },
                "UWCompany": {
                  "Code": "HI"
                },
                "WrittenDate": 1522871893308
              }
            ]
          },
          "TSRequestID_HUSA": "db4d1854-48e8-4476-b4a3-69b317b5a256"
        }
      },
      "userName": "wilbur.cobb@spumco.com"
    }
    

    Payload Object Fields

    Field Data Type Description
    { object
         quoteRequestModel { object
             QuoteSubmissionRequest { object
                 Account { object
                     AccountHolderContact { object
                         EmailAddress1 string
                         Name string
                         PrimaryAddress { object
                             AddressLine1 string
                             AddressLine2 string
                             AddressType string
                             City string
                             PostalCode string
                             State string
                         }
                         Subtype string
                         WorkPhone string
                         AddressBookUID ?
                         entity-Person ?
                     }
                     AccountOrgType string
                     AccountNumber number
                     IndustryCode ?
                     MathedBusinessName_HUSA ?
                     OFACStatus_HUSA string
                     ProducerCodes { object
                         Entry [ array
                             { object
                                 ProducerCode { object
                                     Code string
                                 }
                             }
                         ]
                     }
                 }
                 Periods { object
                     Entry [ array
                         { object
                             AddlNamedInsureds_HUSA ?
                             BaseState string
                             BP7Line { object
                                 AdditionalInsureds { object
                                     Entry [ array
                                     ]
                                 }
                                 AllClauses { object
                                     Entry [ array
                                         { object
                                             CovTerms { object
                                                 Entry [ array
                                                     { object
                                                         CovTermValueForRating_HUSA string
                                                         PatternCode string
                                                     } object
                                                     ...
                                                 ]
                                             }
                                             OwningCoverable { object
                                                 TypeIDString string
                                             }
                                             Pattern { object
                                                 Code string
                                             }
                                             ScheduledItems_HUSA ?
                                         }
                                         ...
                                     ]
                                 }
                                 Blankets { object
                                     Entry [ array
                                     ]
                                 }
                                 BP7LineBusinessType string
                                 BP7ContractorsCovEligible_HUSA string
                                 BP7Locations { object
                                     Entry [ array
                                         { object
                                             AdditionalInsureds_HUSA { object
                                                 Entry [ array
                                                 ]
                                             }
                                             Buildings { object
                                                 Entry [ array
                                                     { object
                                                         AdditionalInterests_HUSA { object
                                                             Entry [ array
                                                             ]
                                                         }
                                                         Building { object
                                                             BuildingAnswers_HUSA { object
                                                                 Entry [ array
                                                                     { object
                                                                         QuestionCode string
                                                                         AnswerValueAsString string
                                                                     }
                                                                     ...
                                                                 ]
                                                             }
                                                             BuildingNum number
                                                             PolicyLocation { object
                                                                 LocationNumber number
                                                             }
                                                             RoofYear_HUSA ?
                                                             YearBuilt string
                                                         }
                                                         Classifications { object
                                                             Entry [ array
                                                                 { object
                                                                     AmusementArea boolean
                                                                     Area number
                                                                     ClassDescription string
                                                                     ClassificationNumber string
                                                                     ClassPropertyType string
                                                                     Exposure string
                                                                     ExposureBasis string
                                                                     NumClubHouses_HUSA string
                                                                     NumExcerciseRooms_HUSA string
                                                                     NumOfAmuseAreas_HUSA string
                                                                     NumOfPlayGrounds_HUSA string
                                                                     NumOfSpas_HUSA string
                                                                     NumSwimmingPools string
                                                                     Playground string
                                                                     TypeIDString string
                                                                 }
                                                             ]
                                                         }
                                                         ConstructionType string
                                                         NumOfStories number
                                                         PctOwnerOccupied string
                                                         PropertyType string
                                                         Sprinklered boolean
                                                         TypeIDString string
                                                     }
                                                 ]
                                             }
                                             Location { object
                                                 LocationNum number
                                                 EarthquakeMMI100Year_HUSA string
                                                 EarthquakeSoilType_HUSA { object
                                                     Name string
                                                 }
                                                 EarthquakeTerritoryCode_HUSA string
                                             }
                                             TypeIDString string
                                         }
                                     ]
                                 }
                                 TypeIDString string
                             }
                             BP7LineExists boolean
                             CP7Line ?
                             CP7LineExists boolean
                             GeneralLiabilityLine_GLE ?
                             GeneralLiabilityLine_GLEExists boolean
                             Job { object
                                 QuoteName_HUSA string
                                 JobNumber ?
                             }
                             MonoLinePolicyLine_HUSA { object
                                 HamiltonCodes_HUSA ?
                                 IndustryGroup_HUSA ?
                                 Subtype string
                             }
                             Offering ?
                             PeriodAnswers { ?
                                 Entry ?
                             }
                             PeriodEnd number
                             PeriodStart string
                             PolicyContactRoles { object
                                 Entry [ array
                                 ]
                             }
                             PolicyLocations { object
                                 Entry [ array
                                     { object
                                         AccountLocation { object
                                             AddressLine1 string
                                             AddressLine2 string
                                             AddressLine3 string
                                             AddressType string
                                             City string
                                             Country ?
                                             County ?
                                             PostalCode string
                                             State string
                                             Subtype string
                                         `}
                                         EmployeeCount number
                                         DistanceToOcean_HUSA string
                                         LocationNum number
                                         PrimaryLoc boolean
                                     }
                                 ]
                             }
                             PrimaryNameInsured { object
                                 ContactDenorm { object
                                     EmailAddress string
                                     Name string
                                     PrimaryAddress { object
                                         AddressLine1 string
                                         AddressLine2 string
                                         AddressType string
                                         City string
                                         PostalCode string
                                         State string
                                     }
                                     Subtype string
                                     WorkPhone string
                                     AddressBookUID ?
                                     entity-Person ?
                                 }
                                 Subtype string
                             }
                             UWCompany { object
                                 Code string
                             }
                             WrittenDate number
                         }
                     ]
                 }
                 TSRequestID_HUSA string
             }
         }
         userName string
    }

    Underwriting APIs

    These endpoints are used to retrieve prefill data based on adress and business and to determine eligibility based on prefill data along with answers to underwriting questions.

    Prefill API

    Prefill API works based on location address and business name.

    Example request

    new Request("/sandbox.myattune.com/bookingServices/v1/uw/prefill", {
      method: "POST",
      headers: {
        "X-AUTH-TOKEN": "itsasecret",
        "Content-Type": "application/json"
      },
      body: JSON.stringify(
        {
           "entity":{  
              "address":{  
                 "street1":"40 Exchange Pl",
                 "city":"New York",
                 "state":"NY",
                 "zipcode":"10005"
              },
              "business":{  
                 "name":"Attune Insurance"
              }
           },
           "effectiveDate":"2016-11-02"
        }
    });
    

    Selected Response headers

    HTTP/1.1 200 OK
    Access-Control-Expose-Headers: X-AUTH-TOKEN
    Content-Type: application/json;charset=UTF-8
    

    Response Payload

    {
        "requestId": "137114f5-6887-4ebc-9de4-4b9ffe1edcea",
        "responseId": "eccd0738-b692-4489-b16d-3ab2aa59a98f",
        "receiveTime": "2018-09-23T19:20:58.352Z",
        "responseTime": "2018-09-23T19:21:08.351Z",
        "data": {
            "liquorLicenseValidAsOfPolicyStartDate": false,
            "hasSprinkler": null,
            "sprinklerSurveyAgeYears": null,
            "sprinklerGradingScore": null,
            "ppc": "1",
            "capRisk": 7,
            "buildingAge": null,
            "numberOfStories": null,
            "numberOfBasements": null,
            "inSpecialFloodZone": false,
            "hasRoofSolarPanels": null,
            "combustibility": null,
            "surveyAgeYears": null,
            "closingTime": null,
            "numberOfEmployees": null,
            "restaurantInspectionAgeYears": null,
            "restaurantInspectionScore": null,
            "numOSHAViolations3Years": 0,
            "numFireIncidents3Years": 0,
            "numGasIncidents3Years": 0,
            "totalBuildingSquareFootage": null,
            "isoConstructionCode": null,
            "distanceToNearestBodyOfWater": "30 mi and greater",
            "estimatedPayroll": null,
            "estimatedSales": null,
            "buildingReplacementCost": null,
            "buildingReplacementCostModelled": null,
            "distanceToNearestBodyOfWaterCode": "16",
            "hailDamageScore": "1",
            "yearBuilt": null,
            "restaurantMarketSegment": null,
            "restaurantMenuType": null,
            "restaurantHasBanquetFacility": null,
            "restaurantOpen24Hours": null,
            "restaurantAnnualSales": null,
            "restaurantAlcoholType": null,
            "restaurantValetParking": null,
            "restaurantNumberSeatsCode": null,
            "restaurantSICCode": null,
            "restaurantAcceptsCreditCards": null,
            "restaurantDelivery": null,
            "restaurantTakeOut": null,
            "restaurantCatering": null,
            "restaurantOutdoorSeating": null,
            "restaurantReservations": null,
            "restaurantWifi": null,
            "propertyUsePrimaryDescription": null,
            "propertyOwnerOccupancy": null,
            "propertyOwnerOccupancyDescription": null,
            "propertyPool": null,
            "propertyExteriorWalls": null,
            "propertyFoundation": null,
            "propertyRoofCover": null,
            "propertyRoofType": null,
            "propertyHeating": null,
            "propertyAmenities": null,
            "propertyImprovements": null,
            "propertyFeatures1": null,
            "propertyFeatures2": null,
            "propertyFeatures3": null,
            "propertyFeatures4": null,
            "propertyBuildingQuality": null,
            "propertyBuildingCondition": null,
            "earthquakeSoilType": "Stiff clay and Sandy soil(firm soil)",
            "earthquakeMMI100Year": "3.0",
            "commEarthquakeTerritoryCode": "1",
            "isoDistToCoastRangeCode": "16",
            "isoDistToCoastRangeName": "30 mi and greater",
            "enhancedCrimeFlag": null
        },
        "TSRequestID_HUSA": "8c9607e1-07eb-4594-a3a7-712dc3edfa6c"
    }
    

    HTTP Request

    POST /sandbox.myattune.com/bookingServices/v1/uw/prefill

    Required Request Headers

    Describe required request headers here.

    Key Value
    Content-Type "application/json"
    X-AUTH-TOKEN itsasecret

    Request POST Parameters

    Describe query parameters here.

    Parameter Data Type Required? Description
    { object Wrapper object for request
         entity:{ object Wrapper object for request entity
             address:{ object Wrapper object for request entity
                 street1 string Street Address for the location where this prefill applies
                 city string City for the location where this prefill applies
                 state string State for the location where this prefill applies
                 zipcode string Zipcode for the location where this prefill applies
             }
             business:{ object Wrapper object for request business
                 name string Business Name for tis quote
             }
         }
    }

    Response Body Fields

    Field Data Type Description
    { object Wrapper object for response
         requestId string Array of individual Policy details
         requestId string Array of individual Policy details
         requestId string Array of individual Policy details
         requestId string Array of individual Policy details
             data { Wrapper object for response data fields
                 liquorLicenseValidAsOfPolicyStartDate boolean Unique number for the Insured Account who owns the Policy
                 hasSprinkler boolean Does this location has Sprinkler
                 sprinklerSurveyAgeYears string Sprinkler survey age in Years
                 sprinklerGradingScore string Sprinkler grading score
                 ppc string PPC code for this locatio/building
                 capRisk string Crime rate at this location, ranges from 1-10
                 buildingAge string Building age in years
                 numberOfStories string Number of stories for this building
                 numberOfBasements string Number of basements for this building
                 inSpecialFloodZone boolean Is this location in special flood zone
                 hasRoofSolarPanels string Does the roof has solar panels installed
                 combustibility string Combustibility for building
                 surveyAgeYears string Survey age years
                 closingTime string What time does the business close in 24h format
                 numberOfEmployees string Number of employees at this location
                 restaurantInspectionAgeYears string Restaurant inspection age
                 restaurantInspectionScore string Restaurant inspection score
                 numOSHAViolations3Years string Number of OSHA violations in last 3 years
                 numFireIncidents3Years string Number of fire incidents in last 3 years
                 numGasIncidents3Years string Number of gas incidents in last 3 years
                 totalBuildingSquareFootage string Total sq footage, typically needs to be validated with the user as it can be for the entire building
                 isoConstructionCode string ISO construction code
                 distanceToNearestBodyOfWater string Distane to nearest water body description
                 estimatedPayroll string Estimated payroll for this business at this location
                 estimatedSales string stimated sales for this business at this location
                 buildingReplacementCost string Building replacement cost
                 buildingReplacementCostModelled string Building replacement cost
                 distanceToNearestBodyOfWaterCode string Distane to nearest water body code (1-16),default to 16 if null
                 hailDamageScore string Hail damage score
                 yearBuilt string Year this building was constructed
                 restaurantMarketSegment string Restaurant market segment
                 restaurantMenuType string Restaurant menu type
                 restaurantHasBanquetFacility boolean Restaurant Has Banquet Facility
                 restaurantOpen24Hours boolean Restaurant Open 24 Hours
                 restaurantAnnualSales string Restaurant Annual Sales
                 restaurantAlcoholType string Restaurant Alcohol Type
                 restaurantValetParking boolean Restaurant Valet Parking
                 restaurantNumberSeatsCode string restaurant Number Seats Code
                 restaurantSICCode boolean restaurant SIC Code
                 restaurantAcceptsCreditCards boolean restaurant Accepts CreditCards
                 restaurantDelivery boolean restaurant Delivery
                 restaurantTakeOut boolean restaurant TakeOut
                 restaurantCatering boolean restaurant Catering
                 restaurantOutdoorSeating boolean restaurant Outdoor Seating
                 restaurantReservations boolean restaurant Reservations
                 restaurantWifi boolean restaurant Wifi
                 propertyUsePrimaryDescription string property Use Primary Description
                 propertyOwnerOccupancy string property Owner Occupancy
                 propertyOwnerOccupancyDescription string property Owner Occupancy Description
                 propertyPool boolean property Pool
                 propertyExteriorWalls string property Exterior Walls
                 propertyFoundation string property Foundation
                 propertyRoofCover string property RoofC over
                 propertyRoofType string property Roof Type
                 propertyHeating string property Heating
                 propertyAmenities string property Amenities
                 propertyImprovements string property Improvements
                 propertyFeatures1 string property Features1
                 propertyFeatures1 string property Features2
                 propertyFeatures3 string property Features3
                 propertyFeatures4 string property Features4
                 propertyBuildingQuality string property Building Quality
                 propertyBuildingCondition string property Building Condition
                 earthquakeSoilType string earthquake SoilType
                 earthquakeMMI100Year string earthquakeMMI100Year
                 commEarthquakeTerritoryCode string comm Earthquake TerritoryCode
                 isoDistToCoastRangeCode string iso DistToCoastRangeCode
                 isoDistToCoastRangeName string iso DistToCoastRangeName
                 enhancedCrimeFlag boolean enhanced Crime Flag
             }
             TSRequestID_HUSA string UUID, use this value to populate the same field value from UW decision request
    }

    Underwriting Decision API

    UW Decision API works based on the fields from prefill along with answers to UW questions.

    Example request

    new Request("/sandbox.myattune.com/bookingServices/v1/uw/decision", {
      method: "POST",
      headers: {
        "X-AUTH-TOKEN": "itsasecret",
        "Content-Type": "application/json"
      },
      body: JSON.stringify(
        {  
       "TSRequestID_HUSA":"a08020aa-9f63-4ba9-b4d1-6f31afe3237b",
       "entity":{  
              "address":{  
                 "street1":"40 Exchange Pl",
                 "city":"New York",
                 "state":"NY",
                 "zipcode":"10005"
              },
              "business":{  
                 "name":"Attune Insurance"
              }
           },
       "effectiveDate":"2016-11-09",
       "underwritingData":{  
              "liquorLicenseValidAsOfPolicyStartDate":false,
              "hasSprinkler":true,
              "sprinklerSurveyAgeYears":9,
              "sprinklerGradingScore":0,
              "ppc":"4",
              "capRisk":5,
              "buildingAge":33,
              "numberOfStories":4,
              "numberOfBasements":0,
              "inSpecialFloodZone":false,
              "hasRoofSolarPanels":false,
              "combustibility":2,
              "surveyAgeYears":9,
              "closingTime":2300,
              "numberOfEmployees":5,
              "restaurantInspectionAgeYears":0,
              "restaurantInspectionScore":0,
              "numOSHAViolations3Years":0,
              "numFireIncidents3Years":0,
              "numGasIncidents3Years":0,
              "totalBuildingSquareFootage":6118,
              "isoConstructionCode":"SFR",
              "distanceToNearestBodyOfWater":"15 miles to less than 20 miles",
              "estimatedPayroll":"$100,000 - $250,000",
              "estimatedSales":"172528.3",
              "buildingReplacementCost":"42256900",
              "buildingReplacementCostModelled":null,
              "distanceToNearestBodyOfWaterCode":"13",
              "hailDamageScore":"1",
              "yearBuilt":"1983",
              "restaurantMarketSegment":"FSR - CAFÉ-RESTAURANTS, FAMILY-STYLE, DINER",
              "restaurantMenuType":"VARIED MENU",
              "restaurantHasBanquetFacility":"false",
              "restaurantOpen24Hours":"false",
              "restaurantAnnualSales":"$500,001 - $1,000,000",
              "restaurantAlcoholType":"UNCODED",
              "restaurantValetParking":"false",
              "restaurantNumberSeatsCode":"1500",
              "restaurantSICCode":"UNCODED",
              "restaurantAcceptsCreditCards":null,
              "restaurantDelivery":"false",
              "restaurantTakeOut":null,
              "restaurantCatering":null,
              "restaurantOutdoorSeating":null,
              "restaurantReservations":null,
              "restaurantWifi":null,
              "propertyUsePrimaryDescription":"MULTI-TENANT OFFICES/STORES",
              "propertyOwnerOccupancy":"N",
              "propertyOwnerOccupancyDescription":"10orless",
              "propertyPool":null,
              "propertyExteriorWalls":null,
              "propertyFoundation":null,
              "propertyRoofCover":null,
              "propertyRoofType":null,
              "propertyHeating":null,
              "propertyAmenities":null,
              "propertyImprovements":null,
              "propertyFeatures1":null,
              "propertyFeatures2":null,
              "propertyFeatures3":null,
              "propertyFeatures4":null,
              "propertyBuildingQuality":null,
              "propertyBuildingCondition":null,
              "subcontractorCostsUWQ":false,
              "governmentFineUWQ":false,
              "foundationWorkUWQ":false,
              "dangerousFenceWorkUWQ":false,
              "nycWorkUWQ":false, 
              "productLabelUWQ":false,
              "csbaContentsUWQ":false,
              "liveEntertainmentUWQ":true,
              "buildingFullyUpdated30Years":false,
              "roofUpdated20Years":false,
              "claimsNumberUWQ":100,
              "claimsAmountUWQ":100000.00,
              "continuousInsuranceUWQ":false,
              "closingTimeUWQ":false,
              "vacancyUWQ":false,
              "seasonalUWQ":false,
              "cateringUWQ":false,
              "bicycleUWQ":false,
              "rebuiltMaterialsUWQ":false,
              "electriciansUWQ":false,
              "hvacUWQ":false,
              "plumberUWQ":false
            }
        }
    });
    

    Selected Response headers

    HTTP/1.1 200 OK
    Access-Control-Expose-Headers: X-AUTH-TOKEN
    Content-Type: application/json;charset=UTF-8
    

    Response Payload Rejected Risk

    {
        "requestId": "7697d582-e435-4362-b479-834ded99f658",
        "responseId": "8fff835c-ac45-4876-bad7-91a141d37efb",
        "receiveTime": "2018-08-24T21:56:15.283Z",
        "responseTime": "2018-08-24T21:56:15.284Z",
        "riskDeclineReason": [
            "The applicant has a dance floor or hosts live entertainment.",
            "The applicant has had over three claims in the past five years.",
            "The applicant's claim history in the last five years has exceeded $20,000 in losses."
        ],
        "creditDebit": [],
        "allowLiquorLiabilityCoverage": true,
        "TSRequestID_HUSA": "1f9c46ed-c81c-4c7d-9748-a6236214846f"
    }
    

    Response Payload Accepted Risk

    {
        "requestId": "4acfff88-4bbf-4c7a-917f-1731065c8977",
        "responseId": "190b63ae-9ad7-46c2-a26f-88346e908c31",
        "receiveTime": "2018-08-24T21:54:31.332Z",
        "responseTime": "2018-08-24T21:54:31.333Z",
        "acceptRisk": true,
        "riskDeclineReason": [],
        "creditDebit": [],
        "allowLiquorLiabilityCoverage": true,
        "TSRequestID_HUSA": "1f9c46ed-c81c-4c7d-9748-a6236214846f"
    }
    

    HTTP Request

    POST /sandbox.myattune.com/bookingServices/v1/uw/prefill

    Required Request Headers

    Describe required request headers here.

    Key Value
    Content-Type "application/json"
    X-AUTH-TOKEN itsasecret

    Request POST Parameters

    Describe query parameters here.

    Parameter Data Type Required? Description
    { object Wrapper object for request
         TSRequestID_HUSA string UUID, populate it with the same field value from prefill response
         entity:{ object Wrapper object for request entity
             address:{ object Wrapper object for request entity
                 street1 string Street Address for the location where this prefill applies
                 city string City for the location where this prefill applies
                 state string State for the location where this prefill applies
                 zipcode string Zipcode for the location where this prefill applies
             }
             business:{ object Wrapper object for request business
                 name string Business Name for tis quote
             }
         }
         effectiveDate Date Effectie date for policy in the format yyyy-mm-dd
         underwritingData:{ object Wrapper object for UW decision
                 liquorLicenseValidAsOfPolicyStartDate boolean Unique number for the Insured Account who owns the Policy
                 hasSprinkler boolean Does this location has Sprinkler
                 sprinklerSurveyAgeYears string Sprinkler survey age in Years
                 sprinklerGradingScore string Sprinkler grading score
                 ppc string PPC code for this locatio/building
                 capRisk string Crime rate at this location, ranges from 1-10
                 buildingAge string Building age in years
                 numberOfStories string Number of stories for this building
                 numberOfBasements string Number of basements for this building
                 inSpecialFloodZone boolean Is this location in special flood zone
                 hasRoofSolarPanels string Does the roof has solar panels installed
                 combustibility string Combustibility for building
                 surveyAgeYears string Survey age years
                 closingTime string What time does the business close in 24h format
                 numberOfEmployees string Number of employees at this location
                 restaurantInspectionAgeYears string Restaurant inspection age
                 restaurantInspectionScore string Restaurant inspection score
                 numOSHAViolations3Years string Number of OSHA violations in last 3 years
                 numFireIncidents3Years string Number of fire incidents in last 3 years
                 numGasIncidents3Years string Number of gas incidents in last 3 years
                 totalBuildingSquareFootage string Total sq footage, typically needs to be validated with the user as it can be for the entire building
                 isoConstructionCode string ISO construction code
                 distanceToNearestBodyOfWater string Distane to nearest water body description
                 estimatedPayroll string Estimated payroll for this business at this location
                 estimatedSales string stimated sales for this business at this location
                 buildingReplacementCost string Building replacement cost
                 buildingReplacementCostModelled string Building replacement cost
                 distanceToNearestBodyOfWaterCode string Distane to nearest water body code (1-16),default to 16 if null
                 hailDamageScore string Hail damage score
                 yearBuilt string Year this building was constructed
                 restaurantMarketSegment string Restaurant market segment
                 restaurantMenuType string Restaurant menu type
                 restaurantHasBanquetFacility boolean Restaurant Has Banquet Facility
                 restaurantOpen24Hours boolean Restaurant Open 24 Hours
                 restaurantAnnualSales string Restaurant Annual Sales
                 restaurantAlcoholType string Restaurant Alcohol Type
                 restaurantValetParking boolean Restaurant Valet Parking
                 restaurantNumberSeatsCode string restaurant Number Seats Code
                 restaurantSICCode boolean restaurant SIC Code
                 restaurantAcceptsCreditCards boolean restaurant Accepts CreditCards
                 restaurantDelivery boolean restaurant Delivery
                 restaurantTakeOut boolean restaurant TakeOut
                 restaurantCatering boolean restaurant Catering
                 restaurantOutdoorSeating boolean restaurant Outdoor Seating
                 restaurantReservations boolean restaurant Reservations
                 restaurantWifi boolean restaurant Wifi
                 propertyUsePrimaryDescription string property Use Primary Description
                 propertyOwnerOccupancy string property Owner Occupancy
                 propertyOwnerOccupancyDescription string property Owner Occupancy Description
                 propertyPool boolean property Pool
                 propertyExteriorWalls string property Exterior Walls
                 propertyFoundation string property Foundation
                 propertyRoofCover string property RoofC over
                 propertyRoofType string property Roof Type
                 propertyHeating string property Heating
                 propertyAmenities string property Amenities
                 propertyImprovements string property Improvements
                 propertyFeatures1 string property Features1
                 propertyFeatures1 string property Features2
                 propertyFeatures3 string property Features3
                 propertyFeatures4 string property Features4
                 propertyBuildingQuality string property Building Quality
                 propertyBuildingCondition string property Building Condition
                 earthquakeSoilType string earthquake SoilType
                 earthquakeMMI100Year string earthquakeMMI100Year
                 commEarthquakeTerritoryCode string comm Earthquake TerritoryCode
                 isoDistToCoastRangeCode string iso DistToCoastRangeCode
                 isoDistToCoastRangeName string iso DistToCoastRangeName
                 enhancedCrimeFlag boolean enhanced Crime Flag
                 subcontractorCostsUWQ boolean Are subcontracted costs (as % of total revenue) over 30%? (Doesn't apply to LRO.)
                 governmentFineUWQ boolean Has your business received notice of any violations or fines from any governmental agency in the last 3 years? (Doesn't apply to LRO.)
                 foundationWorkUWQ boolean Does your business do any foundation or structural work? (Doesn't apply to LRO.)
                 dangerousFenceWorkUWQ boolean Does your business perform work installing, servicing or repairing school or playground perimeter fencing; fences at airports; electrified fences, fences constructed with straight line or crossed razor wire; razor barbed wire or concertina wire? (Doesn't apply to LRO.)
                 nycWorkUWQ boolean Does your business perform work in the Five Boroughs of New York City are ineligible (Brooklyn, Bronx, Manhattan, Queens and Staten Island) or the counties of West Chester, Nassau, or Suffolk? (Doesn't apply to LRO.)
                 productLabelUWQ boolean Does this business engage in selling products under the insured's name; manufacturing; importing goods directly by the insured; and repackaging and/or relabeling of products? (Doesn't apply to LRO.)
                 csbaContentsUWQ boolean If your business has over $500,000 in business personal property coverage do you have a central station burglar alarm? (Doesn't apply to LRO).Only display question if BPP limit is over $500,000
                 liveEntertainmentUWQ boolean Does this business have a dance floor and host live entertainement? (Doesn't apply to LRO.)
                 buildingFullyUpdated30Years boolean If your building is over 20 years old has the roof been updated? If greater than 30 years old have full updates been made? This question needs to be asked only once and the answer to this question can be used to fill in answer to this question as well as next question. Refer to foot notes for explanation. Only display question if building coverage is selected.
                 roofUpdated20Years boolean If your building is over 20 years old has the roof been updated? If greater than 30 years old have full updates been made? This question needs to be asked only once and the answer to this question can be used to fill in answer to this question as well as previous question. Refer to foot notes for explanation. Only display question if building coverage is selected.
                 claimsNumberUWQ integer How many claims has your business had in the past five years? (only needs to be asked for applicants who have been in business more than one year).Pre-Qualification (ask at the beginning of the quote process)
                 claimsAmountUWQ decimal What is the total amount of insurance claim losses in the past five years? (only needs to be asked if there has been a claim).Pre-Qualification (ask at the beginning of the quote process)
                 continuousInsuranceUWQ boolean Has your business had continuous insurance coverage for the past 3 years? (does not apply to new ventures).Pre-Qualification (ask at the beginning of the quote process)
                 closingTimeUWQ boolean Does this business close before 1:00 AM? (Doesn't apply to LRO.)
                 vacancyUWQ boolean Is the building over 30% vacant?
                 seasonalUWQ boolean Is this business seasonally closed for over 60 days? (Doesn't apply to LRO.)
                 cateringUWQ boolean Does this business derive over 20% of its sales from catering? (Doesn't apply to LRO.)
                 bicycleUWQ boolean Does the insured rent bicycles or other related equipment? (Doesn't apply to LRO.)
                 rebuiltMaterialsUWQ boolean "Does your business sell rebuilt or used auto parts, building materials, or hardware? (Doesn't apply to LRO.)
                 electriciansUWQ boolean "Does your business perform any of the following work: high voltage (over 480 volts) or utility companies including substations, distribution and transmission lines, repair, installation, or service of boilers, burglar alarm systems, or automatic fire extinguishing or protection systems? (Doesn't apply to LRO.)
                 hvacUWQ boolean Does your business perform work on high pressure boilers (> 15 psi for steam & > 30 psi for hot water)? (Doesn't apply to LRO.)
                 plumberUWQ boolean Does your business perform work on fire extinguishing or protection systems or high pressure boilers (> 15 psi for steam & > 30 psi for hot water)? (Doesn't apply to LRO.)
    }

    Response Body Fields

    Field Data Type Description
    { object Wrapper object for response
         requestId string Array of individual Policy details
         responseId string Array of individual Policy details
         receiveTime string Array of individual Policy details
         responseTime string Array of individual Policy details
         acceptRisk boolean Accept/Reject this risk. If rejected quote process should be stopped
         riskDeclineReason:[. array Array of strings indicating decline reason if any. This will be empty unless acceptRisk is false. Eg response "The applicant has a dance floor or hosts live entertainment.","The applicant has had over three claims in the past five years.","The applicant's claim history in the last five years has exceeded $20,000 in losses."
         creditDebit": array Not used at this time
         allowLiquorLiabilityCoverage boolean Ignore
         TSRequestID_HUSA string Same ID from request
    }