Global address validation API
address.addressLines, with one or more strings representing its lines; Provero does not add or forward separate locality, region, postcode, recipient, or organisation hints. The default standard response contains cleansed fields in address, a match verdict, and a short qualification. Set output_format to detailed to receive the cleansed fields at the top level plus the complete validation result.Request constraints: At least one
address.addressLines entry is required, and the total address input must not exceed 280 characters.For Royal Mail PAF validation or postcode-only lookup, use the dedicated UK address validation (PAF) or UK address lookup endpoint.
Looking for address suggestions? Use the Global address lookup API.
Endpoint
https://api.provero.io/api/validate/address
Headers
Authorization:
Content-Type: application/json
Accept: application/json
Request Body
Request Payload Example (JSON)
{
"address": {
"addressLines": [
"1600 Pennsylvania Avenue NW",
"Washington, DC 20500, USA"
]
},
"output_format": "standard"
}
Request Examples
Choose language Bash (cURL) 5 examples
curl -X POST https://api.provero.io/api/validate/address \
-H "Authorization: Bearer REPLACE_WITH_API_TOKEN" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{
"address": {
"addressLines": ["1600 Pennsylvania Avenue NW", "Washington, DC 20500, USA"]
},
"output_format": "standard"
}'
import requests
response = requests.post(
"https://api.provero.io/api/validate/address",
headers={
"Authorization": "Bearer REPLACE_WITH_API_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json",
},
json={
"address": {
"addressLines": ["1600 Pennsylvania Avenue NW", "Washington, DC 20500, USA"],
},
"output_format": "standard",
},
)
print(response.status_code)
print(response.json())
<?php
$payload = array (
'address' =>
array (
'addressLines' =>
array (
0 => '1600 Pennsylvania Avenue NW',
1 => 'Washington, DC 20500, USA',
),
),
'output_format' => 'standard',
);
$curl = curl_init('https://api.provero.io/api/validate/address');
curl_setopt_array($curl, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_HTTPHEADER => [
'Authorization: Bearer REPLACE_WITH_API_TOKEN',
'Content-Type: application/json',
'Accept: application/json',
],
]);
echo curl_exec($curl);
curl_close($curl);
$response = Http::withToken('REPLACE_WITH_API_TOKEN')
->acceptJson()
->post('https://api.provero.io/api/validate/address', [
'address' => [
'addressLines' => ['1600 Pennsylvania Avenue NW', 'Washington, DC 20500, USA'],
],
'output_format' => 'standard',
]);
return $response->json();
const response = await fetch("https://api.provero.io/api/validate/address", {
method: "POST",
headers: {
"Authorization": "Bearer REPLACE_WITH_API_TOKEN",
"Content-Type": "application/json",
"Accept": "application/json"
},
body: JSON.stringify({
address: {
addressLines: ["1600 Pennsylvania Avenue NW", "Washington, DC 20500, USA"]
},
output_format: "standard"
})
});
const data = await response.json();
Response Examples
Choose response example Standard Success (default) 5 examples
{
"address": {
"address_line_1": "1600 Pennsylvania Avenue NW",
"address_line_2": "",
"address_line_3": "",
"locality": "Washington",
"sublocality": "",
"administrative_area": "DC",
"postal_code": "20500",
"sorting_code": "",
"country_code": "US",
"language_code": "",
"formatted_address": "1600 Pennsylvania Avenue NW, Washington, DC 20500, USA"
},
"verdict": "Exact match",
"qualification": "Address confirmed as entered."
}
{
"address_line_1": "1600 Pennsylvania Avenue NW",
"address_line_2": "",
"address_line_3": "",
"locality": "Washington",
"sublocality": "",
"administrative_area": "DC",
"postal_code": "20500",
"sorting_code": "",
"country_code": "US",
"language_code": "",
"formatted_address": "1600 Pennsylvania Avenue NW, Washington, DC 20500, USA",
"result": {
"verdict": {
"inputGranularity": "PREMISE",
"validationGranularity": "PREMISE",
"geocodeGranularity": "PREMISE",
"addressComplete": true,
"hasUnconfirmedComponents": false,
"possibleNextAction": "ACCEPT"
},
"address": {
"formattedAddress": "1600 Pennsylvania Avenue NW, Washington, DC 20500, USA",
"postalAddress": {
"regionCode": "US",
"postalCode": "20500",
"administrativeArea": "DC",
"locality": "Washington",
"addressLines": [
"1600 Pennsylvania Avenue NW"
]
},
"addressComponents": [
{
"componentName": {
"text": "1600"
},
"componentType": "street_number",
"confirmationLevel": "CONFIRMED"
}
]
},
"geocode": {
"location": {
"latitude": 38.8977,
"longitude": -77.0365
}
},
"metadata": {
"business": false,
"poBox": false,
"residential": false
}
},
"responseId": "example-response-id"
}
{
"message": "The address field is required.",
"errors": {
"address": [
"The address field is required."
]
}
}
{
"message": "Insufficient balance for validation request.",
"service": "address",
"required_amount": "0.0460000000",
"current_balance": "0.0000000000"
}
{
"requestError": {
"serviceException": {
"messageId": "Address validation request failed.",
"code": 502
}
}
}
Standard match verdicts
The standard response returns one of these verdicts with a short qualification. The qualification names the main issue when a more specific reason is available; the sentences below are the defaults.
| Verdict | Meaning | Default qualification |
|---|---|---|
| Exact match | Complete address was confirmed as entered, including a supplied flat number if applicable. | Address confirmed as entered. |
| Strong match | Complete address was confirmed with only minor corrections or supporting details added. | Address confirmed with minor corrections or additions. |
| Partial match | Building was confirmed, but a flat number or another identifying detail needs confirmation. | Building confirmed, but some address details need confirmation. |
| Weak match | Street or approximate building confirmed; key details are uncertain or changed. | Only part of the address could be confirmed. |
| Unverified | Address could not be confirmed to a useful street or building level. | The address could not be confirmed. |
Exact match
Meaning
Complete address was confirmed as entered, including a supplied flat number if applicable.
Default qualification
Address confirmed as entered.
Strong match
Meaning
Complete address was confirmed with only minor corrections or supporting details added.
Default qualification
Address confirmed with minor corrections or additions.
Partial match
Meaning
Building was confirmed, but a flat number or another identifying detail needs confirmation.
Default qualification
Building confirmed, but some address details need confirmation.
Weak match
Meaning
Street or approximate building confirmed; key details are uncertain or changed.
Default qualification
Only part of the address could be confirmed.
Unverified
Meaning
Address could not be confirmed to a useful street or building level.
Default qualification
The address could not be confirmed.
For example, the qualification may say “Building confirmed, but the flat number could not be confirmed” or “Address confirmed after correcting the postcode.” API errors and unsupported regions remain errors, not match verdicts.
Response Body
Success structure
No matching fields in this output format. Try the other format or clear your search.
Standard output
Standard output contains a cleansed address and a match verdict with a short qualification.
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
address |
object |
No | |
Cleansed address object in standard output. Every cleansed field is included; unavailable values are empty strings. |
verdict |
string |
No | Exact match |
Match verdict in standard output: Exact match, Strong match, Partial match, Weak match, or Unverified. Unavailable for missing legacy data. |
qualification |
string |
No | Address confirmed as entered. |
Short explanation of the main reason for the match verdict. |
address
object
Description
- Always Returned
- No
- Example
{ "postal_code": "20500", "country_code": "US" }
verdict
string
Description
- Always Returned
- No
- Example
Exact match
qualification
string
Description
- Always Returned
- No
- Example
Address confirmed as entered.
AddressUse cleansed address fields or inspect the structured address details. 11 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
address.address_line_1 |
string |
Yes | 1600 Pennsylvania Avenue NW |
First cleansed address line. |
address.address_line_2 |
string |
Yes | |
Second cleansed address line, or an empty string. |
address.address_line_3 |
string |
Yes | |
Third cleansed address line, or an empty string. |
address.locality |
string |
Yes | Washington |
Cleansed city or town. |
address.sublocality |
string |
Yes | |
Cleansed neighbourhood, borough, or district. |
address.administrative_area |
string |
Yes | DC |
Cleansed postal administrative area when available; otherwise the level 2 administrative component (for example, a UK county) when returned. |
address.postal_code |
string |
Yes | 20500 |
Cleansed postal or ZIP code. |
address.sorting_code |
string |
Yes | |
Cleansed country-specific sorting code. |
address.country_code |
string |
Yes | US |
Cleansed ISO-2 country or region code. |
address.language_code |
string |
Yes | |
Language code returned with the cleansed postal address. |
address.formatted_address |
string |
Yes | 1600 Pennsylvania Avenue NW, Washington, DC 20500, USA |
Complete cleansed and formatted address. |
address.address_line_1
string
Description
- Always Returned
- Yes
- Example
1600 Pennsylvania Avenue NW
address.address_line_2
string
Description
- Always Returned
- Yes
- Example
""Empty string
address.address_line_3
string
Description
- Always Returned
- Yes
- Example
""Empty string
address.locality
string
Description
- Always Returned
- Yes
- Example
Washington
address.sublocality
string
Description
- Always Returned
- Yes
- Example
""Empty string
address.administrative_area
string
Description
- Always Returned
- Yes
- Example
DC
address.postal_code
string
Description
- Always Returned
- Yes
- Example
20500
address.sorting_code
string
Description
- Always Returned
- Yes
- Example
""Empty string
address.country_code
string
Description
- Always Returned
- Yes
- Example
US
address.language_code
string
Description
- Always Returned
- Yes
- Example
""Empty string
address.formatted_address
string
Description
- Always Returned
- Yes
- Example
1600 Pennsylvania Avenue NW, Washington, DC 20500, USA
Detailed output
Set output_format to detailed for top-level cleansed fields, the complete result and responseId.
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
address_line_1 |
string |
Yes | 1600 Pennsylvania Avenue NW |
First cleansed address line. |
address_line_2 |
string |
Yes | |
Second cleansed address line, or an empty string. |
address_line_3 |
string |
Yes | |
Third cleansed address line, or an empty string. |
locality |
string |
Yes | Washington |
Cleansed city or town. |
sublocality |
string |
Yes | |
Cleansed neighbourhood, borough, or district. |
administrative_area |
string |
Yes | DC |
Cleansed postal administrative area when available; otherwise the level 2 administrative component (for example, a UK county) when returned. |
postal_code |
string |
Yes | 20500 |
Cleansed postal or ZIP code. |
sorting_code |
string |
Yes | |
Cleansed country-specific sorting code. |
country_code |
string |
Yes | US |
Cleansed ISO-2 country or region code. |
language_code |
string |
Yes | |
Language code returned with the cleansed postal address. |
formatted_address |
string |
Yes | 1600 Pennsylvania Avenue NW, Washington, DC 20500, USA |
Complete cleansed and formatted address. |
result |
object |
No | |
Complete validation result in detailed output. Includes the verdict and optional address, geocode, metadata and USPS data. |
responseId |
string |
No | example-response-id |
Provider response identifier. |
address_line_1
string
Description
- Always Returned
- Yes
- Example
1600 Pennsylvania Avenue NW
address_line_2
string
Description
- Always Returned
- Yes
- Example
""Empty string
address_line_3
string
Description
- Always Returned
- Yes
- Example
""Empty string
locality
string
Description
- Always Returned
- Yes
- Example
Washington
sublocality
string
Description
- Always Returned
- Yes
- Example
""Empty string
administrative_area
string
Description
- Always Returned
- Yes
- Example
DC
postal_code
string
Description
- Always Returned
- Yes
- Example
20500
sorting_code
string
Description
- Always Returned
- Yes
- Example
""Empty string
country_code
string
Description
- Always Returned
- Yes
- Example
US
language_code
string
Description
- Always Returned
- Yes
- Example
""Empty string
formatted_address
string
Description
- Always Returned
- Yes
- Example
1600 Pennsylvania Avenue NW, Washington, DC 20500, USA
result
object
Description
- Always Returned
- No
- Example
{ "verdict": {}, "address": {} }
responseId
string
Description
- Always Returned
- No
- Example
example-response-id
VerdictReview validation quality and suggested next steps. 10 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.verdict |
object |
No | |
Validation verdict and component-quality flags in detailed output. possibleNextAction is a Preview field, can be omitted, and is not a deliverability guarantee. An omitted addressComplete value means false. |
result.verdict.validationGranularity |
string |
No | PREMISE |
Finest address level confirmed by validation. Values: GRANULARITY_UNSPECIFIED, SUB_PREMISE, PREMISE, PREMISE_PROXIMITY, BLOCK, ROUTE or OTHER. |
result.verdict.hasUnconfirmedComponents |
boolean |
No | false |
Whether any component remains unverified. |
result.verdict.possibleNextAction |
string |
No | ACCEPT |
Preview guidance: FIX, CONFIRM_ADD_SUBPREMISES, CONFIRM or ACCEPT; POSSIBLE_NEXT_ACTION_UNSPECIFIED is unused. Not a deliverability guarantee. |
result.verdict.hasSpellCorrectedComponents |
boolean |
No | false |
Whether component spelling was corrected. |
result.verdict.addressComplete |
boolean |
No | false |
True when required components are complete and no unresolved or unexpected components remain. Omitted means false. |
result.verdict.inputGranularity |
string |
No | PREMISE |
Precision of the submitted address, before validation. Values: GRANULARITY_UNSPECIFIED, SUB_PREMISE, PREMISE, PREMISE_PROXIMITY, BLOCK, ROUTE or OTHER. |
result.verdict.hasInferredComponents |
boolean |
No | false |
Whether missing components were added. |
result.verdict.geocodeGranularity |
string |
No | PREMISE |
Precision of the returned location; can differ from validation precision. Values: GRANULARITY_UNSPECIFIED, SUB_PREMISE, PREMISE, PREMISE_PROXIMITY, BLOCK, ROUTE or OTHER. |
result.verdict.hasReplacedComponents |
boolean |
No | false |
Whether incorrect components were substituted. |
result.verdict
object
Description
- Always Returned
- No
- Example
{ "addressComplete": true, "possibleNextAction": "ACCEPT" }
result.verdict.validationGranularity
string
Description
- Always Returned
- No
- Example
PREMISE
result.verdict.hasUnconfirmedComponents
boolean
Description
- Always Returned
- No
- Example
false
result.verdict.possibleNextAction
string
Description
- Always Returned
- No
- Example
ACCEPT
result.verdict.hasSpellCorrectedComponents
boolean
Description
- Always Returned
- No
- Example
false
result.verdict.addressComplete
boolean
Description
- Always Returned
- No
- Example
false
result.verdict.inputGranularity
string
Description
- Always Returned
- No
- Example
PREMISE
result.verdict.hasInferredComponents
boolean
Description
- Always Returned
- No
- Example
false
result.verdict.geocodeGranularity
string
Description
- Always Returned
- No
- Example
PREMISE
result.verdict.hasReplacedComponents
boolean
Description
- Always Returned
- No
- Example
false
Address detailsUse cleansed address fields or inspect the structured address details. 25 fields
Overview 2 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.address |
object |
No | |
Formatted address, postal address, component confirmations, and unresolved/missing component lists. Individual fields vary with the result. |
result.address.formattedAddress |
string |
No | 1600 Pennsylvania Avenue NW, Washington, DC 20500, USA |
Cleansed address in display order. |
result.address
object
Description
- Always Returned
- No
- Example
{ "formattedAddress": "1600 Pennsylvania Avenue NW, Washington, DC 20500, USA" }
result.address.formattedAddress
string
Description
- Always Returned
- No
- Example
1600 Pennsylvania Avenue NW, Washington, DC 20500, USA
Postal address 10 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.address.postalAddress |
object |
No | |
Structured postal fields. |
result.address.postalAddress.sortingCode |
string |
No | |
Additional postal sorting information. |
result.address.postalAddress.addressLines |
string[] |
No | |
Ordered postal address lines. |
result.address.postalAddress.administrativeArea |
string |
No | DC |
Postal state, province or equivalent. |
result.address.postalAddress.languageCode |
string |
No | en |
Language tag, when available. |
result.address.postalAddress.regionCode |
string |
No | US |
Two-letter region code. |
result.address.postalAddress.sublocality |
string |
No | |
District or neighbourhood. |
result.address.postalAddress.locality |
string |
No | Washington |
Postal town or city. |
result.address.postalAddress.postalCode |
string |
No | 20500 |
Postal or ZIP code. |
result.address.postalAddress.revision |
integer |
No | 0 |
Postal schema revision; currently zero. |
result.address.postalAddress
object
Description
- Always Returned
- No
- Example
{}
result.address.postalAddress.sortingCode
string
Description
- Always Returned
- No
- Example
""Empty string
result.address.postalAddress.addressLines
string[]
Description
- Always Returned
- No
- Example
[ "1600 Pennsylvania Avenue NW" ]
result.address.postalAddress.administrativeArea
string
Description
- Always Returned
- No
- Example
DC
result.address.postalAddress.languageCode
string
Description
- Always Returned
- No
- Example
en
result.address.postalAddress.regionCode
string
Description
- Always Returned
- No
- Example
US
result.address.postalAddress.sublocality
string
Description
- Always Returned
- No
- Example
""Empty string
result.address.postalAddress.locality
string
Description
- Always Returned
- No
- Example
Washington
result.address.postalAddress.postalCode
string
Description
- Always Returned
- No
- Example
20500
result.address.postalAddress.revision
integer
Description
- Always Returned
- No
- Example
0
Address components 10 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.address.addressComponents |
object[] |
No | |
Component objects in no guaranteed order; do not rely on array positions. |
result.address.addressComponents[].replaced |
boolean |
No | false |
Component replaced rather than cosmetically corrected. |
result.address.addressComponents[].spellCorrected |
boolean |
No | false |
Component spelling changed. |
result.address.addressComponents[].inferred |
boolean |
No | false |
Component added from address context. |
result.address.addressComponents[].componentType |
string |
No | street_number |
Address component category, such as street_number or route. |
result.address.addressComponents[].confirmationLevel |
string |
No | CONFIRMED |
CONFIRMED, UNCONFIRMED_BUT_PLAUSIBLE or UNCONFIRMED_AND_SUSPICIOUS; CONFIRMATION_LEVEL_UNSPECIFIED is unused. |
result.address.addressComponents[].unexpected |
boolean |
No | false |
Component retained from input despite being unexpected for this address. |
result.address.addressComponents[].componentName |
object |
No | |
Component text and optional language. |
result.address.addressComponents[].componentName.text |
string |
No | 1600 |
Component value. |
result.address.addressComponents[].componentName.languageCode |
string |
No | en |
Language tag, when available. |
result.address.addressComponents
object[]
Description
- Always Returned
- No
- Example
[ { "componentType": "street_number" } ]
result.address.addressComponents[].replaced
boolean
Description
- Always Returned
- No
- Example
false
result.address.addressComponents[].spellCorrected
boolean
Description
- Always Returned
- No
- Example
false
result.address.addressComponents[].inferred
boolean
Description
- Always Returned
- No
- Example
false
result.address.addressComponents[].componentType
string
Description
- Always Returned
- No
- Example
street_number
result.address.addressComponents[].confirmationLevel
string
Description
- Always Returned
- No
- Example
CONFIRMED
result.address.addressComponents[].unexpected
boolean
Description
- Always Returned
- No
- Example
false
result.address.addressComponents[].componentName
object
Description
- Always Returned
- No
- Example
{}
result.address.addressComponents[].componentName.text
string
Description
- Always Returned
- No
- Example
1600
result.address.addressComponents[].componentName.languageCode
string
Description
- Always Returned
- No
- Example
en
Missing and unresolved fields 3 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.address.unconfirmedComponentTypes |
string[] |
No | |
Component types requiring confirmation. |
result.address.unresolvedTokens |
string[] |
No | |
Input fragments that could not be interpreted. |
result.address.missingComponentTypes |
string[] |
No | |
Required component types that could not be supplied or inferred. |
result.address.unconfirmedComponentTypes
string[]
Description
- Always Returned
- No
- Example
[ "street_number" ]
result.address.unresolvedTokens
string[]
Description
- Always Returned
- No
- Example
[ "unknown" ]
result.address.missingComponentTypes
string[]
Description
- Always Returned
- No
- Example
[ "subpremise" ]
GeocodeFind the matched location, bounds and location codes. 17 fields
Overview 4 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.geocode |
object |
No | |
Geocode, place ID, bounds, feature size, and location types when available. |
result.geocode.featureSizeMeters |
number |
No | 20 |
Approximate size of the matched feature in metres. |
result.geocode.placeTypes |
string[] |
No | |
Categories of the matched place. |
result.geocode.placeId |
string |
No | example-place-id |
Matched place identifier. |
result.geocode
object
Description
- Always Returned
- No
- Example
{ "location": { "latitude": 38.8977, "longitude": -77.0365 } }
result.geocode.featureSizeMeters
number
Description
- Always Returned
- No
- Example
20
result.geocode.placeTypes
string[]
Description
- Always Returned
- No
- Example
[ "street_address" ]
result.geocode.placeId
string
Description
- Always Returned
- No
- Example
example-place-id
Location 3 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.geocode.location |
object |
No | |
Latitude and longitude of the match. |
result.geocode.location.longitude |
number |
No | -77.0365 |
Longitude in degrees, from -180 to 180. |
result.geocode.location.latitude |
number |
No | 38.8977 |
Latitude in degrees, from -90 to 90. |
result.geocode.location
object
Description
- Always Returned
- No
- Example
{}
result.geocode.location.longitude
number
Description
- Always Returned
- No
- Example
-77.0365
result.geocode.location.latitude
number
Description
- Always Returned
- No
- Example
38.8977
Bounds 7 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.geocode.bounds |
object |
No | |
Geographic bounds of the match. |
result.geocode.bounds.high |
object |
No | |
Upper bounds point; longitude may cross the antimeridian. |
result.geocode.bounds.low |
object |
No | |
Lower bounds point; longitude may cross the antimeridian. |
result.geocode.bounds.low.longitude |
number |
No | -77.0365 |
Longitude in degrees, from -180 to 180. |
result.geocode.bounds.low.latitude |
number |
No | 38.8977 |
Latitude in degrees, from -90 to 90. |
result.geocode.bounds.high.longitude |
number |
No | -77.0365 |
Longitude in degrees, from -180 to 180. |
result.geocode.bounds.high.latitude |
number |
No | 38.8977 |
Latitude in degrees, from -90 to 90. |
result.geocode.bounds
object
Description
- Always Returned
- No
- Example
{}
result.geocode.bounds.high
object
Description
- Always Returned
- No
- Example
{}
result.geocode.bounds.low
object
Description
- Always Returned
- No
- Example
{}
result.geocode.bounds.low.longitude
number
Description
- Always Returned
- No
- Example
-77.0365
result.geocode.bounds.low.latitude
number
Description
- Always Returned
- No
- Example
38.8977
result.geocode.bounds.high.longitude
number
Description
- Always Returned
- No
- Example
-77.0365
result.geocode.bounds.high.latitude
number
Description
- Always Returned
- No
- Example
38.8977
Plus codes 3 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.geocode.plusCode |
object |
No | |
Location codes, when available. |
result.geocode.plusCode.globalCode |
string |
No | 87C4V4W2+J4 |
Complete location code. |
result.geocode.plusCode.compoundCode |
string |
No | V4W2+J4 Washington, DC |
Short location code with locality context. |
result.geocode.plusCode
object
Description
- Always Returned
- No
- Example
{}
result.geocode.plusCode.globalCode
string
Description
- Always Returned
- No
- Example
87C4V4W2+J4
result.geocode.plusCode.compoundCode
string
Description
- Always Returned
- No
- Example
V4W2+J4 Washington, DC
MetadataUnderstand the address kind; missing flags mean unknown. 4 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.metadata |
object |
No | |
Address metadata. Omitted flags mean unknown, rather than false. |
result.metadata.business |
boolean |
No | false |
Whether this is a business address. Omitted means unknown, not false. |
result.metadata.poBox |
boolean |
No | false |
Whether this is a PO box. Omitted means unknown, not false. |
result.metadata.residential |
boolean |
No | false |
Whether this is residential. Omitted means unknown, not false. |
result.metadata
object
Description
- Always Returned
- No
- Example
{ "business": false, "poBox": false, "residential": false }
result.metadata.business
boolean
Description
- Always Returned
- No
- Example
false
result.metadata.poBox
boolean
Description
- Always Returned
- No
- Example
false
result.metadata.residential
boolean
Description
- Always Returned
- No
- Example
false
USPS dataInspect US postal data and delivery indicators when available. 47 fields
Delivery indicators 37 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.uspsData |
object |
No | |
USPS data for US and Puerto Rican addresses, when available. Individual fields are not guaranteed. Provero does not request CASS processing. |
result.uspsData.elotFlag |
string |
No | |
Delivery sequence direction, A or D. |
result.uspsData.dpvThrowback |
string |
No | |
Delivery to a PO box instead of the street address. |
result.uspsData.dpvVacant |
string |
No | |
Vacancy indicator. |
result.uspsData.dpvPbsa |
string |
No | |
PO box street-addressing indicator. |
result.uspsData.dpvNoStat |
string |
No | |
Non-delivery/no-stat indicator. |
result.uspsData.suitelinkFootnote |
string |
No | |
Suite matching result code. |
result.uspsData.lacsLinkIndicator |
string |
No | |
Address conversion match indicator. |
result.uspsData.deliveryPointCode |
string |
No | 00 |
Two-digit delivery point code. |
result.uspsData.fipsCountyCode |
string |
No | |
County FIPS identifier. |
result.uspsData.carrierRouteIndicator |
string |
No | D |
Carrier route sorting category. |
result.uspsData.cassProcessed |
boolean |
No | false |
Whether CASS processing occurred; Provero does not request CASS mode. |
result.uspsData.dpvDrop |
string |
No | |
Shared delivery point indicator. |
result.uspsData.dpvNonDeliveryDays |
string |
No | |
Indicator for restricted delivery days. |
result.uspsData.dpvConfirmation |
string |
No | Y |
Y: primary/secondary confirmed; D: secondary missing; S: secondary unconfirmed; N: unconfirmed. Omitted means no DPV confirmation result. |
result.uspsData.postOfficeState |
string |
No | DC |
Serving post office state. |
result.uspsData.errorMessage |
string |
No | |
USPS processing message; other USPS fields may be absent. |
result.uspsData.ewsNoMatch |
boolean |
No | false |
Address awaiting an exact match in postal updates. |
result.uspsData.dpvFootnote |
string |
No | AABB |
Combined delivery-point validation codes. |
result.uspsData.abbreviatedCity |
string |
No | |
Postal city abbreviation. |
result.uspsData.postOfficeCity |
string |
No | WASHINGTON |
Serving post office city. |
result.uspsData.pmbNumber |
string |
No | |
Private mailbox number. |
result.uspsData.carrierRoute |
string |
No | C001 |
Carrier route identifier. |
result.uspsData.dpvCmra |
string |
No | |
Commercial mail receiving agency indicator. |
result.uspsData.lacsLinkReturnCode |
string |
No | |
Address conversion result code. |
result.uspsData.dpvNoStatReasonCode |
integer |
No | 1 |
Numeric reason for no-stat status. |
result.uspsData.defaultAddress |
boolean |
No | false |
Whether the match is a default address with more specific alternatives. |
result.uspsData.county |
string |
No | |
County name. |
result.uspsData.dpvDoorNotAccessible |
string |
No | |
Door accessibility indicator. |
result.uspsData.deliveryPointCheckDigit |
string |
No | 0 |
Delivery barcode check digit. |
result.uspsData.dpvEnhancedDeliveryCode |
string |
No | |
Enhanced delivery confirmation code. |
result.uspsData.addressRecordType |
string |
No | |
Postal record category: F, G, H, P, R or S. |
result.uspsData.elotNumber |
string |
No | |
Delivery sequence identifier. |
result.uspsData.pmbDesignator |
string |
No | |
Private mailbox designation. |
result.uspsData.dpvNonDeliveryDaysValues |
integer |
No | 65 |
Bitmask of non-delivery days: Sunday 1 through Saturday 64. |
result.uspsData.dpvNoSecureLocation |
string |
No | |
Indicator for no secure delivery location. |
result.uspsData.poBoxOnlyPostalCode |
boolean |
No | false |
Whether the postal code supports PO boxes only. |
result.uspsData
object
Description
- Always Returned
- No
- Example
{}
result.uspsData.elotFlag
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.dpvThrowback
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.dpvVacant
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.dpvPbsa
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.dpvNoStat
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.suitelinkFootnote
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.lacsLinkIndicator
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.deliveryPointCode
string
Description
- Always Returned
- No
- Example
00
result.uspsData.fipsCountyCode
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.carrierRouteIndicator
string
Description
- Always Returned
- No
- Example
D
result.uspsData.cassProcessed
boolean
Description
- Always Returned
- No
- Example
false
result.uspsData.dpvDrop
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.dpvNonDeliveryDays
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.dpvConfirmation
string
Description
- Always Returned
- No
- Example
Y
result.uspsData.postOfficeState
string
Description
- Always Returned
- No
- Example
DC
result.uspsData.errorMessage
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.ewsNoMatch
boolean
Description
- Always Returned
- No
- Example
false
result.uspsData.dpvFootnote
string
Description
- Always Returned
- No
- Example
AABB
result.uspsData.abbreviatedCity
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.postOfficeCity
string
Description
- Always Returned
- No
- Example
WASHINGTON
result.uspsData.pmbNumber
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.carrierRoute
string
Description
- Always Returned
- No
- Example
C001
result.uspsData.dpvCmra
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.lacsLinkReturnCode
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.dpvNoStatReasonCode
integer
Description
- Always Returned
- No
- Example
1
result.uspsData.defaultAddress
boolean
Description
- Always Returned
- No
- Example
false
result.uspsData.county
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.dpvDoorNotAccessible
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.deliveryPointCheckDigit
string
Description
- Always Returned
- No
- Example
0
result.uspsData.dpvEnhancedDeliveryCode
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.addressRecordType
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.elotNumber
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.pmbDesignator
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.dpvNonDeliveryDaysValues
integer
Description
- Always Returned
- No
- Example
65
result.uspsData.dpvNoSecureLocation
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.poBoxOnlyPostalCode
boolean
Description
- Always Returned
- No
- Example
false
Standardized postal address 10 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.uspsData.standardizedAddress |
object |
No | |
USPS postal address fields. |
result.uspsData.standardizedAddress.firstAddressLine |
string |
No | 1600 PENNSYLVANIA AVE NW |
Primary postal address line. |
result.uspsData.standardizedAddress.zipCodeExtension |
string |
No | 0001 |
Four-digit ZIP extension. |
result.uspsData.standardizedAddress.firm |
string |
No | |
USPS firm name, when supplied. |
result.uspsData.standardizedAddress.secondAddressLine |
string |
No | |
Secondary postal address line. |
result.uspsData.standardizedAddress.urbanization |
string |
No | |
Puerto Rican urbanization name. |
result.uspsData.standardizedAddress.cityStateZipAddressLine |
string |
No | WASHINGTON DC 20500 |
Combined city, state and ZIP line. |
result.uspsData.standardizedAddress.city |
string |
No | WASHINGTON |
Postal city. |
result.uspsData.standardizedAddress.zipCode |
string |
No | 20500 |
Five-digit ZIP code. |
result.uspsData.standardizedAddress.state |
string |
No | DC |
Two-letter state code. |
result.uspsData.standardizedAddress
object
Description
- Always Returned
- No
- Example
{}
result.uspsData.standardizedAddress.firstAddressLine
string
Description
- Always Returned
- No
- Example
1600 PENNSYLVANIA AVE NW
result.uspsData.standardizedAddress.zipCodeExtension
string
Description
- Always Returned
- No
- Example
0001
result.uspsData.standardizedAddress.firm
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.standardizedAddress.secondAddressLine
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.standardizedAddress.urbanization
string
Description
- Always Returned
- No
- Example
""Empty string
result.uspsData.standardizedAddress.cityStateZipAddressLine
string
Description
- Always Returned
- No
- Example
WASHINGTON DC 20500
result.uspsData.standardizedAddress.city
string
Description
- Always Returned
- No
- Example
WASHINGTON
result.uspsData.standardizedAddress.zipCode
string
Description
- Always Returned
- No
- Example
20500
result.uspsData.standardizedAddress.state
string
Description
- Always Returned
- No
- Example
DC
English/Latin addressInspect optional English/Latin-script output for display. 23 fields
Overview 2 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.englishLatinAddress |
object |
No | |
Preview English/Latin-script address, preserved if supplied. Provero does not currently request this optional output. For display only; do not reuse it as validation input. Component confirmation levels and unconfirmed component types are not populated in this object. |
result.englishLatinAddress.formattedAddress |
string |
No | 1600 Pennsylvania Avenue NW, Washington, DC 20500, USA |
Cleansed address in display order. |
result.englishLatinAddress
object
Description
- Always Returned
- No
- Example
{}
result.englishLatinAddress.formattedAddress
string
Description
- Always Returned
- No
- Example
1600 Pennsylvania Avenue NW, Washington, DC 20500, USA
Postal address 10 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.englishLatinAddress.postalAddress |
object |
No | |
Structured postal fields. |
result.englishLatinAddress.postalAddress.sortingCode |
string |
No | |
Additional postal sorting information. |
result.englishLatinAddress.postalAddress.addressLines |
string[] |
No | |
Ordered postal address lines. |
result.englishLatinAddress.postalAddress.administrativeArea |
string |
No | DC |
Postal state, province or equivalent. |
result.englishLatinAddress.postalAddress.languageCode |
string |
No | en |
Language tag, when available. |
result.englishLatinAddress.postalAddress.regionCode |
string |
No | US |
Two-letter region code. |
result.englishLatinAddress.postalAddress.sublocality |
string |
No | |
District or neighbourhood. |
result.englishLatinAddress.postalAddress.locality |
string |
No | Washington |
Postal town or city. |
result.englishLatinAddress.postalAddress.postalCode |
string |
No | 20500 |
Postal or ZIP code. |
result.englishLatinAddress.postalAddress.revision |
integer |
No | 0 |
Postal schema revision; currently zero. |
result.englishLatinAddress.postalAddress
object
Description
- Always Returned
- No
- Example
{}
result.englishLatinAddress.postalAddress.sortingCode
string
Description
- Always Returned
- No
- Example
""Empty string
result.englishLatinAddress.postalAddress.addressLines
string[]
Description
- Always Returned
- No
- Example
[ "1600 Pennsylvania Avenue NW" ]
result.englishLatinAddress.postalAddress.administrativeArea
string
Description
- Always Returned
- No
- Example
DC
result.englishLatinAddress.postalAddress.languageCode
string
Description
- Always Returned
- No
- Example
en
result.englishLatinAddress.postalAddress.regionCode
string
Description
- Always Returned
- No
- Example
US
result.englishLatinAddress.postalAddress.sublocality
string
Description
- Always Returned
- No
- Example
""Empty string
result.englishLatinAddress.postalAddress.locality
string
Description
- Always Returned
- No
- Example
Washington
result.englishLatinAddress.postalAddress.postalCode
string
Description
- Always Returned
- No
- Example
20500
result.englishLatinAddress.postalAddress.revision
integer
Description
- Always Returned
- No
- Example
0
Address components 9 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.englishLatinAddress.addressComponents |
object[] |
No | |
Component objects in no guaranteed order; do not rely on array positions. |
result.englishLatinAddress.addressComponents[].replaced |
boolean |
No | false |
Component replaced rather than cosmetically corrected. |
result.englishLatinAddress.addressComponents[].spellCorrected |
boolean |
No | false |
Component spelling changed. |
result.englishLatinAddress.addressComponents[].inferred |
boolean |
No | false |
Component added from address context. |
result.englishLatinAddress.addressComponents[].componentType |
string |
No | street_number |
Address component category, such as street_number or route. |
result.englishLatinAddress.addressComponents[].unexpected |
boolean |
No | false |
Component retained from input despite being unexpected for this address. |
result.englishLatinAddress.addressComponents[].componentName |
object |
No | |
Component text and optional language. |
result.englishLatinAddress.addressComponents[].componentName.text |
string |
No | 1600 |
Component value. |
result.englishLatinAddress.addressComponents[].componentName.languageCode |
string |
No | en |
Language tag, when available. |
result.englishLatinAddress.addressComponents
object[]
Description
- Always Returned
- No
- Example
[ { "componentType": "street_number" } ]
result.englishLatinAddress.addressComponents[].replaced
boolean
Description
- Always Returned
- No
- Example
false
result.englishLatinAddress.addressComponents[].spellCorrected
boolean
Description
- Always Returned
- No
- Example
false
result.englishLatinAddress.addressComponents[].inferred
boolean
Description
- Always Returned
- No
- Example
false
result.englishLatinAddress.addressComponents[].componentType
string
Description
- Always Returned
- No
- Example
street_number
result.englishLatinAddress.addressComponents[].unexpected
boolean
Description
- Always Returned
- No
- Example
false
result.englishLatinAddress.addressComponents[].componentName
object
Description
- Always Returned
- No
- Example
{}
result.englishLatinAddress.addressComponents[].componentName.text
string
Description
- Always Returned
- No
- Example
1600
result.englishLatinAddress.addressComponents[].componentName.languageCode
string
Description
- Always Returned
- No
- Example
en
Missing and unresolved fields 2 fields
| Field Name | Type | Always Returned | Example | Description |
|---|---|---|---|---|
result.englishLatinAddress.unresolvedTokens |
string[] |
No | |
Input fragments that could not be interpreted. |
result.englishLatinAddress.missingComponentTypes |
string[] |
No | |
Required component types that could not be supplied or inferred. |
result.englishLatinAddress.unresolvedTokens
string[]
Description
- Always Returned
- No
- Example
[ "unknown" ]
result.englishLatinAddress.missingComponentTypes
string[]
Description
- Always Returned
- No
- Example
[ "subpremise" ]