Submit SI/SD

curl --request POST \
  --url https://app.withforerunner.com/api/v1/sisd \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "damage",
  "value": 125000,
  "date": "2024-03-15",
  "propertyMarketValue": 200000,
  "description": "Flood damage from March storm",
  "address": "123 Main St, Springfield, IL 62701",
  "parcelId": "12-34-567-890",
  "coordinates": [
    39.7817,
    -89.6501
  ],
  "externalSystemId": "DMG-2024-001"
}
'

import requests

url = "https://app.withforerunner.com/api/v1/sisd"

payload = {
    "type": "damage",
    "value": 125000,
    "date": "2024-03-15",
    "propertyMarketValue": 200000,
    "description": "Flood damage from March storm",
    "address": "123 Main St, Springfield, IL 62701",
    "parcelId": "12-34-567-890",
    "coordinates": [39.7817, -89.6501],
    "externalSystemId": "DMG-2024-001"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'damage',
    value: 125000,
    date: '2024-03-15',
    propertyMarketValue: 200000,
    description: 'Flood damage from March storm',
    address: '123 Main St, Springfield, IL 62701',
    parcelId: '12-34-567-890',
    coordinates: [39.7817, -89.6501],
    externalSystemId: 'DMG-2024-001'
  })
};

fetch('https://app.withforerunner.com/api/v1/sisd', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.withforerunner.com/api/v1/sisd",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'damage',
    'value' => 125000,
    'date' => '2024-03-15',
    'propertyMarketValue' => 200000,
    'description' => 'Flood damage from March storm',
    'address' => '123 Main St, Springfield, IL 62701',
    'parcelId' => '12-34-567-890',
    'coordinates' => [
        39.7817,
        -89.6501
    ],
    'externalSystemId' => 'DMG-2024-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.withforerunner.com/api/v1/sisd"

	payload := strings.NewReader("{\n  \"type\": \"damage\",\n  \"value\": 125000,\n  \"date\": \"2024-03-15\",\n  \"propertyMarketValue\": 200000,\n  \"description\": \"Flood damage from March storm\",\n  \"address\": \"123 Main St, Springfield, IL 62701\",\n  \"parcelId\": \"12-34-567-890\",\n  \"coordinates\": [\n    39.7817,\n    -89.6501\n  ],\n  \"externalSystemId\": \"DMG-2024-001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.withforerunner.com/api/v1/sisd")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"damage\",\n  \"value\": 125000,\n  \"date\": \"2024-03-15\",\n  \"propertyMarketValue\": 200000,\n  \"description\": \"Flood damage from March storm\",\n  \"address\": \"123 Main St, Springfield, IL 62701\",\n  \"parcelId\": \"12-34-567-890\",\n  \"coordinates\": [\n    39.7817,\n    -89.6501\n  ],\n  \"externalSystemId\": \"DMG-2024-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.withforerunner.com/api/v1/sisd")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"damage\",\n  \"value\": 125000,\n  \"date\": \"2024-03-15\",\n  \"propertyMarketValue\": 200000,\n  \"description\": \"Flood damage from March storm\",\n  \"address\": \"123 Main St, Springfield, IL 62701\",\n  \"parcelId\": \"12-34-567-890\",\n  \"coordinates\": [\n    39.7817,\n    -89.6501\n  ],\n  \"externalSystemId\": \"DMG-2024-001\"\n}"

response = http.request(request)
puts response.read_body

{
  "errors": [],
  "sisd": {
    "id": "a1b2c3d4-e5f6-4890-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": [
    {
      "message": "Required",
      "field": "type"
    }
  ],
  "sisd": null,
  "property": null
}

{
  "errors": [
    {
      "message": "Submission with external system id 2024-0417 already exists for this submission type",
      "field": "externalSystemId"
    }
  ],
  "sisd": null,
  "property": null
}

SI/SD

Submit SI/SD

Records an improvement or damage against a property so Forerunner can track it toward your community’s substantial improvement and substantial damage thresholds.

At least one of address, parcelId, or coordinates is required. Forerunner geocodes the location and fills in the property’s market value automatically.

Your community’s configuration may require extra identifiers, such as a permit ID. Send those as additional top-level fields alongside the ones documented here.

If this record pushes the property over a threshold, the response carries a warning saying so.

POST

api

sisd

Submit SI/SD

curl --request POST \
  --url https://app.withforerunner.com/api/v1/sisd \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "type": "damage",
  "value": 125000,
  "date": "2024-03-15",
  "propertyMarketValue": 200000,
  "description": "Flood damage from March storm",
  "address": "123 Main St, Springfield, IL 62701",
  "parcelId": "12-34-567-890",
  "coordinates": [
    39.7817,
    -89.6501
  ],
  "externalSystemId": "DMG-2024-001"
}
'

import requests

url = "https://app.withforerunner.com/api/v1/sisd"

payload = {
    "type": "damage",
    "value": 125000,
    "date": "2024-03-15",
    "propertyMarketValue": 200000,
    "description": "Flood damage from March storm",
    "address": "123 Main St, Springfield, IL 62701",
    "parcelId": "12-34-567-890",
    "coordinates": [39.7817, -89.6501],
    "externalSystemId": "DMG-2024-001"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    type: 'damage',
    value: 125000,
    date: '2024-03-15',
    propertyMarketValue: 200000,
    description: 'Flood damage from March storm',
    address: '123 Main St, Springfield, IL 62701',
    parcelId: '12-34-567-890',
    coordinates: [39.7817, -89.6501],
    externalSystemId: 'DMG-2024-001'
  })
};

fetch('https://app.withforerunner.com/api/v1/sisd', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.withforerunner.com/api/v1/sisd",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'type' => 'damage',
    'value' => 125000,
    'date' => '2024-03-15',
    'propertyMarketValue' => 200000,
    'description' => 'Flood damage from March storm',
    'address' => '123 Main St, Springfield, IL 62701',
    'parcelId' => '12-34-567-890',
    'coordinates' => [
        39.7817,
        -89.6501
    ],
    'externalSystemId' => 'DMG-2024-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.withforerunner.com/api/v1/sisd"

	payload := strings.NewReader("{\n  \"type\": \"damage\",\n  \"value\": 125000,\n  \"date\": \"2024-03-15\",\n  \"propertyMarketValue\": 200000,\n  \"description\": \"Flood damage from March storm\",\n  \"address\": \"123 Main St, Springfield, IL 62701\",\n  \"parcelId\": \"12-34-567-890\",\n  \"coordinates\": [\n    39.7817,\n    -89.6501\n  ],\n  \"externalSystemId\": \"DMG-2024-001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://app.withforerunner.com/api/v1/sisd")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"type\": \"damage\",\n  \"value\": 125000,\n  \"date\": \"2024-03-15\",\n  \"propertyMarketValue\": 200000,\n  \"description\": \"Flood damage from March storm\",\n  \"address\": \"123 Main St, Springfield, IL 62701\",\n  \"parcelId\": \"12-34-567-890\",\n  \"coordinates\": [\n    39.7817,\n    -89.6501\n  ],\n  \"externalSystemId\": \"DMG-2024-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.withforerunner.com/api/v1/sisd")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"type\": \"damage\",\n  \"value\": 125000,\n  \"date\": \"2024-03-15\",\n  \"propertyMarketValue\": 200000,\n  \"description\": \"Flood damage from March storm\",\n  \"address\": \"123 Main St, Springfield, IL 62701\",\n  \"parcelId\": \"12-34-567-890\",\n  \"coordinates\": [\n    39.7817,\n    -89.6501\n  ],\n  \"externalSystemId\": \"DMG-2024-001\"\n}"

response = http.request(request)
puts response.read_body

{
  "errors": [],
  "sisd": {
    "id": "a1b2c3d4-e5f6-4890-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": [
    {
      "message": "Required",
      "field": "type"
    }
  ],
  "sisd": null,
  "property": null
}

{
  "errors": [
    {
      "message": "Submission with external system id 2024-0417 already exists for this submission type",
      "field": "externalSystemId"
    }
  ],
  "sisd": null,
  "property": null
}

Authorizations

Authorization

string

header

required

Your account's API key, sent as Authorization: Bearer <your API key>. Keys are issued per environment, so a staging key will not work against production.

Body

application/json

type

enum<string>

required

Whether this records an improvement or damage.

Available options:

improvement,

damage

Example:

"damage"

value

number

required

Cost of the improvement or damage, in dollars.

Required range: x >= 0

Example:

125000

date

string

required

When the improvement or damage occurred. Accepts ISO 8601 (2024-03-15) or MM/DD/YYYY (03/15/2024).

Example:

"2024-03-15"

propertyMarketValue

number | null

Market value of the structure before the improvement or damage, in dollars. Used to work out whether the cost meets your community's threshold, typically 50% of this value. Forerunner fills it in automatically when omitted.

Required range: x >= 0

Example:

200000

description

string | null

What the improvement or damage was.

Example:

"Flood damage from March storm"

address

string | null

Address to save the record against, as {number} {name} {postfix}, {city}, {state} {zip}.

Example:

"123 Main St, Springfield, IL 62701"

parcelId

string | null

Parcel identifier, sometimes called a parcel number, to save the record against.

Example:

"12-34-567-890"

coordinates

object | null

Location as a [latitude, longitude] pair in EPSG:4326 (WGS 84).

Show child attributes

Example:

[39.7817, -89.6501]

externalSystemId

string | null

Your system's identifier for this SI/SD record. Reusing an identifier returns 409.

Example:

"DMG-2024-001"

{key}

any

Response

Success. errors is empty.

errors

object[]

required

Empty when the request succeeded. Otherwise one entry per failure, and the resource fields on the response are empty: null for single resources, [] for lists, with pageInfo omitted.

Show child attributes

Example:

[]

sisd

object | null

required

The created SI/SD record. Null when creation failed.

Show child attributes

property

object | null

required

Threshold warnings for the property this record was saved against.

Show child attributes

Getting started

Endpoints

Concepts

Integration

Submit SI/SD

Authorizations

Body

Response