API Reference

Authentication

All API requests require an X-API-Key header. Your API key is available in the Franchisor Dashboard.

X-API-Key: sv_demo_key_abc123

Demo key: sv_demo_key_abc123 — 100 evaluations/month (Growth tier)

POST /api/franchisor/score

Score a single location. Returns a full location score with breakdown, insights, and competitor data.

Request

curl -X POST https://fundbizpro.com/api/franchisor/score \
  -H "Content-Type: application/json" \
  -H "X-API-Key: sv_demo_key_abc123" \
  -d '{
    "address": "3777 Boul. Matte, Brossard, QC",
    "category": "coffee"
  }'

Response

{
  "score": 8.7,
  "passed": true,
  "breakdown": {
    "transit": 10,
    "competitor": 7,
    "marketFit": 10
  },
  "story": "Prime Location",
  "insights": [
    {
      "headline": "Panama REM station 180m away — exceptional transit access",
      "detail": "Transit proximity is the strongest predictor of weekday foot traffic."
    }
  ],
  "competitors": [
    { "name": "Tim Hortons", "rating": 3.8 },
    { "name": "Cafe Depot", "rating": 4.1 }
  ],
  "coordinates": { "lat": 45.4937, "lng": -73.474 },
  "nearestStation": "Panama",
  "transitDistanceMetres": 180,
  "avgCompetitorRating": 3.9,
  "competitorCount": 5
}

Webhook Support

For integrations that need non-blocking scoring, pass a webhookUrl in the request body. FundBizPro responds immediately with a requestId and POSTs the full result to your URL when scoring completes.

// Request with webhook
{
  "address": "3777 Boul. Matte, Brossard, QC",
  "category": "coffee",
  "webhookUrl": "https://your-system.com/hooks/fundbizpro"
}

// Immediate response (scoring happens async)
{ "queued": true, "requestId": "a1b2c3d4-..." }

// FundBizPro POSTs to your webhookUrl when done:
{
  "requestId": "a1b2c3d4-...",
  "score": 8.7,
  "passed": true,
  "breakdown": { "transit": 10, "competitor": 7, "marketFit": 10 },
  ...
}

Valid Categories

Error Codes

Plan Limits

Quotas reset on the 1st of each month. Upgrade anytime at fundbizpro.com/pricing