Catalog

The taxonomy and the products this business may sell.

GET/taxonomyThe active product taxonomy

The active product taxonomy

The classes, categories and product types products are filed under. Only active nodes are served, grouped by level and sorted by parent then sort order.

lock

Requires API key authentication. The API key issued to the business, sent as `<keyId>:<secret>`, for example `sk_test_0123456789abcdef0123456789abcdef:<secret>`. The key id prefix selects the environment: `sk_test_` keys read and write test data, `sk_live_` keys production data.

Responses

The active taxonomy.

null

boltTry it

env

GET/api/v1/taxonomy

Code samples

curl -X GET '/api/v1/taxonomy'

GET/productsList the products this business may sell

List the products this business may sell

Only products available to this business in this key's environment are listed; availability cannot be relaxed from the query string.

Paging is by opaque cursor. Send no cursor for the first page, then send back the nextCursor the previous page returned, unchanged, until nextCursor is null. A page may be shorter than limit and still carry a nextCursor: a short page is not the end of the list, only a null nextCursor is. A cursor this API did not issue is refused with 400.

Text search (q) is single-page: it answers the best matches for the query and always returns nextCursor: null, so pair q with limit rather than paging it.

lock

Parameters

qquerystringdefault: Free-text search across the catalog. Single-page: the response always carries nextCursor: null.

categoryquerystringdefault: Provider category code to filter by.

productTypequerystringdefault: Platform product type code from /taxonomy.

classCodequerystringdefault: Platform class code from /taxonomy.

limitqueryintegerdefault: Page size. Defaults to 20.

cursorquerystringdefault: Opaque cursor from the previous page's nextCursor. Do not construct or decode it.

Responses

One page of products.

{
  "items": [],
  "nextCursor": null
}

boltTry it

env

GET/api/v1/products

Query parameters

q

category

productType

classCode

limit

cursor

Code samples

curl -X GET '/api/v1/products'

GET/products/{providerId}/{productId}Read one product

Read one product

A product this business may not sell, one hidden by its status, and one that does not exist are the same 404. The configuration is best-effort: when the insurer cannot be reached for it the product is still served, with config: null and configStatus: "unavailable".

lock

Responses

The product and its configuration.

null

boltTry it

env

GET/api/v1/products/{providerId}/{productId}

Code samples

curl -X GET '/api/v1/products/{providerId}/{productId}'

GET/commercial-ratesThis business's own commercial rate per available product

This business's own commercial rate per available product

The share of each available product's price this business receives, resolved from the platform's commercial configuration. The platform's own share is never included. Scoped to the key's environment, exactly as GET /products is.

Paging is by opaque cursor, exactly as GET /products pages: send no cursor for the first page, then send back the nextCursor the previous page returned, unchanged, until nextCursor is null. A page may be shorter than limit and still carry a nextCursor; only a null nextCursor means the list is exhausted. A cursor this API did not issue is refused with 400.

lock

Parameters

productIdquerystringdefault: Only this product's rate.

limitqueryintegerdefault: Page size. Defaults to 20.

cursorquerystringdefault: Opaque cursor from the previous page's nextCursor. Do not construct or decode it.

Responses

One page of resolved rates.

{
  "items": [],
  "nextCursor": null
}

boltTry it

env

GET/api/v1/commercial-rates

Query parameters

productId

limit

cursor

Code samples

curl -X GET '/api/v1/commercial-rates'

arrow_back