Provero Logo

Global address validation API

The Global address validation API validates and standardises international postal addresses. Put one complete customer-supplied address in 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

POST
https://api.provero.io/api/validate/address

Headers

Authorization:
Content-Type: application/json
Accept: application/json


Request Body

Field Type Required Description
address object Yes Container for the customer-supplied address query.
address.addressLines string[] Yes One address as an array of one or more address-line strings. The total input is limited to 280 characters.
output_format string No standard (default)
Cleansed address fields, match verdict, and qualification.

detailed
Cleansed fields at the top level plus the complete validation result.
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"
  }'

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."
}

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.

VerdictMeaningDefault qualification
Exact matchComplete address was confirmed as entered, including a supplied flat number if applicable.Address confirmed as entered.
Strong matchComplete address was confirmed with only minor corrections or supporting details added.Address confirmed with minor corrections or additions.
Partial matchBuilding was confirmed, but a flat number or another identifying detail needs confirmation.Building confirmed, but some address details need confirmation.
Weak matchStreet or approximate building confirmed; key details are uncertain or changed.Only part of the address could be confirmed.
UnverifiedAddress 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

Standard output

Standard output contains a cleansed address and a match verdict with a short qualification.

Field NameTypeAlways
Returned
ExampleDescription
address object No
{
    "postal_code": "20500",
    "country_code": "US"
}
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

Cleansed address object in standard output. Every cleansed field is included; unavailable values are empty strings.
Always Returned
No
Example
{
    "postal_code": "20500",
    "country_code": "US"
}
verdict string

Description

Match verdict in standard output: Exact match, Strong match, Partial match, Weak match, or Unverified. Unavailable for missing legacy data.
Always Returned
No
Example
Exact match
qualification string

Description

Short explanation of the main reason for the match verdict.
Always Returned
No
Example
Address confirmed as entered.
AddressUse cleansed address fields or inspect the structured address details. 11 fields
Field NameTypeAlways
Returned
ExampleDescription
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

First cleansed address line.
Always Returned
Yes
Example
1600 Pennsylvania Avenue NW
address.address_line_2 string

Description

Second cleansed address line, or an empty string.
Always Returned
Yes
Example
""Empty string
address.address_line_3 string

Description

Third cleansed address line, or an empty string.
Always Returned
Yes
Example
""Empty string
address.locality string

Description

Cleansed city or town.
Always Returned
Yes
Example
Washington
address.sublocality string

Description

Cleansed neighbourhood, borough, or district.
Always Returned
Yes
Example
""Empty string
address.administrative_area string

Description

Cleansed postal administrative area when available; otherwise the level 2 administrative component (for example, a UK county) when returned.
Always Returned
Yes
Example
DC
address.postal_code string

Description

Cleansed postal or ZIP code.
Always Returned
Yes
Example
20500
address.sorting_code string

Description

Cleansed country-specific sorting code.
Always Returned
Yes
Example
""Empty string
address.country_code string

Description

Cleansed ISO-2 country or region code.
Always Returned
Yes
Example
US
address.language_code string

Description

Language code returned with the cleansed postal address.
Always Returned
Yes
Example
""Empty string
address.formatted_address string

Description

Complete cleansed and formatted address.
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 NameTypeAlways
Returned
ExampleDescription
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
{
    "verdict": {},
    "address": {}
}
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

First cleansed address line.
Always Returned
Yes
Example
1600 Pennsylvania Avenue NW
address_line_2 string

Description

Second cleansed address line, or an empty string.
Always Returned
Yes
Example
""Empty string
address_line_3 string

Description

Third cleansed address line, or an empty string.
Always Returned
Yes
Example
""Empty string
locality string

Description

Cleansed city or town.
Always Returned
Yes
Example
Washington
sublocality string

Description

Cleansed neighbourhood, borough, or district.
Always Returned
Yes
Example
""Empty string
administrative_area string

Description

Cleansed postal administrative area when available; otherwise the level 2 administrative component (for example, a UK county) when returned.
Always Returned
Yes
Example
DC
postal_code string

Description

Cleansed postal or ZIP code.
Always Returned
Yes
Example
20500
sorting_code string

Description

Cleansed country-specific sorting code.
Always Returned
Yes
Example
""Empty string
country_code string

Description

Cleansed ISO-2 country or region code.
Always Returned
Yes
Example
US
language_code string

Description

Language code returned with the cleansed postal address.
Always Returned
Yes
Example
""Empty string
formatted_address string

Description

Complete cleansed and formatted address.
Always Returned
Yes
Example
1600 Pennsylvania Avenue NW, Washington, DC 20500, USA
result object

Description

Complete validation result in detailed output. Includes the verdict and optional address, geocode, metadata and USPS data.
Always Returned
No
Example
{
    "verdict": {},
    "address": {}
}
responseId string

Description

Provider response identifier.
Always Returned
No
Example
example-response-id
VerdictReview validation quality and suggested next steps. 10 fields
Field NameTypeAlways
Returned
ExampleDescription
result.verdict object No
{
    "addressComplete": true,
    "possibleNextAction": "ACCEPT"
}
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

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.
Always Returned
No
Example
{
    "addressComplete": true,
    "possibleNextAction": "ACCEPT"
}
result.verdict.validationGranularity string

Description

Finest address level confirmed by validation. Values: GRANULARITY_UNSPECIFIED, SUB_PREMISE, PREMISE, PREMISE_PROXIMITY, BLOCK, ROUTE or OTHER.
Always Returned
No
Example
PREMISE
result.verdict.hasUnconfirmedComponents boolean

Description

Whether any component remains unverified.
Always Returned
No
Example
false
result.verdict.possibleNextAction string

Description

Preview guidance: FIX, CONFIRM_ADD_SUBPREMISES, CONFIRM or ACCEPT; POSSIBLE_NEXT_ACTION_UNSPECIFIED is unused. Not a deliverability guarantee.
Always Returned
No
Example
ACCEPT
result.verdict.hasSpellCorrectedComponents boolean

Description

Whether component spelling was corrected.
Always Returned
No
Example
false
result.verdict.addressComplete boolean

Description

True when required components are complete and no unresolved or unexpected components remain. Omitted means false.
Always Returned
No
Example
false
result.verdict.inputGranularity string

Description

Precision of the submitted address, before validation. Values: GRANULARITY_UNSPECIFIED, SUB_PREMISE, PREMISE, PREMISE_PROXIMITY, BLOCK, ROUTE or OTHER.
Always Returned
No
Example
PREMISE
result.verdict.hasInferredComponents boolean

Description

Whether missing components were added.
Always Returned
No
Example
false
result.verdict.geocodeGranularity string

Description

Precision of the returned location; can differ from validation precision. Values: GRANULARITY_UNSPECIFIED, SUB_PREMISE, PREMISE, PREMISE_PROXIMITY, BLOCK, ROUTE or OTHER.
Always Returned
No
Example
PREMISE
result.verdict.hasReplacedComponents boolean

Description

Whether incorrect components were substituted.
Always Returned
No
Example
false
Address detailsUse cleansed address fields or inspect the structured address details. 25 fields
Overview 2 fields
Field NameTypeAlways
Returned
ExampleDescription
result.address object No
{
    "formattedAddress": "1600 Pennsylvania Avenue NW, Washington, DC 20500, USA"
}
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

Formatted address, postal address, component confirmations, and unresolved/missing component lists. Individual fields vary with the result.
Always Returned
No
Example
{
    "formattedAddress": "1600 Pennsylvania Avenue NW, Washington, DC 20500, USA"
}
result.address.formattedAddress string

Description

Cleansed address in display order.
Always Returned
No
Example
1600 Pennsylvania Avenue NW, Washington, DC 20500, USA
Postal address 10 fields
Field NameTypeAlways
Returned
ExampleDescription
result.address.postalAddress object No
{}
Structured postal fields.
result.address.postalAddress.sortingCode string No Additional postal sorting information.
result.address.postalAddress.addressLines string[] No
[
    "1600 Pennsylvania Avenue NW"
]
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

Structured postal fields.
Always Returned
No
Example
{}
result.address.postalAddress.sortingCode string

Description

Additional postal sorting information.
Always Returned
No
Example
""Empty string
result.address.postalAddress.addressLines string[]

Description

Ordered postal address lines.
Always Returned
No
Example
[
    "1600 Pennsylvania Avenue NW"
]
result.address.postalAddress.administrativeArea string

Description

Postal state, province or equivalent.
Always Returned
No
Example
DC
result.address.postalAddress.languageCode string

Description

Language tag, when available.
Always Returned
No
Example
en
result.address.postalAddress.regionCode string

Description

Two-letter region code.
Always Returned
No
Example
US
result.address.postalAddress.sublocality string

Description

District or neighbourhood.
Always Returned
No
Example
""Empty string
result.address.postalAddress.locality string

Description

Postal town or city.
Always Returned
No
Example
Washington
result.address.postalAddress.postalCode string

Description

Postal or ZIP code.
Always Returned
No
Example
20500
result.address.postalAddress.revision integer

Description

Postal schema revision; currently zero.
Always Returned
No
Example
0
Address components 10 fields
Field NameTypeAlways
Returned
ExampleDescription
result.address.addressComponents object[] No
[
    {
        "componentType": "street_number"
    }
]
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

Component objects in no guaranteed order; do not rely on array positions.
Always Returned
No
Example
[
    {
        "componentType": "street_number"
    }
]
result.address.addressComponents[].replaced boolean

Description

Component replaced rather than cosmetically corrected.
Always Returned
No
Example
false
result.address.addressComponents[].spellCorrected boolean

Description

Component spelling changed.
Always Returned
No
Example
false
result.address.addressComponents[].inferred boolean

Description

Component added from address context.
Always Returned
No
Example
false
result.address.addressComponents[].componentType string

Description

Address component category, such as street_number or route.
Always Returned
No
Example
street_number
result.address.addressComponents[].confirmationLevel string

Description

CONFIRMED, UNCONFIRMED_BUT_PLAUSIBLE or UNCONFIRMED_AND_SUSPICIOUS; CONFIRMATION_LEVEL_UNSPECIFIED is unused.
Always Returned
No
Example
CONFIRMED
result.address.addressComponents[].unexpected boolean

Description

Component retained from input despite being unexpected for this address.
Always Returned
No
Example
false
result.address.addressComponents[].componentName object

Description

Component text and optional language.
Always Returned
No
Example
{}
result.address.addressComponents[].componentName.text string

Description

Component value.
Always Returned
No
Example
1600
result.address.addressComponents[].componentName.languageCode string

Description

Language tag, when available.
Always Returned
No
Example
en
Missing and unresolved fields 3 fields
Field NameTypeAlways
Returned
ExampleDescription
result.address.unconfirmedComponentTypes string[] No
[
    "street_number"
]
Component types requiring confirmation.
result.address.unresolvedTokens string[] No
[
    "unknown"
]
Input fragments that could not be interpreted.
result.address.missingComponentTypes string[] No
[
    "subpremise"
]
Required component types that could not be supplied or inferred.
result.address.unconfirmedComponentTypes string[]

Description

Component types requiring confirmation.
Always Returned
No
Example
[
    "street_number"
]
result.address.unresolvedTokens string[]

Description

Input fragments that could not be interpreted.
Always Returned
No
Example
[
    "unknown"
]
result.address.missingComponentTypes string[]

Description

Required component types that could not be supplied or inferred.
Always Returned
No
Example
[
    "subpremise"
]
GeocodeFind the matched location, bounds and location codes. 17 fields
Overview 4 fields
Field NameTypeAlways
Returned
ExampleDescription
result.geocode object No
{
    "location": {
        "latitude": 38.8977,
        "longitude": -77.0365
    }
}
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
[
    "street_address"
]
Categories of the matched place.
result.geocode.placeId string No example-place-id Matched place identifier.
result.geocode object

Description

Geocode, place ID, bounds, feature size, and location types when available.
Always Returned
No
Example
{
    "location": {
        "latitude": 38.8977,
        "longitude": -77.0365
    }
}
result.geocode.featureSizeMeters number

Description

Approximate size of the matched feature in metres.
Always Returned
No
Example
20
result.geocode.placeTypes string[]

Description

Categories of the matched place.
Always Returned
No
Example
[
    "street_address"
]
result.geocode.placeId string

Description

Matched place identifier.
Always Returned
No
Example
example-place-id
Location 3 fields
Field NameTypeAlways
Returned
ExampleDescription
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

Latitude and longitude of the match.
Always Returned
No
Example
{}
result.geocode.location.longitude number

Description

Longitude in degrees, from -180 to 180.
Always Returned
No
Example
-77.0365
result.geocode.location.latitude number

Description

Latitude in degrees, from -90 to 90.
Always Returned
No
Example
38.8977
Bounds 7 fields
Field NameTypeAlways
Returned
ExampleDescription
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

Geographic bounds of the match.
Always Returned
No
Example
{}
result.geocode.bounds.high object

Description

Upper bounds point; longitude may cross the antimeridian.
Always Returned
No
Example
{}
result.geocode.bounds.low object

Description

Lower bounds point; longitude may cross the antimeridian.
Always Returned
No
Example
{}
result.geocode.bounds.low.longitude number

Description

Longitude in degrees, from -180 to 180.
Always Returned
No
Example
-77.0365
result.geocode.bounds.low.latitude number

Description

Latitude in degrees, from -90 to 90.
Always Returned
No
Example
38.8977
result.geocode.bounds.high.longitude number

Description

Longitude in degrees, from -180 to 180.
Always Returned
No
Example
-77.0365
result.geocode.bounds.high.latitude number

Description

Latitude in degrees, from -90 to 90.
Always Returned
No
Example
38.8977
Plus codes 3 fields
Field NameTypeAlways
Returned
ExampleDescription
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

Location codes, when available.
Always Returned
No
Example
{}
result.geocode.plusCode.globalCode string

Description

Complete location code.
Always Returned
No
Example
87C4V4W2+J4
result.geocode.plusCode.compoundCode string

Description

Short location code with locality context.
Always Returned
No
Example
V4W2+J4 Washington, DC
MetadataUnderstand the address kind; missing flags mean unknown. 4 fields
Field NameTypeAlways
Returned
ExampleDescription
result.metadata object No
{
    "business": false,
    "poBox": false,
    "residential": false
}
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

Address metadata. Omitted flags mean unknown, rather than false.
Always Returned
No
Example
{
    "business": false,
    "poBox": false,
    "residential": false
}
result.metadata.business boolean

Description

Whether this is a business address. Omitted means unknown, not false.
Always Returned
No
Example
false
result.metadata.poBox boolean

Description

Whether this is a PO box. Omitted means unknown, not false.
Always Returned
No
Example
false
result.metadata.residential boolean

Description

Whether this is residential. Omitted means unknown, not false.
Always Returned
No
Example
false
USPS dataInspect US postal data and delivery indicators when available. 47 fields
Delivery indicators 37 fields
Field NameTypeAlways
Returned
ExampleDescription
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

USPS data for US and Puerto Rican addresses, when available. Individual fields are not guaranteed. Provero does not request CASS processing.
Always Returned
No
Example
{}
result.uspsData.elotFlag string

Description

Delivery sequence direction, A or D.
Always Returned
No
Example
""Empty string
result.uspsData.dpvThrowback string

Description

Delivery to a PO box instead of the street address.
Always Returned
No
Example
""Empty string
result.uspsData.dpvVacant string

Description

Vacancy indicator.
Always Returned
No
Example
""Empty string
result.uspsData.dpvPbsa string

Description

PO box street-addressing indicator.
Always Returned
No
Example
""Empty string
result.uspsData.dpvNoStat string

Description

Non-delivery/no-stat indicator.
Always Returned
No
Example
""Empty string
result.uspsData.suitelinkFootnote string

Description

Suite matching result code.
Always Returned
No
Example
""Empty string
result.uspsData.lacsLinkIndicator string

Description

Address conversion match indicator.
Always Returned
No
Example
""Empty string
result.uspsData.deliveryPointCode string

Description

Two-digit delivery point code.
Always Returned
No
Example
00
result.uspsData.fipsCountyCode string

Description

County FIPS identifier.
Always Returned
No
Example
""Empty string
result.uspsData.carrierRouteIndicator string

Description

Carrier route sorting category.
Always Returned
No
Example
D
result.uspsData.cassProcessed boolean

Description

Whether CASS processing occurred; Provero does not request CASS mode.
Always Returned
No
Example
false
result.uspsData.dpvDrop string

Description

Shared delivery point indicator.
Always Returned
No
Example
""Empty string
result.uspsData.dpvNonDeliveryDays string

Description

Indicator for restricted delivery days.
Always Returned
No
Example
""Empty string
result.uspsData.dpvConfirmation string

Description

Y: primary/secondary confirmed; D: secondary missing; S: secondary unconfirmed; N: unconfirmed. Omitted means no DPV confirmation result.
Always Returned
No
Example
Y
result.uspsData.postOfficeState string

Description

Serving post office state.
Always Returned
No
Example
DC
result.uspsData.errorMessage string

Description

USPS processing message; other USPS fields may be absent.
Always Returned
No
Example
""Empty string
result.uspsData.ewsNoMatch boolean

Description

Address awaiting an exact match in postal updates.
Always Returned
No
Example
false
result.uspsData.dpvFootnote string

Description

Combined delivery-point validation codes.
Always Returned
No
Example
AABB
result.uspsData.abbreviatedCity string

Description

Postal city abbreviation.
Always Returned
No
Example
""Empty string
result.uspsData.postOfficeCity string

Description

Serving post office city.
Always Returned
No
Example
WASHINGTON
result.uspsData.pmbNumber string

Description

Private mailbox number.
Always Returned
No
Example
""Empty string
result.uspsData.carrierRoute string

Description

Carrier route identifier.
Always Returned
No
Example
C001
result.uspsData.dpvCmra string

Description

Commercial mail receiving agency indicator.
Always Returned
No
Example
""Empty string
result.uspsData.lacsLinkReturnCode string

Description

Address conversion result code.
Always Returned
No
Example
""Empty string
result.uspsData.dpvNoStatReasonCode integer

Description

Numeric reason for no-stat status.
Always Returned
No
Example
1
result.uspsData.defaultAddress boolean

Description

Whether the match is a default address with more specific alternatives.
Always Returned
No
Example
false
result.uspsData.county string

Description

County name.
Always Returned
No
Example
""Empty string
result.uspsData.dpvDoorNotAccessible string

Description

Door accessibility indicator.
Always Returned
No
Example
""Empty string
result.uspsData.deliveryPointCheckDigit string

Description

Delivery barcode check digit.
Always Returned
No
Example
0
result.uspsData.dpvEnhancedDeliveryCode string

Description

Enhanced delivery confirmation code.
Always Returned
No
Example
""Empty string
result.uspsData.addressRecordType string

Description

Postal record category: F, G, H, P, R or S.
Always Returned
No
Example
""Empty string
result.uspsData.elotNumber string

Description

Delivery sequence identifier.
Always Returned
No
Example
""Empty string
result.uspsData.pmbDesignator string

Description

Private mailbox designation.
Always Returned
No
Example
""Empty string
result.uspsData.dpvNonDeliveryDaysValues integer

Description

Bitmask of non-delivery days: Sunday 1 through Saturday 64.
Always Returned
No
Example
65
result.uspsData.dpvNoSecureLocation string

Description

Indicator for no secure delivery location.
Always Returned
No
Example
""Empty string
result.uspsData.poBoxOnlyPostalCode boolean

Description

Whether the postal code supports PO boxes only.
Always Returned
No
Example
false
Standardized postal address 10 fields
Field NameTypeAlways
Returned
ExampleDescription
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

USPS postal address fields.
Always Returned
No
Example
{}
result.uspsData.standardizedAddress.firstAddressLine string

Description

Primary postal address line.
Always Returned
No
Example
1600 PENNSYLVANIA AVE NW
result.uspsData.standardizedAddress.zipCodeExtension string

Description

Four-digit ZIP extension.
Always Returned
No
Example
0001
result.uspsData.standardizedAddress.firm string

Description

USPS firm name, when supplied.
Always Returned
No
Example
""Empty string
result.uspsData.standardizedAddress.secondAddressLine string

Description

Secondary postal address line.
Always Returned
No
Example
""Empty string
result.uspsData.standardizedAddress.urbanization string

Description

Puerto Rican urbanization name.
Always Returned
No
Example
""Empty string
result.uspsData.standardizedAddress.cityStateZipAddressLine string

Description

Combined city, state and ZIP line.
Always Returned
No
Example
WASHINGTON DC 20500
result.uspsData.standardizedAddress.city string

Description

Postal city.
Always Returned
No
Example
WASHINGTON
result.uspsData.standardizedAddress.zipCode string

Description

Five-digit ZIP code.
Always Returned
No
Example
20500
result.uspsData.standardizedAddress.state string

Description

Two-letter state code.
Always Returned
No
Example
DC
English/Latin addressInspect optional English/Latin-script output for display. 23 fields
Overview 2 fields
Field NameTypeAlways
Returned
ExampleDescription
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

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.
Always Returned
No
Example
{}
result.englishLatinAddress.formattedAddress string

Description

Cleansed address in display order.
Always Returned
No
Example
1600 Pennsylvania Avenue NW, Washington, DC 20500, USA
Postal address 10 fields
Field NameTypeAlways
Returned
ExampleDescription
result.englishLatinAddress.postalAddress object No
{}
Structured postal fields.
result.englishLatinAddress.postalAddress.sortingCode string No Additional postal sorting information.
result.englishLatinAddress.postalAddress.addressLines string[] No
[
    "1600 Pennsylvania Avenue NW"
]
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

Structured postal fields.
Always Returned
No
Example
{}
result.englishLatinAddress.postalAddress.sortingCode string

Description

Additional postal sorting information.
Always Returned
No
Example
""Empty string
result.englishLatinAddress.postalAddress.addressLines string[]

Description

Ordered postal address lines.
Always Returned
No
Example
[
    "1600 Pennsylvania Avenue NW"
]
result.englishLatinAddress.postalAddress.administrativeArea string

Description

Postal state, province or equivalent.
Always Returned
No
Example
DC
result.englishLatinAddress.postalAddress.languageCode string

Description

Language tag, when available.
Always Returned
No
Example
en
result.englishLatinAddress.postalAddress.regionCode string

Description

Two-letter region code.
Always Returned
No
Example
US
result.englishLatinAddress.postalAddress.sublocality string

Description

District or neighbourhood.
Always Returned
No
Example
""Empty string
result.englishLatinAddress.postalAddress.locality string

Description

Postal town or city.
Always Returned
No
Example
Washington
result.englishLatinAddress.postalAddress.postalCode string

Description

Postal or ZIP code.
Always Returned
No
Example
20500
result.englishLatinAddress.postalAddress.revision integer

Description

Postal schema revision; currently zero.
Always Returned
No
Example
0
Address components 9 fields
Field NameTypeAlways
Returned
ExampleDescription
result.englishLatinAddress.addressComponents object[] No
[
    {
        "componentType": "street_number"
    }
]
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

Component objects in no guaranteed order; do not rely on array positions.
Always Returned
No
Example
[
    {
        "componentType": "street_number"
    }
]
result.englishLatinAddress.addressComponents[].replaced boolean

Description

Component replaced rather than cosmetically corrected.
Always Returned
No
Example
false
result.englishLatinAddress.addressComponents[].spellCorrected boolean

Description

Component spelling changed.
Always Returned
No
Example
false
result.englishLatinAddress.addressComponents[].inferred boolean

Description

Component added from address context.
Always Returned
No
Example
false
result.englishLatinAddress.addressComponents[].componentType string

Description

Address component category, such as street_number or route.
Always Returned
No
Example
street_number
result.englishLatinAddress.addressComponents[].unexpected boolean

Description

Component retained from input despite being unexpected for this address.
Always Returned
No
Example
false
result.englishLatinAddress.addressComponents[].componentName object

Description

Component text and optional language.
Always Returned
No
Example
{}
result.englishLatinAddress.addressComponents[].componentName.text string

Description

Component value.
Always Returned
No
Example
1600
result.englishLatinAddress.addressComponents[].componentName.languageCode string

Description

Language tag, when available.
Always Returned
No
Example
en
Missing and unresolved fields 2 fields
Field NameTypeAlways
Returned
ExampleDescription
result.englishLatinAddress.unresolvedTokens string[] No
[
    "unknown"
]
Input fragments that could not be interpreted.
result.englishLatinAddress.missingComponentTypes string[] No
[
    "subpremise"
]
Required component types that could not be supplied or inferred.
result.englishLatinAddress.unresolvedTokens string[]

Description

Input fragments that could not be interpreted.
Always Returned
No
Example
[
    "unknown"
]
result.englishLatinAddress.missingComponentTypes string[]

Description

Required component types that could not be supplied or inferred.
Always Returned
No
Example
[
    "subpremise"
]

Error structure

Field Name Type Always
Returned
Example Description
message string No Top-level malformed-request or billing error.
errors object No Field validation errors. These requests are rejected before lookup and are not charged.
requestError object No Returned when the validation service cannot process the request.