Submit File

endpoint

/api/v1/files

Upload a new file to Forerunner and optionally associate it with a property.

This endpoint accepts multipart/form-data, not JSON. All parameters, including metadata like fileType and address, must be sent as form fields alongside the file. Do not send a JSON body. See the cURL example below and the Content-Type section in the API overview for more details.

Form Fields

file

required

The file to upload. The allowed MIME types depend on the selected fileType for your account.

string

required

Type of file being uploaded. Common examples include: Elevation Certificate, Building Permit, Property Image, or other document type names configured for your account.The value must match an existing document type name in your Forerunner account. See File types for how document types are configured.

string

Street address to associate with the file (e.g., “123 Main St, Springfield, IL”)

string

Parcel ID to associate with the file

array

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

[39.78, -89.65]

string

Unique identifier within your system for duplicate detection. If a file with the same externalSystemId already exists, the API returns a 409 HTTP status code.

At least one of address, parcelId, or coordinates is required for non-Elevation Certificate files. If multiple are provided, they will be used to find or create the appropriate property record. Only single documents are accepted per request.

Response

object

Show properties

string

UUID uniquely identifying the file

string

Authenticated access link to the document

array

Array of error objects. See Errors.

curl -X POST https://app.withforerunner.com/api/v1/files \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -F "fileUpload=@elevation_cert.pdf" \
  -F "fileType=Elevation Certificate" \
  -F "address=123 Main St, Springfield, IL"

{
  "file": {
    "id": "f8a3b2c1-d4e5-6789-abcd-ef0123456789",
    "url": "https://app.withforerunner.com/files/f8a3b2c1-d4e5-6789-abcd-ef0123456789"
  },
  "errors": []
}

{
  "file": {
    "id": "f8a3b2c1-d4e5-6789-abcd-ef0123456789",
    "url": "https://app.withforerunner.com/files/f8a3b2c1-d4e5-6789-abcd-ef0123456789"
  },
  "errors": [
    {
      "message": "Could not find property with the provided address",
      "field": "address"
    }
  ]
}

Getting started

API reference

Integration

Form Fields

Response

​Form Fields

​Response

Form Fields

Response