Loqate
Capability: Location Validation
Market: UK
Business Capabilities
Find and retrieve addresses based on text input. The connector supports a two-step lookup flow: first search for address candidates using partial input (postal code, street name, or free text), then retrieve the fully formatted address using the candidate's unique ID. This pattern allows type-ahead autocomplete in forms and drilldown through address hierarchies.
Exposed Endpoints
- Find an address (
POST /api/loqate/v1/find) - Uses a text search to find addresses and places. This endpoint does not return formatted addresses. Make repeated calls to drill down through results until an address ID appears, then pass theidto the retrieve endpoint for a fully formatted address. - Retrieve an address (
POST /api/loqate/v1/retrieve) - Returns the full address details based on theid.
Vault Configuration
loqate.apiKey- API key for the Loqate API (plain text).loqate.baseUrl- Base URL of the Loqate API.
Request Structures and Samples
POST /api/loqate/v1/find
Request structure (search by postal code):
{
"address": {
"postalCode": "string",
"countryNameAlpha2": "string"
}
}
With container for drill-down:
{
"address": {
"postalCode": "string",
"countryNameAlpha2": "string",
"additionalFields": {
"container": "string"
}
}
}
Sample request:
{
"address": {
"postalCode": "BT71 7EN",
"countryNameAlpha2": "GB",
"additionalFields": {
"container": "GB|RM|ENG|7EN-BT71"
}
}
}
Sample response:
{
"addressList": [
{
"additionalFields": {
"highlight": "",
"description": "Dungannon, BT71 7EN"
},
"id": "GB|RM|B|3745163",
"text": "1st Alert Alarm Systems, 44A, Rhone Road",
"addressType": "Address"
}
]
}
POST /api/loqate/v1/retrieve
Request structure:
{
"address": {
"id": "string"
}
}
Sample request:
{
"address": {
"id": "GB|RM|B|55605138|ENG"
}
}
Sample response:
{
"addressList": [
{
"id": "GB|RM|B|55605138|ENG",
"addressLine1": "Old Change House",
"addressLine2": "128 Queen Victoria Street",
"postalCode": "EC4V 4BJ",
"countryName": "United Kingdom",
"countryNameAlpha2": "GB",
"addressType": "Commercial",
"company": "G B G"
}
]
}
Error Codes
Errors follow the standard Data Core error response format:
{
"status": 400,
"title": "Bad Request",
"detail": "Description of the error"
}
| Status | Meaning | Triggered By |
|---|---|---|
400
|
Bad Request | Missing or invalid fields (for example, missing postalCode or countryNameAlpha2). |
401
|
Unauthorized | Missing or invalid authentication token. |
502
|
Bad Gateway | Loqate API returned an error or is unreachable. |
503
|
Service Unavailable | Connection to Loqate could not be established. |
504
|
Gateway Timeout | Loqate API did not respond within the timeout period. |