Skip to main content
GET /api/external/companies/{companyId}/resolve-address?address=<freeform> Pre-flight utility for FMV1 integrators. Geocodes a freeform address string and returns the structured sub-fields (street, city, state, county, country, zipCode) in the shape FMV1 rating expects. Most often used to derive county when upstream data does not include it. The endpoint is read-only — writes are not enriched automatically. Call this before constructing your create/update payload.

Why this exists

FMV1 enforces strict completeness on Address object-primitive values: if any sub-field is missing, the write is rejected. county is the sub-field most often missing from upstream sources. This endpoint fills that gap.

Request

Required permission: company:read

Response — 200 OK

Returns the Address object primitive — all six sub-fields populated.
zipCode is always returned as a string with leading zeros preserved (e.g. "02140"). The response shape is identical to the FMV1 Address sub-object — paste the response straight into a create/update payload’s address field.

Failure behavior

If geocoding succeeds but any required sub-field cannot be determined, the endpoint returns 400 with a distinct problemCode — partial addresses are never returned as success. Branch on problemCode to know which sub-field was the problem.