Submit SI/SD

endpoint

/api/v1/sisd

Create a new Substantial Improvement or Substantial Damage record.

Body Parameters

string

required

Type of record: improvement or damage

number

required

Dollar amount of the improvement or damage (non-negative, e.g., 3451.23)

string

required

Date of the improvement or damage. Accepts ISO 8601 format (e.g., 2024-03-15) or MM/DD/YYYY format (e.g., 03/15/2024).

string

Human-readable description providing context about the improvement or damage

number

Total property market value in dollars before the improvement or damage. Used to calculate if 50% threshold is met.

string

Fully qualified street address in the format: {streetNumber} {streetName} {streetPostfix}, {city}, {state} {zip} (e.g., 123 Main St, Springfield, IL 62701)

string

Parcel identifier (sometimes called “parcel number”)

array

Two-element array [latitude, longitude] in EPSG:4326 format

string

Unique identifier from your system. If a record with this ID already exists, the request returns a 409 Conflict error.

Provide at least one of address, parcelId, or coordinates to associate the SI/SD record with a property. Forerunner attempts geocoding and market value identification automatically. Account-specific unique identifiers (e.g., Permit ID) may be required as additional parameters depending on your community configuration.

Response

object

The created SI/SD record

Show sisd object properties

string

UUID uniquely identifying the SI/SD record

object

Property information and warnings

Show property object properties

array

Array of warning objects indicating threshold compliance issues (e.g., “The improvement costs recorded for this property meet or exceed your community’s Substantial Improvement threshold.”)

array

Array of error objects. When non-empty, the sisd object is absent. See Errors.

curl -X POST https://app.withforerunner.com/api/v1/sisd \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "type": "damage",
    "value": 125000,
    "date": "2024-03-15",
    "description": "Flood damage from March storm",
    "propertyMarketValue": 200000,
    "address": "123 Main St, Springfield, IL 62701",
    "externalSystemId": "DMG-2024-001"
  }'

{
  "sisd": {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
  },
  "property": {
    "warnings": [
      {
        "message": "The damage costs recorded for this property meet or exceed your community's Substantial Damage threshold. Further action might be necessary to ensure compliance."
      }
    ]
  },
  "errors": []
}

{
  "sisd": {
    "id": "f0e1d2c3-b4a5-6789-0fed-cba987654321"
  },
  "property": {
    "warnings": []
  },
  "errors": []
}

Getting started

API reference

Integration

Body Parameters

Response

​Body Parameters

​Response

Body Parameters

Response