Welcome to the Anansi API documentation!
Here you’ll find a series of guides that detail how to integrate with the Anansi API to embed goods-in-transit insurance protection into your system.
The documentation is designed to assist application developers from within two Company types, defined by Anansi as follows:
- a) Partner Company (third party provider)
An entity who has an integration or referral agreement with Anansi and whose clients are merchants.
- b) Partner Company (retailer)
An entity who has an integration or referral agreement with Anansi and who sells goods directly to the public.
Each guide will include feature requirements, examples and API endpoints using standard HTTP requests. For detailed documentation on each API endpoint, visit our Swagger docs.
Glossary
Below are definitions of important terms that we use across the guides.
| Term | Definition |
|---|---|
| Merchant | Business selling goods to the public that is served by a third party such as a 3PL, ecommerce platform, shipping platform, or ecommerce marketplace. |
| Policyholder | Business who is the legal owner of the Anansi goods-in-transit insurance policy. |
| Partner Company (third party provider) | Entity who has an integration or referral agreement with Anansi and whose clients are merchants. |
| Partner Company (retailer) | Entity who has an integration or referral agreement with Anansi and who sells goods directly to the public. |
| Parcel | A full or partial order comprising an item or collection of items (goods) packaged to be shipped to the Customer. |
| Shipment | A parcel containing a singular item or a collection of items (goods) in transit between an origin and destination address. |
| Order | A singular or group of items (goods) to be sent to the Customer originating from the Customers purchase of n item(s) from a Merchants website. |
| Consignment | Group of 2+ parcels in transit between an origin and destination address. |
Integration overview
The API allows you to interact with the Anansi system to offer automated insurance.
Each guide includes a suggested approach to the UI’s that Partner Companies need to build, as well as details of the legal requirements for performing some functions.
Anansi is regulated by the Financial Conduct Authority (FCA). Therefore, there are some functions that Anansi is obliged to carry out directly. The below table provides an outline of whether a Partner Company (third party provider or retailer), or Anansi is responsible for the function.
Anansi is working towards releasing all functions via the API to be available for regulated Partner Companies.
| Feature | Function | Responsible | Notes |
|---|---|---|---|
| Policyholder onboarding | Show Policy Documents, Validate Policyholder Journey and Send Information via the API. | Partner Company (third party provider) Or Partner Company (retailer). | If Partner Company (third party provider), Anansi will email this information directly to each Merchant. |
| New Shipments | Share new shipments with Anansi. | Partner Company (third party provider) Or Partner Company (retailer). | |
| Shipment Updates | Send shipping updates for a previously added parcel. | Partner Company (third party provider) Or Partner Company (retailer). | If Partner Company (third party provider) Or Partner Company (retailer) is unable to provide shipping updates, Anansi can become responsible for this feature. |
| Policy Issuance | Issue insurance policies for parcels selected to be insured. | Anansi. | Partner Company (third party provider) and Partner Company (retailer) can view policies issued via API. |
| Automated Claims | Processing and reimbursement of claim payments. | Anansi. | Partner Company (third party provider) and Partner Company (retailer) canview claims and their status via API. |
| Manual Claims | Policyholder(s) access the Anansi app to make a manual claim. | Anansi. | Partner Company (third party provider) and Partner Company (retailer) can view the claims and their status via API. |
| Invoices | Issuance of monthly premium invoices and Processing premium payments. | Anansi. | Policyholder(s)can view their invoices in the Anansi app. |
| Policyholder Account Information | Store Policyholder(s) insurance documentation. | Anansi. | Policyholder Account Information can be shared within Partner Company (third party provider) and Partner Company (retailer) dashboard. |
| Update coverage values | Change values to be insured and Pause insurance. | Anansi. | Partner Company (third party provider) and Partner Company (retailer) can change this via API. |