Pitney Bowes Data Validation Services helps eliminate errors in data and improve customer experience. It makes communication easier, faster and effortless by enriching customer details, keeping it up-to-date and maintaining its accuracy and consistency. To learn more, visit the documentation page: https://aka.ms/kvz9oh
Status: Preview |
Tier: Premium |
Version: 1.0.0 |
Name |
Summary |
ValidateMailingAddress (ValidateMailingAddressParameterInputAddress InputAddress) |
Validate Mailing Address |
ValidateMailingAddressPro (ValidateMailingAddressProParameterInputAddress InputAddress) |
Validate Mailing Address Pro |
ValidateMailingAddressPremium (ValidateMailingAddressPremiumParameterInputAddress InputAddress) |
Validate Mailing Address Premium |
ValidateEmailAddress (ValidateEmailAddressParameterInputEmail InputEmail) |
Validate Email Address |
Name |
Summary |
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Validate Mailing Address
Description: ValidateMailingAddress analyses and compares the input addresses against the known address databases around the world to output a standardized detail. Learn more in our documentation: https://aka.ms/wzsawb
Syntax:
PitneyBowesDataValidation.ValidateMailingAddress (ValidateMailingAddressParameterInputAddress InputAddress)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
InputAddress |
ValidateMailingAddressParameterInputAddress
|
|
True |
Returns:
Type:array of (ValidateMailingAddressResponseItem)
Summary: Validate Mailing Address Pro
Description: ValidateMailingAddressPro builds upon the ValidateMailingAddress service by using additional address databases so it can provide enhanced detail. Learn more in our documentation: https://aka.ms/pbv0v9
Syntax:
PitneyBowesDataValidation.ValidateMailingAddressPro (ValidateMailingAddressProParameterInputAddress InputAddress)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
InputAddress |
ValidateMailingAddressProParameterInputAddress
|
|
True |
Returns:
Type:array of (ValidateMailingAddressProResponseItem)
Summary: Validate Mailing Address Premium
Description: ValidateMailing AddressPremium expands on the ValidateMailingAddressPro service by adding premium address data sources to get the best address validation result possible. Learn more in our documentation: https://aka.ms/s9jl1k
Syntax:
PitneyBowesDataValidation.ValidateMailingAddressPremium (ValidateMailingAddressPremiumParameterInputAddress InputAddress)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
InputAddress |
ValidateMailingAddressPremiumParameterInputAddress
|
|
True |
Returns:
Type:array of (ValidateMailingAddressPremiumResponseItem)
Summary: Validate Email Address
Description: The ValidateEmailAddress service takes an email address and determines if it is valid. It can fix common typos to return a valid email address. It also identifies problematic email addresses. Learn more in our documentation: https://aka.ms/Yqv7pc
Syntax:
PitneyBowesDataValidation.ValidateEmailAddress (ValidateEmailAddressParameterInputEmail InputEmail)
Parameters:
Name |
Type |
Summary |
Required |
Related Action |
InputEmail |
ValidateEmailAddressParameterInputEmail
|
|
True |
Returns:
Type:array of (ValidateEmailAddressResponseItem)
Summary:
Description:
Properties:
Name |
Type |
Summary |
Input |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
Row |
array of (RowItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
bogus |
string Bogus |
Specifies whether to check if the email address is fictitious. Default value is true. Values: [true, false] |
complain |
string Complain |
Specifies whether to check if the owner of the email address is known to submit spam complaints. Default value is true. Values: [true, false] |
disposable |
string Disposable |
Specifies whether to check if the email address originates from a website that provides temporary email addresses. Default value is true. Values: [true, false] |
atc |
string Atc |
One character code controlling the advanced suggestion behavior. Default value is aggressive. Values: [Aggressive, Conservative, No Suggestion] |
emailAddress |
string Email Address |
The email address you want to validate. |
emps |
string Emps |
Specifies whether to check if the email address appears on the Direct Marketing Association's 'Do Not Email' list. Default value is true. Values: [true, false] |
fccwireless |
string FCC Wireless |
Specifies whether to check if the email address is associated with a domain that has restrictions on commercial email per the FCC. Default value is true. Values: [true, false] |
language |
string Language |
Specifies whether to check if the email address handle contains derogatory words. Default value is true. Values: [true, false] |
role |
string Role |
Specifies whether to check if the email address has a non-personal handle, such as info@, sales@, or webmaster@. Default value is true. Values: [true, false] |
rtc |
string RTC |
Enables or disables real-time confirmation. Default value is true. Values: [true, false] |
rtc_timeout |
string RTC timeout |
Specifies the timeout for real-time confirmation. Default value is 1200. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
COMMENT |
string Comment |
The comment string pertaining to the result of the submitted email address. |
COMMENT_CODE |
string Comment Code |
A short code which maps to each returned COMMENT field value. |
|
string |
The email address submitted for verification. |
ERROR |
string Error |
Field reserved for special features only. |
ERROR_RESPONSE |
string Error Response |
Pre-formatted response intended to be provided to user. |
FINDING |
string Finding |
One character code indicating the validity of the submitted email address. |
SUGG_COMMENT |
string Suggestion Comment |
This field contains 'suggestion not SafeToDeliver' when ValidateEmailAddress corrected the address and the corrected version of the email address failed one or more SafeToDeliver process checks. |
SUGG_EMAIL |
string Suggestion Email |
Suggested correction for submitted email address, if found. A suggestion will only be provided if it is valid and SafeToDeliver. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
options |
|
|
Input |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
OutputCasing |
string Output Casing |
Specify the casing of the output data. Values: [Mixed case, Upper case] |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Row |
array of (RowItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
AddressLine1 |
string Address Line 1 |
The first address line. |
AddressLine2 |
string Address Line 2 |
The second address line. |
FirmName |
string Firm Name |
The company or firm name. |
City |
string City |
The city name. |
StateProvince |
string State Province |
The state or province. |
Country |
string Country |
The country code or name. |
PostalCode |
string Postal Code |
The postal code for the address. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
options |
|
|
Input |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
OutputAddressBlocks |
string Output Address Blocks |
Specifies whether to return a formatted version of the address as it would be printed on a physical mail piece. Values: [No, Yes] |
KeepMultimatch |
string Keep Multimatch |
Specifies whether to return multiple address for those input addresses that have more than one possible match. Values: [No, Yes] |
OutputCountryFormat |
string Output Country Format |
Specifies the format to use for the country name returned in the Country output field. Values: [English, ISO, Universal Postal Union] |
OutputRecordType |
string Output Record Type |
Specifies the type of output record you get. |
OutputFieldLevelReturnCodes |
string Output Field Level Return Codes |
Specifies whether to include field-level result indicators. Values: [No, Yes] |
OutputScript |
string Output Script |
Specifies the alphabet or script in which the output should be returned. Values: [Input Script, Native Script, English] |
OutputCasing |
string Output Casing |
Specify the casing of the output data. Values: [Mixed case, Upper case] |
MaximumResults |
string Maximum Results |
A number between 1 and 10 that indicates the maximum number of addresses to return. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Row |
array of (RowItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
AddressLine1 |
string Address Line 1 |
The first address line. |
AddressLine2 |
string Address Line 2 |
The second address line. |
AddressLine3 |
string Address Line 3 |
The third address line. |
AddressLine4 |
string Address Line 4 |
The fourth address line. |
AddressLine5 |
string Address Line 5 |
The fifth address line. |
FirmName |
string Firm Name |
The company or firm name. |
City |
string City |
The city name. |
StateProvince |
string State Province |
The state or province. |
Country |
string Country |
The country code or name. |
PostalCode |
string Postal Code |
The postal code for the address. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Status |
string Status |
Reports the success or failure of the match attempt. |
StatusCode |
string Status Code |
Reason for failure, if there is one. |
StatusDescription |
string Status Description |
Description of the problem, if there is one. |
Confidence |
string Confidence |
The level of confidence assigned to the address being returned. |
RecordType |
string Record Type |
Type of address record. |
RecordTypeDefault |
string Record Type Default |
Code indicating the default match. |
MultipleMatches |
string Multiple Matches |
Indicates which address component had multiple matches. |
CouldNotValidate |
string Could Not Validate |
Mentions the address component that could not be validated, in case no match is found. |
CountryLevel |
string Country Level |
The category of address matching available. |
AddressFormat |
string Address Format |
The type of address data being returned. |
AddressLine1 |
string Address Line 1 |
The first line of the validated address. |
AddressLine2 |
string Address Line 2 |
The second line of the validated address. |
AddressLine3 |
string Address Line 3 |
The third line of the validated address. |
AddressLine4 |
string Address Line 4 |
The fourth line of the validated address. |
City |
string City |
The validated city name. |
StateProvince |
string State Province |
The validated state or province abbreviation. |
PostalCode |
string Postal Code |
The validated ZIP Code™ or postal code. |
PostalCodeBase |
string Postal Code Base |
The 5-digit ZIP Code™. |
PostalCodeAddOn |
string Postal Code AddOn |
The 4-digit add-on part of the ZIP Code™. |
Country |
string Country |
The country in the format determined by what you selected. |
AdditionalInputData |
string Additional Input Data |
Input data that could not be matched to a particular address component. |
FirmName |
string Firm Name |
The validated firm or company name. |
HouseNumber |
string House Number |
House number. |
LeadingDirectional |
string Leading Directional |
Leading directional. |
StreetName |
string Street Name |
Street name. |
StreetSuffix |
string Street Suffix |
Street suffix. |
TrailingDirectional |
string Trailing Directional |
Trailing directional. |
ApartmentLabel |
string Apartment Label |
Apartment designator (such as STE or APT). |
ApartmentNumber |
string Apartment Number |
Apartment number. |
ApartmentLabel2 |
string Apartment Label 2 |
Secondary apartment designator. |
ApartmentNumber2 |
string Apartment Number 2 |
Secondary apartment number. |
RRHC |
string RRHC |
Rural Route/Highway Contract indicator. |
POBox |
string PO Box |
Post office box number. |
PrivateMailbox |
string Private Mailbox |
Private mailbox indicator. |
PrivateMailboxType |
string Private Mailbox Type |
The type of private mailbox. |
HouseNumberInput |
string House Number Input |
House number. |
LeadingDirectionalInput |
string Leading Directional Input |
Leading directional. |
StreetNameInput |
string Street Name Input |
Street name. |
StreetSuffixInput |
string Street Suffix Input |
Street suffix. |
TrailingDirectionalInput |
string Trailing Directional Input |
Trailing directional. |
ApartmentLabelInput |
string Apartment Label Input |
Apartment designator (such as STE or APT). |
ApartmentNumberInput |
string Apartment Number Input |
Apartment number. |
RRHCInput |
string RRHC Input |
Rural Route/Highway Contract indicator. |
POBoxInput |
string PO Box Input |
Post office box number. |
PrivateMailboxInput |
string Private Mailbox Input |
Private mailbox indicator. |
PrivateMailboxTypeInput |
string Private Mailbox Type Input |
The type of private mailbox. |
CityInput |
string City Input |
Validated city name. |
StateProvinceInput |
string State Province Input |
Validated state or province name. |
PostalCodeInput |
string Postal Code Input |
Validated postal code. |
CountryInput |
string Country Input |
Country. Format is determined by what you selected in OutputCountryFormat. |
FirmNameInput |
string Firm Name Input |
The validated firm or company name. |
HouseNumberResult |
string House Number Result |
The field-level result indicator for HouseNumber. |
LeadingDirectionalResult |
string Leading Directional Result |
The field-level result indicator for LeadingDirectional. |
StreetResult |
string Street Result |
The field-level result indicator for Street. |
StreetNameResult |
string Street Name Result |
The field-level result indicator for StreetName. |
StreetNameAliasType |
string Street Name Alias Type |
The field-level result indicator for StreetName Alias. |
StreetSuffixResult |
string Street Suffix Result |
The field-level result indicator for StreetSuffix. |
TrailingDirectionalResult |
string Trailing Directional Result |
The field-level result indicator for TrailingDirectional. |
ApartmentLabelResult |
string Apartment Label Result |
The field-level result indicator for ApartmentLabel. |
ApartmentNumberResult |
string Apartment Number Result |
The field-level result indicator for ApartmentNumber. |
ApartmentLabel2Result |
string Apartment Label 2 Result |
The field-level result indicator for ApartmentLabel2. |
ApartmentNumber2Result |
string Apartment Number 2 Result |
The field-level result indicator for ApartmentNumber2. |
RRHCResult |
string RRHC Result |
The field-level result indicator for RRHC. |
RRHCType |
string RRHC Type |
The field-level result indicator for RRHC Type. |
POBoxResult |
string PO Box Result |
The field-level result indicator for POBox. |
CityResult |
string City Result |
The field-level result indicator for City. |
StateProvinceResult |
string State Province Result |
The field-level result indicator for StateProvince. |
PostalCodeResult |
string Postal Code Result |
The field-level result indicator for PostalCode. |
PostalCodeCityResult |
string Postal Code City Result |
The field-level result indicator for PostalCodeCity. |
AddressRecordResult |
string Address Record Result |
The field-level result indicator for AddressRecord. |
PostalCodeSource |
string Postal Code Source |
The field-level result indicator for PostalCode Source. |
PostalCodeType |
string Postal Code Type |
Indicates the type of postal code returned. |
CountryResult |
string Country Result |
The validated firm or company name. |
FirmNameResult |
string Firm Name Result |
Indicates if the firm name got validated. |
StreetNamePreferredAliasResult |
string Street Name Preferred Alias Result |
Indicates the result of preferred alias processing. |
StreetNameAbbreviatedAliasResult |
string Street Name Abbreviated Alias Result |
Indicates the result of abbreviated alias processing. |
AddressLine5 |
string Address Line 5 |
The fifth line of the validated address. |
AddressQuality |
string Address Quality |
A two character code indicating overall quality of the resulting address. |
Deliverability |
string Deliverability |
An estimate of confidence that an item mailed or shipped to this address would be successfully delivered. |
AddressType |
string Address Type |
A single letter code that indicates the type of address. |
Locality |
string Locality |
A locality is a village in rural areas or it may be a suburb in urban areas. |
ChangeScore |
string Change Score |
A value of 0 and 100 that reflects how much the address has changed to make it valid. |
Suburb |
string Suburb |
The validated firm or company name. |
BlockAddress |
string Block Address |
It is the formatted address, as it would appear on a physical mail piece. |
Latitude |
string Latitude |
Seven-digit number in degrees, calculated to four decimal places. |
Longitude |
string Longitude |
Seven-digit number in degrees, calculated to four decimal places. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
options |
|
|
Input |
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
OutputAddressBlocks |
string Output Address Blocks |
Specifies whether to return a formatted version of the address as it would be printed on a physical mail piece. Values: [No, Yes] |
KeepMultimatch |
string Keep Multimatch |
Specifies whether to return multiple address for those input addresses that have more than one possible match. Values: [No, Yes] |
OutputCountryFormat |
string Output Country Format |
Specifies the format to use for the country name returned in the Country output field. Values: [English, ISO, Universal Postal Union] |
OutputScript |
string Output Script |
Specifies the alphabet or script in which the output should be returned. Values: [Input Script, Native Script, English] |
OutputCasing |
string Output Casing |
Specify the casing of the output data. Values: [Mixed case, Upper case] |
MaximumResults |
string Maximum Results |
A number between 1 and 10 that indicates the maximum number of addresses to return. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
Row |
array of (RowItem)
|
|
Summary:
Description:
Properties:
Name |
Type |
Summary |
AddressLine1 |
string Address Line 1 |
The first address line. |
AddressLine2 |
string Address Line 2 |
The second address line. |
FirmName |
string Firm Name |
The company or firm name. |
City |
string City |
The city name. |
StateProvince |
string State Province |
The state or province. |
Country |
string Country |
The country code or name. |
PostalCode |
string Postal Code |
The postal code for the address. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
AddressLine1 |
string Address Line 1 |
The first line of the validated address. |
AddressLine2 |
string Address Line 2 |
The second line of the validated address. |
FirmName |
string Firm Name |
The validated firm or company name. |
ChangeScore |
string Change Score |
A value of 0 and 100 that reflects how much the address has changed to make it valid. |
Locality |
string Locality |
Generally a locality is a village in rural areas or it may be a suburb in urban areas. |
Suburb |
string Suburb |
The suburb name. |
AddressType |
string Address Type |
A single letter code that indicates the type of address. |
Deliverability |
string Deliverability |
An estimate of confidence that an item mailed or shipped to this address would be successfully delivered. |
AddressQuality |
string Address Quality |
A two character code indicating overall quality of the resulting address. |
CouldNotValidate |
string Could Not Validate |
Mentions the address component that could not be validated, in case no match is found. |
City |
string City |
The validated city name. |
PostalCode |
string Postal Code |
The validated ZIP Code™ or postal code. |
Country |
string Country |
The country in the format determined by what you selected. |
StateProvince |
string State Province |
The validated state or province abbreviation. |
BlockAddress |
string Block Address |
The formatted address, as it would appear on a physical mail piece. |
AdditionalInputData |
string Additional Input Data |
Input data that could not be matched to a particular address component. |
PostalCodeBase |
string Postal Code Base |
The 5-digit ZIP Code™. |
PostalCodeAddOn |
string Postal Code AddOn |
The 4-digit add-on part of the ZIP Code™. |
Status |
string Status |
Reports the success or failure of the match attempt. |
StatusCode |
string Status Code |
Reason for failure, if there is one. |
StatusDescription |
string Status Description |
Description of the problem, if there is one. |
Summary:
Description:
Properties:
Name |
Type |
Summary |
AddressLine1 |
string Address Line 1 |
The first line of the validated address. |
AddressLine2 |
string Address Line 2 |
The second line of the validated address. |
FirmName |
string Firm Name |
The validated firm or company name. |
City |
string City |
The validated city name. |
PostalCode |
string Postal Code |
The validated ZIP Code™ or postal code. |
Country |
string Country |
The country name in English. |
StateProvince |
string State Province |
The validated state or province abbreviation. |
BlockAddress |
string Block Address |
The formatted address, as it would appear on a physical mail piece. |
AdditionalInputData |
string Additional Input Data |
Input data not used by the address validation process. |
PostalCodeBase |
string Postal Code Base |
The 5-digit ZIP Code™. |
PostalCodeAddOn |
string Postal Code AddOn |
The 4-digit add-on part of the ZIP Code™. |
Status |
string Status |
Reports the success or failure of the match attempt. |
StatusCode |
string Status Code |
Reason for failure, if there is one. |
StatusDescription |
string Status Description |
Description of the problem, if there is one. |