REST only
This page documents the Parse Address operation. The endpoint, request parameters, response fields, examples, and status codes require confirmation for the Pro Web REST interface.
Use POST /address/parse/v1 method to identify components in an address.
| Name | Type | Description |
|---|---|---|
| Diagnostics (Optional) |
boolean | Enable diagnostic info The default value of this setting is False. |
| Name | Type | Description | |
|---|---|---|---|
| reference_id | string | Optional identifier that will be returned in the response to help you track the request (maximum 128 characters). | |
| input | string | The raw address string to parse. | |
| Name | Type | Description |
|---|---|---|
| Diagnostics (Optional) |
boolean | Enable diagnostic info The default value of this setting is False. |
| Name | Type | Description | |
|---|---|---|---|
| reference_id | string | Caller-supplied correlation ID from the request, echoed back for traceability. | |
| original_search | string | The original input address string as provided in the request. | |
| parsed_components | object | Labelled address components – present when parsing succeeded, null on failure. | |
| value | string | The component value as extracted from the input address. | |
| name | string | The address component name, e.g. 'building_number', 'street', 'town', 'region', 'postal_code', 'country_name', 'door', 'sub_district'. | |
The following response codes can be returned by the API:
| Status Code | Reason phrase | Description |
|---|---|---|
| 200 | Success | Request processed successfully. |
| 400 | Bad Request | Request failed due to malformed syntax. |
| 408 | Request timeout | Response was not returned within the timeout allowance. |
| 500 | Internal Server Error | The server has encountered an error. |
{
"input": {
"reference_id": "gbr-001",
"input": "10 Downing Street, Westminster, London, SW1A 2AA, United Kingdom"
}
}
{
"result": {
"reference_id": "gbr-001",
"original_search": "10 Downing Street, Westminster, London, SW1A 2AA, United Kingdom",
"parsed_components": [
{
"value": "10",
"name": "building_number"
},
{
"value": "downing street",
"name": "street"
},
{
"value": "westminster",
"name": "district"
},
{
"value": "london",
"name": "town"
},
{
"value": "sw1a 2aa",
"name": "postal_code"
},
{
"value": "united kingdom",
"name": "country_name"
}
]
}
}