A parsed address refers to an address that has been broken down or separated into its individual components or elements. These components typically include details such as the street name, street number, city, state or region, postal code, and sometimes additional information like apartment or suite numbers. Parsing an address is the process of extracting and categorizing these elements from a raw or unstructured address string.
For example, consider the following raw address:
123 Main St, Apt 4B, New York, NY 10001
A parsed address of this raw address would break it down into its components like this:
Street Number: 123
Street Name: Main St
Apartment or Unit: Apt 4B
City: New York
State: NY (New York)
Postal Code: 10001
Parsing addresses is a common task in various applications, such as:
E-commerce: When customers enter shipping addresses during online purchases, the addresses need to be parsed to ensure accurate delivery.
Logistics and Delivery Services: Delivery companies use parsed addresses to efficiently route packages to their destinations.
Geographic Information Systems (GIS): GIS systems often use parsed addresses to map and locate addresses on a map.
Location-Based Services: Apps and services that provide location-based information or recommendations rely on parsed addresses to understand the user's location.
At Veryfi address parsing is controlled by the request parameter parsed_address, which breaks down vendor_address, bill_to_address, and ship_to_address into pieces. Simply add parsed_address to the body of your request and get the broken-down address with JSON.
Please refer to Veryfi API Docs for more details
Example:
"vendor":
{
"address": "3221 Vineland Rd, Kissimmee, FL 34746, United States",
}
"parsed_address":
{
"city": "Kissimmee",
"country": "United States",
"country_alpha_2": "US",
"house_number": "3221",
"postcode": "34746",
"road": "Vineland Rd",
"state": "FL",
"street_address": "3221 Vineland Rd"
}
What is expected:
We return a field when we find that field in the address.
101 Main Street, San Mateo, CA 94401
"street_address": 101 Main Street,
"city": San Mateo,
"state":CA ,
"postcode": 94401
Veryfi Inc, 101 Main Street, San Mateo, CA 94401
“house”: Veryfi Inc
"street_address": 101 Main Street,
"city": San Mateo,
"state":CA ,
"postcode": 94401
How to get your vendor_address, bill_to_address and ship_to_address broken down:
To receive parsed_address you need to add {"parse_address" : true } for v8 or {"parse_address" : 1/0 } for v7 into the API call:
Veryfi will return the following list of fields from this SDK
“house” - venue name e.g. “San Francisco Museum of Modern Art”, and building names e.g. “SalesForce tower”
“category” - “restaurants”, "supermarket, bakery, liquor_store, grocery_or_supermarket
“near” - phrases like “in”, “near”, etc. used after a category phrase to help with parsing queries like “bakery in San Franciso”
“house_number” - building number (street-facing). In some countries, this may be a compound hyphenated number which also includes an apartment number, or a block number (a la Japan) we return just “house_number” for simplicity. wiki
“street_address” - a combination of “house_number”, “road”, “building”, “unit” in case if each of these is not empty
“road” - street name(s)
“unit” - an apartment, unit, office, lot, or other secondary unit designators
“level” - a floor number e.g. “5t Floor”, “Ground Floor”, etc.
“staircase” - numbered/lettered staircase
“entrance” - numbered/lettered entrance
“po_box” - post office box: non-physical (mail-only)
“postcode” - postal code
“suburb” - an unofficial neighborhood name like “Richmond”, “China Town”, or “ The Castro”
“city_district” - these are usually boroughs or districts within a city that serve some official purpose e.g. “Brooklyn” or “Hackney” or “Bratislava IV”
“city” - cities, towns, villages, localities,
“island” - island e.g. “Maui”
“state_district” - usually a second-level administrative division or county
“state” a first-level administrative division. Scotland, Northern Ireland, Wales, and England in the UK are mapped to “state” as well (convention used in OSM, GeoPlanet, etc.)
“country_region” - informal subdivision of a country without any political status
“country” - anything with an ISO-3166 code.
“country_alpha_2” - anything with an ISO-3166 code on alpha 2 code.
“world_region” - currently only used for appending “West Indies” after the country name, a pattern frequently used in the English-speaking Caribbean e.g. “Jamaica, West Indies”
FAQ:
Q: Is there any specific (minimum) number of fields we return?
A: No, If the address is empty then we should expect an empty response for parsed_address.