Verify a US or US territory address with a live API key.
POST {{baseUrl}}/us_verifications?case=upper
Verify a US or US territory address with a live API key. The address can be in components (e.g. primary_line is 185 Berry Street
, zip_code is 94107
) or as a single string (e.g. 185 Berry Street 94107
), but not as both. Requests using a test API key validate required fields but return empty values unless specific primary_line values are provided.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
case | string | (optional) Casing of the verified address. Possible values are upper and proper for uppercased (e.g. "PO BOX") and proper-cased (e.g. "PO Box"), respectively. Only affects recipient, primary_line, secondary_line, urbanization, and last_line. Default casing is upper. |
Request Body
[{"name"=>"recipient", "value"=>"", "datatype"=>"null"}, {"name"=>"address", "value"=>"", "datatype"=>"null"}, {"name"=>"primary_line", "value"=>"210 King St", "datatype"=>"string"}, {"name"=>"secondary_line", "value"=>"", "datatype"=>"null"}, {"name"=>"urbanization", "value"=>"", "datatype"=>"null"}, {"name"=>"city", "value"=>"", "datatype"=>"null"}, {"name"=>"state", "value"=>"", "datatype"=>"null"}, {"name"=>"zip_code", "value"=>"94107", "datatype"=>"number"}]
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"id":"us_ver_c7cb63d68f8d6","recipient":"LOB.COM","primary_line":"185 BERRY ST STE 6100","secondary_line":"","urbanization":"","last_line":"SAN FRANCISCO CA 94107-1728","deliverability":"deliverable","components":{"primary_number":"185","street_predirection":"","street_name":"BERRY","street_suffix":"ST","street_postdirection":"","secondary_designator":"STE","secondary_number":"6100","pmb_designator":"","pmb_number":"","extra_secondary_designator":"","extra_secondary_number":"","city":"SAN FRANCISCO","state":"CA","zip_code":"94107","zip_code_plus_4":"1728","zip_code_type":"standard","delivery_point_barcode":"941071728506","address_type":"commercial","record_type":"highrise","default_building_address":false,"county":"SAN FRANCISCO","county_fips":"06075","carrier_route":"C001","carrier_route_type":"city_delivery","latitude":37.77597542841264,"longitude":-122.3929557343685},"deliverability_analysis":{"dpv_confirmation":"Y","dpv_cmra":"N","dpv_vacant":"N","dpv_active":"Y","dpv_footnotes":["AA","BB"],"ews_match":false,"lacs_indicator":"","lacs_return_code":"","suite_return_code":""},"lob_confidence_score":{"score":100,"level":"high"},"object":"us_verification"}