Success funnel address answer
The JSON response is a dictionary (object) containing two main keys:
- "Found": an integer indicating the number of addresses found (e.g., 0 or 1),
- "Addresses": a list containing one or more address objects.
Each address object is itself a dictionary containing the following keys:
| Field | Meaning | Always in JSON? | Type / Format |
|---|---|---|---|
| PostalCode | Postal / ZIP code | Yes | STRING(10–20) |
| City | City / ward name | Yes | STRING(50) |
| Hamlet | Hamlet / dependent locality | Yes | STRING(50) (can be empty) |
| SpecialDistribution | Special distribution flag | Yes | STRING(1) (can be empty) |
| Country | ISO country code | Yes | STRING(3) |
| StateCode | State / prefecture code | Yes | STRING(10) |
| StateLabel | State / prefecture label | Yes | STRING(50) |
| AdministrativeArea | Administrative area (e.g. ward) | Yes | STRING(50) |
| SubLocality | Sub-locality information | Yes | STRING(50) (can be empty) |
| Suburb | Suburb / district | Yes | STRING(255) (can be empty) |
| CityId | Unique city identifier | Yes | STRING(20) |
| Input | User input value | Yes | STRING(50) |
| Label | Formatted display label | Yes | STRING(255) |
| Street | Street name | Yes | STRING(255) (can be empty) |
| StreetId | Street identifier | Yes | STRING(20) (can be empty) |
| StreetType | Street type | Yes | STRING(50) (can be empty) |
| StreetNumber | Street / house number | Yes | STRING(20) (can be empty) |
| StreetNumberOnly | Numeric part of street number | Yes | STRING(20) (can be empty) |
| StreetNumberList | List of valid street numbers | Yes | STRING(1024) (can be empty) |
| StreetNumberListCount | Number of items in StreetNumberList | Yes | INTEGER |
| IsValidStreetNumber | Indicates if street number is valid (1 = valid, 0 = invalid) | Yes | INTEGER |
| AdditionalAddress | Additional address line | Yes | STRING(255) (can be empty) |
| Company | Company name | Yes | STRING(255) (can be empty) |
| Latitude | Latitude | Yes | DECIMAL(18) (empty string possible) |
| Longitude | Longitude | Yes | DECIMAL(18) (empty string possible) |
Example:
{
"Found": 1,
"Addresses": [
{
"PostalCode": "108-6390",
"City": "ﾐﾅﾄｸ",
"Hamlet": "",
"SpecialDistribution": "",
"Country": "JPN",
"StateCode": "13",
"SubLocality": "",
"CityId": "402574",
"Input": "108-6390",
"Label": "〒108-6390 ﾄｳｷﾖｳﾄﾐﾅﾄｸﾐﾀ",
"AdditionalAddress": "",
"StreetNumber": "",
"StreetType": "",
"Street": "ﾐﾀ",
"StreetId": "558204",
"IsValidStreetNumber": 1,
"StreetNumberListCount": 0,
"StreetNumberList": "",
"StreetNumberOnly": "",
"StateLabel": "ﾄｳｷﾖｳﾄ",
"AdministrativeArea": "ﾐﾅﾄｸ",
"Suburb": "",
"Company": "",
"Latitude": "",
"Longitude": ""
}
]
}
Error
| Error type | Response type |
| Missing mandatory parameter | { "status": 400, "message": "Missing parameters", "details": "PostalCode", "error": "bad request" } |
| Country value is not ISO3 | {"status": 400, "message": "Country doesn't exist", "details": "JPNde", "error": "bad request"} |
| Wrong license value | {"status": 401, "message": "Your licence is not allowed to cover this functionnality", "details": "WRONG LICENSE", "error": "unauthorized_client"} |
Related to