Pitney Bowes Data Validation [DEPRECATED]
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
This connector is available in the following products and regions:
Service | Class | Regions |
---|---|---|
Logic Apps | Standard | All Logic Apps regions except the following: - Azure Government regions - Azure China regions - US Department of Defense (DoD) |
Power Automate | Premium | All Power Automate regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Power Apps | Premium | All Power Apps regions except the following: - US Government (GCC) - US Government (GCC High) - China Cloud operated by 21Vianet - US Department of Defense (DoD) |
Contact | |
---|---|
Name | Pitney Bowes Support |
software.support@pb.com |
Connector Metadata | |
---|---|
Publisher | Not Available |
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 Power Automate or Power Apps, please use the Error Code field for lookup purposes.
- 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.
The Pitney Bowes Data Validation connector has been deprecated as of August 2020 at the request of the connector publisher.
The connector supports the following authentication types:
Default | Parameters for creating connection. | All regions | Not shareable |
Applicable: All regions
Parameters for creating connection.
This is not shareable connection. If the power app is shared with another user, another user will be prompted to create new connection explicitly.
Name | Type | Description | Required |
---|---|---|---|
API Key (Learn more here: https://aka.ms/kvz9oh) | securestring | Your API key for Pitney Bowes | True |
Secret | securestring | Your client secret for Pitney Bowes | True |
Name | Calls | Renewal Period |
---|---|---|
API calls per connection | 100 | 60 seconds |
Validate Email Address [DEPRECATED] |
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 |
Validate Mailing Address [DEPRECATED] |
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 |
Validate Mailing Address Premium [DEPRECATED] |
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 |
Validate Mailing Address Pro [DEPRECATED] |
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 |
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
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Bogus
|
bogus | string |
Specifies whether to check if the email address is fictitious. Default value is true. |
|
Complain
|
complain | string |
Specifies whether to check if the owner of the email address is known to submit spam complaints. Default value is true. |
|
Disposable
|
disposable | string |
Specifies whether to check if the email address originates from a website that provides temporary email addresses. Default value is true. |
|
Atc
|
atc | string |
One character code controlling the advanced suggestion behavior. Default value is aggressive. |
|
Email Address
|
emailAddress | string |
The email address you want to validate. |
|
Emps
|
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
|
fccwireless | 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
|
language | string |
Specifies whether to check if the email address handle contains derogatory words. Default value is true. |
|
Role
|
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
|
rtc | string |
Enables or disables real-time confirmation. Default value is true. |
|
RTC timeout
|
rtc_timeout | string |
Specifies the timeout for real-time confirmation. Default value is 1200. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Comment
|
COMMENT | string |
The comment string pertaining to the result of the submitted email address. |
Comment Code
|
COMMENT_CODE | string |
A short code which maps to each returned COMMENT field value. |
Email
|
string |
The email address submitted for verification. |
|
Error
|
ERROR | string |
Field reserved for special features only. |
Error Response
|
ERROR_RESPONSE | string |
Pre-formatted response intended to be provided to user. |
Finding
|
FINDING | string |
One character code indicating the validity of the submitted email address. |
Suggestion Comment
|
SUGG_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
|
SUGG_EMAIL | string |
Suggested correction for submitted email address, if found. A suggestion will only be provided if it is valid and SafeToDeliver. |
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
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Output Casing
|
OutputCasing | string |
Specify the casing of the output data. |
|
Address Line 1
|
AddressLine1 | string |
The first address line. |
|
Address Line 2
|
AddressLine2 | string |
The second address line. |
|
Firm Name
|
FirmName | string |
The company or firm name. |
|
City
|
City | string |
The city name. |
|
State Province
|
StateProvince | string |
The state or province. |
|
Country
|
Country | string |
The country code or name. |
|
Postal Code
|
PostalCode | string |
The postal code for the address. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Address Line 1
|
AddressLine1 | string |
The first line of the validated address. |
Address Line 2
|
AddressLine2 | string |
The second line of the validated address. |
Firm Name
|
FirmName | string |
The validated firm or company name. |
City
|
City | string |
The validated city name. |
Postal Code
|
PostalCode | string |
The validated ZIP Code™ or postal code. |
Country
|
Country | string |
The country name in English. |
State Province
|
StateProvince | string |
The validated state or province abbreviation. |
Block Address
|
BlockAddress | string |
The formatted address, as it would appear on a physical mail piece. |
Additional Input Data
|
AdditionalInputData | string |
Input data not used by the address validation process. |
Postal Code Base
|
PostalCodeBase | string |
The 5-digit ZIP Code™. |
Postal Code AddOn
|
PostalCodeAddOn | string |
The 4-digit add-on part of the ZIP Code™. |
Status
|
Status | string |
Reports the success or failure of the match attempt. |
Status Code
|
StatusCode | string |
Reason for failure, if there is one. |
Status Description
|
StatusDescription | string |
Description of the problem, if there is one. |
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
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Output Address Blocks
|
OutputAddressBlocks | string |
Specifies whether to return a formatted version of the address as it would be printed on a physical mail piece. |
|
Keep Multimatch
|
KeepMultimatch | string |
Specifies whether to return multiple address for those input addresses that have more than one possible match. |
|
Output Country Format
|
OutputCountryFormat | string |
Specifies the format to use for the country name returned in the Country output field. |
|
Output Record Type
|
OutputRecordType | string |
Specifies the type of output record you get. |
|
Output Field Level Return Codes
|
OutputFieldLevelReturnCodes | string |
Specifies whether to include field-level result indicators. |
|
Output Script
|
OutputScript | string |
Specifies the alphabet or script in which the output should be returned. |
|
Output Casing
|
OutputCasing | string |
Specify the casing of the output data. |
|
Maximum Results
|
MaximumResults | string |
A number between 1 and 10 that indicates the maximum number of addresses to return. |
|
Address Line 1
|
AddressLine1 | string |
The first address line. |
|
Address Line 2
|
AddressLine2 | string |
The second address line. |
|
Address Line 3
|
AddressLine3 | string |
The third address line. |
|
Address Line 4
|
AddressLine4 | string |
The fourth address line. |
|
Address Line 5
|
AddressLine5 | string |
The fifth address line. |
|
Firm Name
|
FirmName | string |
The company or firm name. |
|
City
|
City | string |
The city name. |
|
State Province
|
StateProvince | string |
The state or province. |
|
Country
|
Country | string |
The country code or name. |
|
Postal Code
|
PostalCode | string |
The postal code for the address. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Status
|
Status | string |
Reports the success or failure of the match attempt. |
Status Code
|
StatusCode | string |
Reason for failure, if there is one. |
Status Description
|
StatusDescription | string |
Description of the problem, if there is one. |
Confidence
|
Confidence | string |
The level of confidence assigned to the address being returned. |
Record Type
|
RecordType | string |
Type of address record. |
Record Type Default
|
RecordTypeDefault | string |
Code indicating the default match. |
Multiple Matches
|
MultipleMatches | string |
Indicates which address component had multiple matches. |
Could Not Validate
|
CouldNotValidate | string |
Mentions the address component that could not be validated, in case no match is found. |
Country Level
|
CountryLevel | string |
The category of address matching available. |
Address Format
|
AddressFormat | string |
The type of address data being returned. |
Address Line 1
|
AddressLine1 | string |
The first line of the validated address. |
Address Line 2
|
AddressLine2 | string |
The second line of the validated address. |
Address Line 3
|
AddressLine3 | string |
The third line of the validated address. |
Address Line 4
|
AddressLine4 | string |
The fourth line of the validated address. |
City
|
City | string |
The validated city name. |
State Province
|
StateProvince | string |
The validated state or province abbreviation. |
Postal Code
|
PostalCode | string |
The validated ZIP Code™ or postal code. |
Postal Code Base
|
PostalCodeBase | string |
The 5-digit ZIP Code™. |
Postal Code AddOn
|
PostalCodeAddOn | string |
The 4-digit add-on part of the ZIP Code™. |
Country
|
Country | string |
The country in the format determined by what you selected. |
Additional Input Data
|
AdditionalInputData | string |
Input data that could not be matched to a particular address component. |
Firm Name
|
FirmName | string |
The validated firm or company name. |
House Number
|
HouseNumber | string |
House number. |
Leading Directional
|
LeadingDirectional | string |
Leading directional. |
Street Name
|
StreetName | string |
Street name. |
Street Suffix
|
StreetSuffix | string |
Street suffix. |
Trailing Directional
|
TrailingDirectional | string |
Trailing directional. |
Apartment Label
|
ApartmentLabel | string |
Apartment designator (such as STE or APT). |
Apartment Number
|
ApartmentNumber | string |
Apartment number. |
Apartment Label 2
|
ApartmentLabel2 | string |
Secondary apartment designator. |
Apartment Number 2
|
ApartmentNumber2 | string |
Secondary apartment number. |
RRHC
|
RRHC | string |
Rural Route/Highway Contract indicator. |
PO Box
|
POBox | string |
Post office box number. |
Private Mailbox
|
PrivateMailbox | string |
Private mailbox indicator. |
Private Mailbox Type
|
PrivateMailboxType | string |
The type of private mailbox. |
House Number Input
|
HouseNumberInput | string |
House number. |
Leading Directional Input
|
LeadingDirectionalInput | string |
Leading directional. |
Street Name Input
|
StreetNameInput | string |
Street name. |
Street Suffix Input
|
StreetSuffixInput | string |
Street suffix. |
Trailing Directional Input
|
TrailingDirectionalInput | string |
Trailing directional. |
Apartment Label Input
|
ApartmentLabelInput | string |
Apartment designator (such as STE or APT). |
Apartment Number Input
|
ApartmentNumberInput | string |
Apartment number. |
RRHC Input
|
RRHCInput | string |
Rural Route/Highway Contract indicator. |
PO Box Input
|
POBoxInput | string |
Post office box number. |
Private Mailbox Input
|
PrivateMailboxInput | string |
Private mailbox indicator. |
Private Mailbox Type Input
|
PrivateMailboxTypeInput | string |
The type of private mailbox. |
City Input
|
CityInput | string |
Validated city name. |
State Province Input
|
StateProvinceInput | string |
Validated state or province name. |
Postal Code Input
|
PostalCodeInput | string |
Validated postal code. |
Country Input
|
CountryInput | string |
Country. Format is determined by what you selected in OutputCountryFormat. |
Firm Name Input
|
FirmNameInput | string |
The validated firm or company name. |
House Number Result
|
HouseNumberResult | string |
The field-level result indicator for HouseNumber. |
Leading Directional Result
|
LeadingDirectionalResult | string |
The field-level result indicator for LeadingDirectional. |
Street Result
|
StreetResult | string |
The field-level result indicator for Street. |
Street Name Result
|
StreetNameResult | string |
The field-level result indicator for StreetName. |
Street Name Alias Type
|
StreetNameAliasType | string |
The field-level result indicator for StreetName Alias. |
Street Suffix Result
|
StreetSuffixResult | string |
The field-level result indicator for StreetSuffix. |
Trailing Directional Result
|
TrailingDirectionalResult | string |
The field-level result indicator for TrailingDirectional. |
Apartment Label Result
|
ApartmentLabelResult | string |
The field-level result indicator for ApartmentLabel. |
Apartment Number Result
|
ApartmentNumberResult | string |
The field-level result indicator for ApartmentNumber. |
Apartment Label 2 Result
|
ApartmentLabel2Result | string |
The field-level result indicator for ApartmentLabel2. |
Apartment Number 2 Result
|
ApartmentNumber2Result | string |
The field-level result indicator for ApartmentNumber2. |
RRHC Result
|
RRHCResult | string |
The field-level result indicator for RRHC. |
RRHC Type
|
RRHCType | string |
The field-level result indicator for RRHC Type. |
PO Box Result
|
POBoxResult | string |
The field-level result indicator for POBox. |
City Result
|
CityResult | string |
The field-level result indicator for City. |
State Province Result
|
StateProvinceResult | string |
The field-level result indicator for StateProvince. |
Postal Code Result
|
PostalCodeResult | string |
The field-level result indicator for PostalCode. |
Postal Code City Result
|
PostalCodeCityResult | string |
The field-level result indicator for PostalCodeCity. |
Address Record Result
|
AddressRecordResult | string |
The field-level result indicator for AddressRecord. |
Postal Code Source
|
PostalCodeSource | string |
The field-level result indicator for PostalCode Source. |
Postal Code Type
|
PostalCodeType | string |
Indicates the type of postal code returned. |
Country Result
|
CountryResult | string |
The validated firm or company name. |
Firm Name Result
|
FirmNameResult | string |
Indicates if the firm name got validated. |
Street Name Preferred Alias Result
|
StreetNamePreferredAliasResult | string |
Indicates the result of preferred alias processing. |
Street Name Abbreviated Alias Result
|
StreetNameAbbreviatedAliasResult | string |
Indicates the result of abbreviated alias processing. |
Address Line 5
|
AddressLine5 | string |
The fifth line of the validated address. |
Address Quality
|
AddressQuality | string |
A two character code indicating overall quality of the resulting address. |
Deliverability
|
Deliverability | string |
An estimate of confidence that an item mailed or shipped to this address would be successfully delivered. |
Address Type
|
AddressType | string |
A single letter code that indicates the type of address. |
Locality
|
Locality | string |
A locality is a village in rural areas or it may be a suburb in urban areas. |
Change Score
|
ChangeScore | string |
A value of 0 and 100 that reflects how much the address has changed to make it valid. |
Suburb
|
Suburb | string |
The validated firm or company name. |
Block Address
|
BlockAddress | string |
It is the formatted address, as it would appear on a physical mail piece. |
Latitude
|
Latitude | string |
Seven-digit number in degrees, calculated to four decimal places. |
Longitude
|
Longitude | string |
Seven-digit number in degrees, calculated to four decimal places. |
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
Parameters
Name | Key | Required | Type | Description |
---|---|---|---|---|
Output Address Blocks
|
OutputAddressBlocks | string |
Specifies whether to return a formatted version of the address as it would be printed on a physical mail piece. |
|
Keep Multimatch
|
KeepMultimatch | string |
Specifies whether to return multiple address for those input addresses that have more than one possible match. |
|
Output Country Format
|
OutputCountryFormat | string |
Specifies the format to use for the country name returned in the Country output field. |
|
Output Script
|
OutputScript | string |
Specifies the alphabet or script in which the output should be returned. |
|
Output Casing
|
OutputCasing | string |
Specify the casing of the output data. |
|
Maximum Results
|
MaximumResults | string |
A number between 1 and 10 that indicates the maximum number of addresses to return. |
|
Address Line 1
|
AddressLine1 | string |
The first address line. |
|
Address Line 2
|
AddressLine2 | string |
The second address line. |
|
Firm Name
|
FirmName | string |
The company or firm name. |
|
City
|
City | string |
The city name. |
|
State Province
|
StateProvince | string |
The state or province. |
|
Country
|
Country | string |
The country code or name. |
|
Postal Code
|
PostalCode | string |
The postal code for the address. |
Returns
Name | Path | Type | Description |
---|---|---|---|
|
array of object | ||
Address Line 1
|
AddressLine1 | string |
The first line of the validated address. |
Address Line 2
|
AddressLine2 | string |
The second line of the validated address. |
Firm Name
|
FirmName | string |
The validated firm or company name. |
Change Score
|
ChangeScore | string |
A value of 0 and 100 that reflects how much the address has changed to make it valid. |
Locality
|
Locality | string |
Generally a locality is a village in rural areas or it may be a suburb in urban areas. |
Suburb
|
Suburb | string |
The suburb name. |
Address Type
|
AddressType | string |
A single letter code that indicates the type of address. |
Deliverability
|
Deliverability | string |
An estimate of confidence that an item mailed or shipped to this address would be successfully delivered. |
Address Quality
|
AddressQuality | string |
A two character code indicating overall quality of the resulting address. |
Could Not Validate
|
CouldNotValidate | string |
Mentions the address component that could not be validated, in case no match is found. |
City
|
City | string |
The validated city name. |
Postal Code
|
PostalCode | string |
The validated ZIP Code™ or postal code. |
Country
|
Country | string |
The country in the format determined by what you selected. |
State Province
|
StateProvince | string |
The validated state or province abbreviation. |
Block Address
|
BlockAddress | string |
The formatted address, as it would appear on a physical mail piece. |
Additional Input Data
|
AdditionalInputData | string |
Input data that could not be matched to a particular address component. |
Postal Code Base
|
PostalCodeBase | string |
The 5-digit ZIP Code™. |
Postal Code AddOn
|
PostalCodeAddOn | string |
The 4-digit add-on part of the ZIP Code™. |
Status
|
Status | string |
Reports the success or failure of the match attempt. |
Status Code
|
StatusCode | string |
Reason for failure, if there is one. |
Status Description
|
StatusDescription | string |
Description of the problem, if there is one. |