Verify address, email, and/or phone together. Returns individual results plus an overall recommendation (most conservative of all provided fields). 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.
View input schema
{
"type": "object",
"properties": {
"key": {
"type": "string",
"description": "Loqate API key — required unless the server has one configured or the request carries an Authorization: Bearer header"
},
"verify_url": {
"type": "string",
"description": "Custom address verification endpoint URL (overrides LOQATE_VERIFY_URL env var)"
},
"verify_key": {
"type": "string",
"description": "Custom address verification API key (overrides LOQATE_VERIFY_KEY env var)"
},
"address": {
"type": "string",
"description": "Full address string"
},
"suggestion_id": {
"type": "string",
"description": "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"
},
"locality": {
"type": "string",
"description": "City or town"
},
"admin_area": {
"type": "string",
"description": "State or province"
},
"postcode": {
"type": "string",
"description": "Postal or ZIP code"
},
"country": {
"type": "string",
"description": "ISO 2-letter country code"
},
"detect_country": {
"type": "boolean",
"description": "When true and no country is supplied, guess the country from the address and flag the guess in the result (country_guessed). Address-only — does not affect phone or email; off by default"
},
"suggest": {
"type": "boolean",
"description": "When true, look up alternative addresses suggested by Loqate and return them under address.suggestions. Requires the Loqate address-suggestion feature to be enabled on the account (licensed separately from verification). The lookup runs when the address is not accepted (review or reject) OR when it is accepted below the confidence floor (see suggest_below). Address-only — does not affect phone or email; off by default"
},
"suggest_limit": {
"type": "integer",
"description": "Maximum number of suggestions to return (1-10, default 5). Requires suggest"
},
"suggest_below": {
"type": [
"null",
"number"
],
"description": "Confidence floor for suggestions (0-1). An accepted address scoring below it still gets suggestions. Omit to use the policy value (standard 0.85); 0 disables the floor. Address-only"
},
"email": {
"type": "string",
"description": "Email address to verify"
},
"phone": {
"type": "string",
"description": "Phone number to verify"
},
"policy": {
"type": "string",
"description": "Policy name: strict shipping standard (default) or permissive"
},
"options": {
"type": "object",
"description": "Loqate API options as nested JSON, e.g. {\"ServerOptions\": {\"FieldStatus\": \"true\"}}. Dot notation is equivalent: {\"ServerOptions.FieldStatus\": \"true\"}. 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. Set ServerOptions.FieldStatus to \"true\" to get the changes list",
"additionalProperties": true
},
"address2": {
"type": "string",
"description": "Second address line"
},
"address3": {
"type": "string",
"description": "Third address line"
},
"address4": {
"type": "string",
"description": "Fourth address line"
},
"address5": {
"type": "string",
"description": "Fifth address line"
},
"address6": {
"type": "string",
"description": "Sixth address line"
},
"address7": {
"type": "string",
"description": "Seventh address line"
},
"address8": {
"type": "string",
"description": "Eighth address line"
},
"delivery_address": {
"type": "string",
"description": "Full delivery address"
},
"delivery_address1": {
"type": "string",
"description": "Delivery address line 1"
},
"delivery_address2": {
"type": "string",
"description": "Delivery address line 2"
},
"delivery_address3": {
"type": "string",
"description": "Delivery address line 3"
},
"delivery_address4": {
"type": "string",
"description": "Delivery address line 4"
},
"delivery_address5": {
"type": "string",
"description": "Delivery address line 5"
},
"delivery_address6": {
"type": "string",
"description": "Delivery address line 6"
},
"delivery_address7": {
"type": "string",
"description": "Delivery address line 7"
},
"delivery_address8": {
"type": "string",
"description": "Delivery address line 8"
},
"super_administrative_area": {
"type": "string",
"description": "Super administrative area"
},
"sub_administrative_area": {
"type": "string",
"description": "Sub administrative area (e.g. county)"
},
"dependent_locality": {
"type": "string",
"description": "Dependent locality (e.g. neighbourhood)"
},
"double_dependent_locality": {
"type": "string",
"description": "Double dependent locality"
},
"thoroughfare": {
"type": "string",
"description": "Street name"
},
"dependent_thoroughfare": {
"type": "string",
"description": "Dependent street name"
},
"building": {
"type": "string",
"description": "Building name"
},
"premise": {
"type": "string",
"description": "Premise or house number"
},
"sub_building": {
"type": "string",
"description": "Sub-building (e.g. flat, apartment or suite)"
},
"sub_building_floor": {
"type": "string",
"description": "Floor"
},
"organization": {
"type": "string",
"description": "Company or organisation name"
},
"post_box": {
"type": "string",
"description": "PO box"
},
"latitude": {
"type": "string",
"description": "Latitude, for a reverse geocode"
},
"longitude": {
"type": "string",
"description": "Longitude, for a reverse geocode"
},
"contact": {
"type": "string",
"description": "Contact name for the delivery"
},
"function": {
"type": "string",
"description": "Contact's job title or function"
},
"department": {
"type": "string",
"description": "Department within the organisation"
},
"forename": {
"type": "string",
"description": "Recipient's first name"
},
"surname": {
"type": "string",
"description": "Recipient's last name"
},
"middle_name": {
"type": "string",
"description": "Recipient's middle name"
},
"full_name": {
"type": "string",
"description": "Recipient's full name"
},
"id": {
"type": "string",
"description": "Your own identifier for this record, echoed back by Loqate"
}
},
"additionalProperties": false
}