verify_address
Read-only
Verify an address against Loqate's global reference data. Returns a confidence score (0-1), verification status, and a policy-driven accept/review/reject recommendation. Set 'suggest' to also get alternative addresses suggested by Loqate whenever the address does not clear the policy; offer them to the user and verify the chosen one in a second call before treating it as good. Suggestions require a separately licensed Loqate feature enabled on the account — without it, verification still succeeds and the problem is reported in suggestions.error. Requires a Loqate API key — pass it via the 'key' field (get one at account.loqate.com).
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| key | No | Loqate API key — required unless the server has one configured or the request carries an Authorization: Bearer header (get one at account.loqate.com) | |
| policy | No | Policy name: strict shipping standard (default) or permissive | |
| address | No | Full address string (free-form — use this OR structured fields below) | |
| country | No | ISO 2-letter country code (e.g. US GB DE) | |
| options | No | Loqate API options. Pass GeoCode here as a boolean — it is sent at the request root where Loqate expects it. In-Options booleans (Certify Version Enhance Deceased Goneaways) take JSON booleans; ServerOptions values (e.g. OutputCasing DefaultCountry) are strings | |
| premise | No | Premise or house number | |
| suggest | No | When true, look up alternative addresses suggested by Loqate and return them in the result as suggestions. Requires the Loqate address-suggestion feature to be enabled on the account (licensed separately from verification) — without it, verification still succeeds and the reason appears in suggestions.error. The lookup runs when the address is not accepted (review or reject) OR when it is accepted below the confidence floor (see suggest_below) — a policy accepts from its own minimum, so an accepted address is not necessarily a confident one. Address-only; off by default | |
| address2 | No | Second address line | |
| address3 | No | Third address line | |
| address4 | No | Fourth address line | |
| address5 | No | Fifth address line | |
| address6 | No | Sixth address line | |
| address7 | No | Seventh address line | |
| address8 | No | Eighth address line | |
| building | No | Building name | |
| latitude | No | Latitude for reverse geocode | |
| locality | No | City or town | |
| post_box | No | PO Box number | |
| postcode | No | Postal or ZIP code | |
| longitude | No | Longitude for reverse geocode | |
| admin_area | No | State or province | |
| verify_key | No | Custom address verification API key (overrides LOQATE_VERIFY_KEY env var) | |
| verify_url | No | Custom address verification endpoint URL (overrides LOQATE_VERIFY_URL env var) | |
| organization | No | Organization or business name | |
| sub_building | No | Sub-building (e.g. apartment, suite) | |
| thoroughfare | No | Street name | |
| suggest_below | No | Confidence floor for suggestions (0-1). An accepted address scoring below it still gets suggestions — policies accept from their own minimum, so an accepted address is not necessarily a confident one. Omit to use the policy value (standard 0.85); 0 disables the floor so only review/reject trigger a lookup | |
| suggest_limit | No | Maximum number of suggestions to return (1-10, default 5). Requires suggest | |
| suggestion_id | No | Id of a suggestion previously returned in address.suggestions. The tool retrieves that address's cleansed components from Loqate and verifies those, which is how you confirm a suggestion the user chose. Use INSTEAD OF address, not alongside it. CONSUMES A LOQATE CREDIT — pass one id, for the one suggestion that was chosen, never several. Ids are not stable over time; a stale one returns SUGGESTION_NOT_FOUND and you must search again rather than retry | |
| detect_country | No | When true and no country is supplied, guess the country from the address and flag the guess in the result (country_guessed). Address-only; off by default | |
| delivery_address | No | Full delivery address | |
| delivery_address1 | No | Delivery address line 1 | |
| delivery_address2 | No | Delivery address line 2 | |
| delivery_address3 | No | Delivery address line 3 | |
| delivery_address4 | No | Delivery address line 4 | |
| delivery_address5 | No | Delivery address line 5 | |
| delivery_address6 | No | Delivery address line 6 | |
| delivery_address7 | No | Delivery address line 7 | |
| delivery_address8 | No | Delivery address line 8 | |
| dependent_locality | No | Dependent locality (e.g. neighborhood) | |
| sub_building_floor | No | Floor number | |
| dependent_thoroughfare | No | Dependent street name | |
| sub_administrative_area | No | Sub administrative area (e.g. county) | |
| double_dependent_locality | No | Double dependent locality | |
| super_administrative_area | No | Super administrative area (e.g. region) |