DocsPOST /v1/enrich/restaurant
Docs
POST /v1/enrich/restaurant
Match a known restaurant and return Compass enrichment fields.
Request
| Field | Type | Notes |
|---|---|---|
| name | string | Required restaurant name. |
| address | string | Required unless google_place_id is provided. |
| google_place_id | string | Optional match key. Use only when already available from the customer workflow. |
curl -X POST "https://api.compassfoodtechnologies.com/v1/enrich/restaurant" \
-H "Content-Type: application/json" \
-H "X-Compass-API-Key: cmp_live_your_key_here" \
-d '{
"name": "Example Ramen",
"address": "123 Example Street, Brooklyn, NY"
}'Response
| Field | Type | Notes |
|---|---|---|
| matched | boolean | True when Compass matched above the confidence threshold. |
| match_confidence | number | 0 to 1 match confidence. |
| compass_id | string | null | Stable Compass restaurant ID when matched. |
| restaurant | object | Enriched restaurant object when matched. |
| match_candidates[] | array | Up to five candidates when no match clears the threshold. |
{
"compass_request_id": "req_abc123",
"matched": true,
"match_confidence": 0.97,
"compass_id": "restaurant_123",
"restaurant": {
"compass_id": "restaurant_123",
"name": "Example Ramen",
"vegan_score": {
"overall": 82,
"scoring_version": "v3.0-deterministic"
}
},
"ai_generated": true
}