Bound.re API Documentation

Postman collection → OpenAPI spec →

Introduction

Bound.re API allows you to manage your products and location items, as well as perform geospatial searches.

Base URL: https://bound.re

This documentation aims to provide all the information you need to work with our API.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting the API Tokens page in your account settings.

Product management

APIs for managing products

GET api/v1/products

GET

https://bound.re

/api/v1/products

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://bound.re/api/v1/products" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

POST api/v1/products

POST

https://bound.re

/api/v1/products

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

title

string

required

Must not be greater than 255 characters.

Example:

kkcbgasgvc

description

string

Must not be greater than 1000 characters.

Example:

Quisquam ea enim illo aperiam voluptas.

external_id

string

required

Must not be greater than 255 characters.

Example:

ewoatfstfd

currency_code

string

required

Must be 3 characters.

Example:

vbu

max_exposure_allowed

number

required

Example:

2.9256408

search_radius_unit

string

required

Must be one of:

mi
km

Example:

search_radius_distance

number

required

Example:

5.14208

Auth

Bearer

Headers

Body

{ "title": "kkcbgasgvc", "description": "Quisquam ea enim illo aperiam voluptas.", "external_id": "ewoatfstfd", "currency_code": "vbu", "max_exposure_allowed": 2.9256408, "search_radius_unit": "mi", "search_radius_distance": 5.14208 }

Received response

Example request:

curl --request POST \
    "https://bound.re/api/v1/products" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"kkcbgasgvc\",
    \"description\": \"Quisquam ea enim illo aperiam voluptas.\",
    \"external_id\": \"ewoatfstfd\",
    \"currency_code\": \"vbu\",
    \"max_exposure_allowed\": 2.9256408,
    \"search_radius_unit\": \"mi\",
    \"search_radius_distance\": 5.14208
}"

GET api/v1/products/{id}

GET

https://bound.re

/api/v1/products/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the product.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://bound.re/api/v1/products/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

Headers

                                                            cache-control
                                                            : no-cache, private
                                                                                                                    content-type
                                                            : application/json
                                                                                                                    access-control-allow-origin
                                                            : *

{
    "message": "Unauthenticated."
}

PUT api/v1/products/{id}

PUT

PATCH

https://bound.re

/api/v1/products/{id}

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the product.

Example:

Body Parameters

title

string

required

Must not be greater than 255 characters.

Example:

fiuamoq

description

string

Must not be greater than 1000 characters.

Example:

Dolor fugit dolorum sit.

external_id

string

required

Must not be greater than 255 characters.

Example:

szleqtwtdolgjaiogt

currency_code

string

required

Must be 3 characters.

Example:

bsq

max_exposure_allowed

number

required

Example:

457.36

search_radius_unit

string

required

Must be one of:

mi
km

Example:

search_radius_distance

number

required

Example:

1476.60115584

Auth

Bearer

Headers

URL Parameters

Body

{ "title": "fiuamoq", "description": "Dolor fugit dolorum sit.", "external_id": "szleqtwtdolgjaiogt", "currency_code": "bsq", "max_exposure_allowed": 457.36, "search_radius_unit": "km", "search_radius_distance": 1476.60115584 }

Received response

Example request:

curl --request PUT \
    "https://bound.re/api/v1/products/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"title\": \"fiuamoq\",
    \"description\": \"Dolor fugit dolorum sit.\",
    \"external_id\": \"szleqtwtdolgjaiogt\",
    \"currency_code\": \"bsq\",
    \"max_exposure_allowed\": 457.36,
    \"search_radius_unit\": \"km\",
    \"search_radius_distance\": 1476.60115584
}"

Upsert location item

APIs for upserting location items

Search for location items within the product's exposure area.

PUT

https://bound.re

/api/v1/products/{product_id}/location-items

requires authentication

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

product_id

integer

required

The ID of the product.

Example:

Body Parameters

external_id

string

required

Example:

quasi

cover_status

string

required

Must be one of:

quotation
on_cover
cancelled

Example:

quotation

coverage_amount

number

required

Must be between 0 and 9999999999999.99.

Example:

cover_start_date

string

required

Must be a valid date in the format Y-m-d\TH:i:sP.

Example:

2025-02-28T13:59:12+00:00

cover_end_date

string

required

Must be a valid date in the format Y-m-d\TH:i:sP. Must be a date after cover_start_date.

Example:

2071-07-30

location

object

required

line1

string

required

Must not be greater than 255 characters.

Example:

cgbpzdnzbhi

line2

string

Must not be greater than 255 characters.

Example:

jdqwwtwfpueozxjblqyuydw

town

string

required

Must not be greater than 255 characters.

Example:

eydpxxncpswhenym

county

string

Must not be greater than 255 characters.

Example:

hmozd

country

string

required

Must not be greater than 255 characters.

Example:

unhc

postal_code

string

required

Must not be greater than 255 characters.

Example:

szqpyzsgvohj

max_exposure_allowed

number

Must be between 0 and 9999999999999.99.

Example:

search_radius_unit

string

This field is required when search_radius_distance is present.

Must be one of:

mi
km

Example:

search_radius_distance

number

This field is required when search_radius_unit is present. Must be between 0 and 9999999999999.99.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "external_id": "quasi", "cover_status": "quotation", "coverage_amount": 0, "cover_start_date": "2025-02-28T13:59:12+00:00", "cover_end_date": "2071-07-30", "location": { "line1": "cgbpzdnzbhi", "line2": "jdqwwtwfpueozxjblqyuydw", "town": "eydpxxncpswhenym", "county": "hmozd", "country": "unhc", "postal_code": "szqpyzsgvohj" }, "max_exposure_allowed": 1, "search_radius_unit": "km", "search_radius_distance": 0 }

Received response

Example request:

curl --request PUT \
    "https://bound.re/api/v1/products/1/location-items" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"external_id\": \"quasi\",
    \"cover_status\": \"quotation\",
    \"coverage_amount\": 0,
    \"cover_start_date\": \"2025-02-28T13:59:12+00:00\",
    \"cover_end_date\": \"2071-07-30\",
    \"location\": {
        \"line1\": \"cgbpzdnzbhi\",
        \"line2\": \"jdqwwtwfpueozxjblqyuydw\",
        \"town\": \"eydpxxncpswhenym\",
        \"county\": \"hmozd\",
        \"country\": \"unhc\",
        \"postal_code\": \"szqpyzsgvohj\"
    },
    \"max_exposure_allowed\": 1,
    \"search_radius_unit\": \"km\",
    \"search_radius_distance\": 0
}"

Example response:

{
    "outcome": "added" | "not_added",
    "search_radius_unit": "km" | "mi",
    "search_radius_distance": 100,
    "max_exposure_allowed": 1000000,
    "max_exposure_from_date": "2024-05-01",
    "max_exposure_to_date": "2024-10-20",
    "max_exposure_amount_including_item": 754300,
    "max_exposure_amount_excluding_item": 704300,
    "total_exposure_amount_currency": "GBP"
}