Skip to main content
Product detail is read per product, and usually per state. Your organization either has access to a product in a state or it doesn’t, and access applies to everyone in the organization. Operations outside the product catalog don’t check it; they keep their own permissions, such as read-only keys, filing access and dataset access. Every caller can browse and search the product catalog and every state’s availability. Filings, forms and manuals by state, events, resources, profiles, comparison attributes and rating plan requests need access to the product, and usually to the state. Every product operation in the API reference ends its description with an Access note that says which of these applies.

​
What needs access

​
Product fields

getProduct always answers, with every configured state’s availability: writing companies, TOI and sub-TOI codes, new business and renewals, notes and recorded counts. Two fields depend on access: recorded tells you how many filings, forms, manuals and events a state has, so you can skip reads that would come back empty.

​
Find what your organization has access to

getProductAccess lists the products and states your organization has access to:
allProducts: true means your organization has access to every product in every state. Otherwise each product with at least one state is listed; allStates: true covers every state, including states added later.

​
Without access

A request for a product or state your organization doesn’t have access to returns 403 with the code product_access_required and an accessUrl, the Product access page in Effective:
Don’t retry it. To add the product to your account, open accessUrl or contact [email protected]. With access to only some products or states, reads that span states narrow instead of failing. getProduct returns a limited view, and listProductEvents, listProductResources and listProductRatingPlanRequests cover only the states you have access to.