Pitney Bowes Data Validation (Preview)

Pitney Bowes Data Validation (Preview)

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

Note:

  • This is a Premium connector.

To use this integration, you need to have an account on the Pitney Bowes Developer Hub. Follow steps below to get your API Key and Secret.

If you see an error while using the connector you may look up the error code for more information. Note the HTTP status code in the documentation may be slightly different than what you see in Flow or PowerApps, please use the Error Code field for lookup purposes.

Get the API Key and Secret

  • Register for a Pitney Bowes Developer Account.
  • Sign In with your Developer Account and select API Keys in the Identify menu.

You will see your API key and Secret listed on API Key page.

You're now ready to start using this integration.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Creating a connection

To connect your account, you will need the following information:

API Key (Learn more here: https://aka.ms/kvz9oh)
securestring
Your API key for Pitney Bowes
Secret
securestring
Your client secret for Pitney Bowes

Actions

Validate Email Address

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

Optional Parameters

Bogus
string
Specifies whether to check if the email address is fictitious. Default value is true.
Complain
string
Specifies whether to check if the owner of the email address is known to submit spam complaints. Default value is true.
Disposable
string
Specifies whether to check if the email address originates from a website that provides temporary email addresses. Default value is true.
Atc
string
One character code controlling the advanced suggestion behavior. Default value is aggressive.
Email Address
string
The email address you want to validate.
Emps
string
Specifies whether to check if the email address appears on the Direct Marketing Association's 'Do Not Email' list. Default value is true.
FCC Wireless
string
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.
Language
string
Specifies whether to check if the email address handle contains derogatory words. Default value is true.
Role
string
Specifies whether to check if the email address has a non-personal handle, such as info@, sales@, or webmaster@. Default value is true.
RTC
string
Enables or disables real-time confirmation. Default value is true.
RTC timeout
string
Specifies the timeout for real-time confirmation. Default value is 1200.

Returns

array of object
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
Comment
string
The comment string pertaining to the result of the submitted email address.
Comment Code
string
A short code which maps to each returned COMMENT field value.
Email
string
The email address submitted for verification.
Error
string
Field reserved for special features only.
Error Response
string
Pre-formatted response intended to be provided to user.
Finding
string
One character code indicating the validity of the submitted email address.
Suggestion Comment
string
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.
Suggestion Email
string
Suggested correction for submitted email address, if found. A suggestion will only be provided if it is valid and SafeToDeliver.

Validate Mailing Address

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

Optional Parameters

Output Casing
string
Specify the casing of the output data.
Address Line 1
string
The first address line.
Address Line 2
string
The second address line.
Firm Name
string
The company or firm name.
City
string
The city name.
State Province
string
The state or province.
Country
string
The country code or name.
Postal Code
string
The postal code for the address.

Returns

array of object
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
Address Line 1
string
The first line of the validated address.
Address Line 2
string
The second line of the validated address.
Firm Name
string
The validated firm or company name.
City
string
The validated city name.
Postal Code
string
The validated ZIP Code™ or postal code.
Country
string
The country name in English.
State Province
string
The validated state or province abbreviation.
Block Address
string
The formatted address, as it would appear on a physical mail piece.
Additional Input Data
string
Input data not used by the address validation process.
Postal Code Base
string
The 5-digit ZIP Code™.
Postal Code AddOn
string
The 4-digit add-on part of the ZIP Code™.
Status
string
Reports the success or failure of the match attempt.
Status Code
string
Reason for failure, if there is one.
Status Description
string
Description of the problem, if there is one.

Validate Mailing Address Premium

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

Optional Parameters

Output Address Blocks
string
Specifies whether to return a formatted version of the address as it would be printed on a physical mail piece.
Keep Multimatch
string
Specifies whether to return multiple address for those input addresses that have more than one possible match.
Output Country Format
string
Specifies the format to use for the country name returned in the Country output field.
Output Record Type
string
Specifies the type of output record you get.
Output Field Level Return Codes
string
Specifies whether to include field-level result indicators.
Output Script
string
Specifies the alphabet or script in which the output should be returned.
Output Casing
string
Specify the casing of the output data.
Maximum Results
string
A number between 1 and 10 that indicates the maximum number of addresses to return.
Address Line 1
string
The first address line.
Address Line 2
string
The second address line.
Address Line 3
string
The third address line.
Address Line 4
string
The fourth address line.
Address Line 5
string
The fifth address line.
Firm Name
string
The company or firm name.
City
string
The city name.
State Province
string
The state or province.
Country
string
The country code or name.
Postal Code
string
The postal code for the address.

Returns

array of object
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
Status
string
Reports the success or failure of the match attempt.
Status Code
string
Reason for failure, if there is one.
Status Description
string
Description of the problem, if there is one.
Confidence
string
The level of confidence assigned to the address being returned.
Record Type
string
Type of address record.
Record Type Default
string
Code indicating the default match.
Multiple Matches
string
Indicates which address component had multiple matches.
Could Not Validate
string
Mentions the address component that could not be validated, in case no match is found.
Country Level
string
The category of address matching available.
Address Format
string
The type of address data being returned.
Address Line 1
string
The first line of the validated address.
Address Line 2
string
The second line of the validated address.
Address Line 3
string
The third line of the validated address.
Address Line 4
string
The fourth line of the validated address.
City
string
The validated city name.
State Province
string
The validated state or province abbreviation.
Postal Code
string
The validated ZIP Code™ or postal code.
Postal Code Base
string
The 5-digit ZIP Code™.
Postal Code AddOn
string
The 4-digit add-on part of the ZIP Code™.
Country
string
The country in the format determined by what you selected.
Additional Input Data
string
Input data that could not be matched to a particular address component.
Firm Name
string
The validated firm or company name.
House Number
string
House number.
Leading Directional
string
Leading directional.
Street Name
string
Street name.
Street Suffix
string
Street suffix.
Trailing Directional
string
Trailing directional.
Apartment Label
string
Apartment designator (such as STE or APT).
Apartment Number
string
Apartment number.
Apartment Label 2
string
Secondary apartment designator.
Apartment Number 2
string
Secondary apartment number.
RRHC
string
Rural Route/Highway Contract indicator.
PO Box
string
Post office box number.
Private Mailbox
string
Private mailbox indicator.
Private Mailbox Type
string
The type of private mailbox.
House Number Input
string
House number.
Leading Directional Input
string
Leading directional.
Street Name Input
string
Street name.
Street Suffix Input
string
Street suffix.
Trailing Directional Input
string
Trailing directional.
Apartment Label Input
string
Apartment designator (such as STE or APT).
Apartment Number Input
string
Apartment number.
RRHC Input
string
Rural Route/Highway Contract indicator.
PO Box Input
string
Post office box number.
Private Mailbox Input
string
Private mailbox indicator.
Private Mailbox Type Input
string
The type of private mailbox.
City Input
string
Validated city name.
State Province Input
string
Validated state or province name.
Postal Code Input
string
Validated postal code.
Country Input
string
Country. Format is determined by what you selected in OutputCountryFormat.
Firm Name Input
string
The validated firm or company name.
House Number Result
string
The field-level result indicator for HouseNumber.
Leading Directional Result
string
The field-level result indicator for LeadingDirectional.
Street Result
string
The field-level result indicator for Street.
Street Name Result
string
The field-level result indicator for StreetName.
Street Name Alias Type
string
The field-level result indicator for StreetName Alias.
Street Suffix Result
string
The field-level result indicator for StreetSuffix.
Trailing Directional Result
string
The field-level result indicator for TrailingDirectional.
Apartment Label Result
string
The field-level result indicator for ApartmentLabel.
Apartment Number Result
string
The field-level result indicator for ApartmentNumber.
Apartment Label 2 Result
string
The field-level result indicator for ApartmentLabel2.
Apartment Number 2 Result
string
The field-level result indicator for ApartmentNumber2.
RRHC Result
string
The field-level result indicator for RRHC.
RRHC Type
string
The field-level result indicator for RRHC Type.
PO Box Result
string
The field-level result indicator for POBox.
City Result
string
The field-level result indicator for City.
State Province Result
string
The field-level result indicator for StateProvince.
Postal Code Result
string
The field-level result indicator for PostalCode.
Postal Code City Result
string
The field-level result indicator for PostalCodeCity.
Address Record Result
string
The field-level result indicator for AddressRecord.
Postal Code Source
string
The field-level result indicator for PostalCode Source.
Postal Code Type
string
Indicates the type of postal code returned.
Country Result
string
The validated firm or company name.
Firm Name Result
string
Indicates if the firm name got validated.
Street Name Preferred Alias Result
string
Indicates the result of preferred alias processing.
Street Name Abbreviated Alias Result
string
Indicates the result of abbreviated alias processing.
Address Line 5
string
The fifth line of the validated address.
Address Quality
string
A two character code indicating overall quality of the resulting address.
Deliverability
string
An estimate of confidence that an item mailed or shipped to this address would be successfully delivered.
Address Type
string
A single letter code that indicates the type of address.
Locality
string
A locality is a village in rural areas or it may be a suburb in urban areas.
Change Score
string
A value of 0 and 100 that reflects how much the address has changed to make it valid.
Suburb
string
The validated firm or company name.
Block Address
string
It is the formatted address, as it would appear on a physical mail piece.
Latitude
string
Seven-digit number in degrees, calculated to four decimal places.
Longitude
string
Seven-digit number in degrees, calculated to four decimal places.

Validate Mailing Address Pro

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

Optional Parameters

Output Address Blocks
string
Specifies whether to return a formatted version of the address as it would be printed on a physical mail piece.
Keep Multimatch
string
Specifies whether to return multiple address for those input addresses that have more than one possible match.
Output Country Format
string
Specifies the format to use for the country name returned in the Country output field.
Output Script
string
Specifies the alphabet or script in which the output should be returned.
Output Casing
string
Specify the casing of the output data.
Maximum Results
string
A number between 1 and 10 that indicates the maximum number of addresses to return.
Address Line 1
string
The first address line.
Address Line 2
string
The second address line.
Firm Name
string
The company or firm name.
City
string
The city name.
State Province
string
The state or province.
Country
string
The country code or name.
Postal Code
string
The postal code for the address.

Returns

array of object
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
Address Line 1
string
The first line of the validated address.
Address Line 2
string
The second line of the validated address.
Firm Name
string
The validated firm or company name.
Change Score
string
A value of 0 and 100 that reflects how much the address has changed to make it valid.
Locality
string
Generally a locality is a village in rural areas or it may be a suburb in urban areas.
Suburb
string
The suburb name.
Address Type
string
A single letter code that indicates the type of address.
Deliverability
string
An estimate of confidence that an item mailed or shipped to this address would be successfully delivered.
Address Quality
string
A two character code indicating overall quality of the resulting address.
Could Not Validate
string
Mentions the address component that could not be validated, in case no match is found.
City
string
The validated city name.
Postal Code
string
The validated ZIP Code™ or postal code.
Country
string
The country in the format determined by what you selected.
State Province
string
The validated state or province abbreviation.
Block Address
string
The formatted address, as it would appear on a physical mail piece.
Additional Input Data
string
Input data that could not be matched to a particular address component.
Postal Code Base
string
The 5-digit ZIP Code™.
Postal Code AddOn
string
The 4-digit add-on part of the ZIP Code™.
Status
string
Reports the success or failure of the match attempt.
Status Code
string
Reason for failure, if there is one.
Status Description
string
Description of the problem, if there is one.