> ## Documentation Index
> Fetch the complete documentation index at: https://withforerunner.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /developers/v1/openapi.json post /api/v1/sisd
openapi: 3.1.0
info:
  title: Forerunner Integration API v1
  version: 1.0.0
  description: >-
    Read and write floodplain data in Forerunner. This is the v1 contract; each
    version is documented separately and evolves on its own.


    v1 is the current version. It covers files, properties, records, and SI/SD,
    and is the one to build against. Its record endpoints handle `Log` records
    only; use v2 for any other record type.


    Every request needs an `Authorization: Bearer <your API key>` header.


    List endpoints return 25 results per page; page through them with `page` and
    read `pageInfo` for the totals. Every JSON response carries an `errors`
    array, empty when the request succeeded; the `401`, `403`, and `429`
    responses are plain text or HTML instead.


    Develop against the staging server, which is a separate account with
    separate API keys and separate data.


    Requests are rate limited per IP at the CDN. A request over the limit is
    answered with a `429` and an HTML body, not the JSON error shape.
servers:
  - url: https://app.withforerunner.com
    description: Production
  - url: https://app.staging.withforerunner.com
    description: Staging, for development and testing
security:
  - bearerAuth: []
tags:
  - name: Files
    description: >-
      Upload, retrieve, and update documents such as Elevation Certificates and
      permits.
  - name: Properties
    description: Query the properties in your account.
  - name: Records
    description: >-
      Read, create, update, and delete `Log` records. Other record types are
      available on v2.
  - name: SI/SD
    description: >-
      Track substantial improvement and substantial damage against your
      community's thresholds.
paths:
  /api/v1/sisd:
    post:
      tags:
        - SI/SD
      summary: Submit SI/SD
      description: >-
        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.
      operationId: createSISD
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  type: string
                  enum:
                    - improvement
                    - damage
                  description: Whether this records an improvement or damage.
                  example: damage
                value:
                  type: number
                  minimum: 0
                  description: Cost of the improvement or damage, in dollars.
                  example: 125000
                propertyMarketValue:
                  description: >-
                    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.
                  example: 200000
                  anyOf:
                    - type: number
                      minimum: 0
                    - type: 'null'
                description:
                  description: What the improvement or damage was.
                  example: Flood damage from March storm
                  type:
                    - string
                    - 'null'
                address:
                  description: >-
                    Address to save the record against, as `{number} {name}
                    {postfix}, {city}, {state} {zip}`.
                  example: 123 Main St, Springfield, IL 62701
                  type:
                    - string
                    - 'null'
                parcelId:
                  description: >-
                    Parcel identifier, sometimes called a parcel number, to save
                    the record against.
                  example: 12-34-567-890
                  type:
                    - string
                    - 'null'
                coordinates:
                  anyOf:
                    - type: array
                      prefixItems:
                        - type: number
                          minimum: -90
                          maximum: 90
                        - type: number
                          minimum: -180
                          maximum: 180
                      items: false
                      minItems: 2
                      maxItems: 2
                      description: >-
                        Location as a `[latitude, longitude]` pair in EPSG:4326
                        (WGS 84).
                      example:
                        - 39.7817
                        - -89.6501
                    - type: 'null'
                date:
                  type: string
                  description: >-
                    When the improvement or damage occurred. Accepts ISO 8601
                    (`2024-03-15`) or `MM/DD/YYYY` (`03/15/2024`).
                  example: '2024-03-15'
                externalSystemId:
                  description: >-
                    Your system's identifier for this SI/SD record. Reusing an
                    identifier returns 409.
                  example: DMG-2024-001
                  type:
                    - string
                    - 'null'
              required:
                - type
                - value
                - date
              additionalProperties: {}
      responses:
        '200':
          description: Success. `errors` is empty.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1CreateSISDResponse'
              example:
                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.
        '400':
          description: The request failed validation. `errors` names each field at fault.
          content:
            application/json:
              schema:
                anyOf:
                  - $ref: '#/components/schemas/V1CreateSISDResponse'
                  - $ref: '#/components/schemas/APIResponse'
              example:
                errors:
                  - message: Required
                    field: type
                sisd: null
                property: null
        '401':
          description: >-
            Missing or invalid API key. The body is plain text, not the JSON
            error shape.
        '403':
          description: >-
            Blocked by our web application firewall, which answers with an HTML
            body rather than the JSON error shape. Most often caused by a client
            sending a `PostmanRuntime`, `python-requests`, or `HeadlessChrome`
            `User-Agent`; clear that header and retry.
        '409':
          description: >-
            Another resource already uses that `externalSystemId`. Nothing was
            created.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/V1CreateSISDResponse'
              example:
                errors:
                  - message: >-
                      Submission with external system id 2024-0417 already
                      exists for this submission type
                    field: externalSystemId
                sisd: null
                property: null
        '429':
          description: >-
            Too many requests from your IP. Rate limiting is applied at the CDN,
            so the body is HTML rather than the JSON error shape. Back off and
            retry.
components:
  schemas:
    V1CreateSISDResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/APIError'
          description: >-
            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.
          example: []
        sisd:
          anyOf:
            - $ref: '#/components/schemas/V1SISDReference'
            - type: 'null'
          description: The created SI/SD record. Null when creation failed.
        property:
          anyOf:
            - $ref: '#/components/schemas/V1SISDPropertyWarnings'
            - type: 'null'
          description: Threshold warnings for the property this record was saved against.
      required:
        - errors
        - sisd
        - property
      additionalProperties: false
    APIResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/APIError'
          description: >-
            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.
          example: []
      required:
        - errors
      additionalProperties: false
      description: Every response carries an `errors` array alongside its resource fields.
    APIError:
      type: object
      properties:
        message:
          type: string
          description: Human-readable description of what went wrong.
          example: Required
        field:
          type: string
          description: The request field that caused the error, as a dot-separated path.
          example: data.type
      required:
        - message
        - field
      additionalProperties: false
      description: A single validation or processing failure.
    V1SISDReference:
      type: object
      properties:
        id:
          type: string
          description: UUID of the SI/SD record.
          example: a1b2c3d4-e5f6-4890-abcd-ef1234567890
      required:
        - id
      additionalProperties: false
    V1SISDPropertyWarnings:
      type: object
      properties:
        warnings:
          type: array
          items:
            type: object
            properties:
              message:
                type: string
                description: The warning text.
                example: >-
                  The damage costs recorded for this property meet or exceed
                  your community's Substantial Damage threshold. Further action
                  might be necessary to ensure compliance.
            required:
              - message
            additionalProperties: false
          description: >-
            Threshold warnings raised for the property after this record was
            saved. Empty when no threshold was met.
      required:
        - warnings
      additionalProperties: false
      description: Compliance warnings for the property this record was saved against.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        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.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.