User Guide

The Figo Pet Insurance Quote API guide is designed to assist developers in integrating with Figo's Quote API endpoints to generate pet insurance quotes. Our API allows you to create quotes based on the below mentioned pet attributes. This documentation provides detailed instructions, sample requests, and responses to help you navigate the API's capabilities efficiently. By following this guide, you will be equipped to seamlessly incorporate our quoting functionality into your applications and redirect your customers to Figo's Quote & Enrollment experience to complete the purchase.

Subscribe to API products

You will have access to subscribe to our Test and Production APIs. We recommend subscribing to the Test API before requesting production. To create a subscription, navigate to the products page and select your desired product, then enter a subscription name as your company name and agree to the terms and conditions. Naming the subscription as your company name helps us identify your request and approve it faster

Subscription Approval & Managing keys

You will receive an email when your subscription request is approved. Status of your request can be found under the ‘Profile’ section
After gaining a subscription, you can view/regenerate your subscription keys and use the interactive API portal.
You can recycle primary and secondary keys on the portal for each subscription. Once recycled, the previous key will not work and you must replace the newly created key to access the APIs

Using the keys

To call the APIs programmatically. You must include the header Ocp-Apim-Subscription-Key or the query parameter subscription-key with every request.

API definitions

Please refer to the API definitions here

Breed Mapping

Since the Rate API and redirect URLs require that a breed from the Figo list must be requested to quote, we understand that each affiliate's breed list may have differences - either missing or more breeds as compared to the Figo list (which is available to fetch using the Breed API) In this case we expect the affiliate to map their breeds with Figo as much as possible with the following principles:

Mixed breeds may be mapped to their respecting weight category. Example: A Cavapoo may be mapped to Mixed Dog 0 to 20 lbs.
Breed with non-English language characteristics but the same breed essentially may be mapped. Example: Appenzeller Sennenhunde would be mapped to Appenzell Mountain Dog
Breed names with punctuation and spaces differences may be mapped where it is clear the breeds are same. Chinese Shar-Pei may be mapped to Shar Pei.
Please work via your account representative to ask any questions relating to breed mapping and we'd be happy to review and assist.

Redirecting customer to Figo quote site

After a customer selects a combination of plan, reimbursement and deductible, the redirect URL must be created with the following format:

{{domain}}?PetName={PetName}&PetType={Dog/Cat}&PetSex={Male/Female}&PetBreed={PetBreed}&PetAge={PetAge}&PetZipCode={PetZipCode}&GroupCode={YourPromoCode}&email={CustomerEmail}7GroupCodeDscr={YourCompanyName}&plan={Essential/Preferred/Ultimate}&reimbursement={SelectedReimbursement}&deductible={SelectedDeductible}&subid={YourTrackingId}

Please note the below important points:

PetBreed is the breed name received as a response to the Rate API. Note this is not the Breed ID. Example - Afghan Hound
Pet Age is the Pet Age Name received as a response to the Rate API. Example: 1 year, 4 years etc.
Your relationship representative will provide you with the GroupCode value aka the promo code. The policy purchase can only be attributed to your business when this is added to the URL. Example: GroupCode=a1b2c3
Plan, reimbursement and deductible values on the URL are optional. If the customer selected a particular combination, adding these to the URL will land them on the same combo. If this combination is not available for any reason, the customer will land on the default options. Example: plan=preferred&reimbursement=80&deductible=250
Customers can further configure the quote on Figo quote site before purchasing which includes adding more pets to the same quote. All purchases will be attributed to your business as long as the GroupCode parameter is added.
Your unique tracking ID can be sent with the subid parameter. This can be reported back to you with sales reports.