Skip to main content
POST
Resolve Dealer
POST /v1/dealers/resolve
v1.0 schema lock. The response shape on this page is the locked v1.0 contract. We will never remove a documented field, never rename a field, and never change a field’s type without bumping to v2 (see Versioning). New fields may be added additively; your client must tolerate unknown keys.
Look up a dealership by website URL, business name and address, or VIN. Returns dealer info, whether it’s supported, and whether setup is required. You must provide one of:
  • dealership_url alone
  • dealership_url + vin (URL first, VIN fallback)
  • dealer_name + vin
  • vin alone
  • dealer_name + dealer_address

Request Body

Resolution Methods

Example — URL

Example — VIN + Dealer Name

Response

Additional Response Fields (VIN and Address Resolution Only)

These fields appear only when resolving by VIN, name + address, or SERP fallback — not in direct URL lookups:

Error Responses

LOW_CONFIDENCE_MATCH

Returned when the resolution finds candidates but confidence is below the threshold:

Dealer Group Detection

When resolving by name + address, if the name matches a dealer group with multiple brands (e.g. “Friendship” in Bristol, TN), the endpoint returns a DEALER_GROUP_DETECTED error with a list of candidates. Include the brand in the name (e.g. “Friendship Ford”) to resolve to a specific dealership.

Body

application/json
api_key
string
required
dealership_url
string | null
dealer_name
string | null
vin
string | null
dealer_address
Dealer Address · object | null

Response

Successful Response