Connectors Reference
Data8 helps you build confidence in your data. We can save you money by cleaning and enriching both your existing data, as well as ensuring only the highest quality data goes in at the point of entry, leaving you to concentrate on targeting and communicating to the right customers.
|
Status: Preview |
Tier: Premium |
Version: 1.0.1 |
|
Name |
Summary |
|
Check Usable Name |
|
|
TPS Check |
|
|
CTPS Check |
|
|
Validate Bank Account Information |
|
|
Validate Email Address |
|
|
Validate Telephone Number |
|
|
Clean Address |
|
|
Get Full Address |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Check Usable Name
Description: Using this action, you can check if a name is a real usable name or whether it is salacious, random or blank.
Syntax:
Data8DataEnrichment.IsUsableName (IsUsableNameParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:IsUsableNameResponse
Summary: TPS Check
Description: Checks if a telephone number is registered on the TPS or not.
Syntax:
Data8DataEnrichment.IsCallableTPS (IsCallableTPSParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: CTPS Check
Description: Checks if a telephone number is registered on the CTPS or not.
Syntax:
Data8DataEnrichment.IsCallableCTPS (IsCallableCTPSParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: Validate Bank Account Information
Description: Check if a sort code and bank account number are valid.
Syntax:
Data8DataEnrichment.IsValidBankAccount (IsValidBankAccountParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
IsValidBankAccountParameterBody
|
|
True |
Returns:
Type:IsValidBankAccountResponse
Summary: Validate Email Address
Description: Checks to see if an inputted email address is valid to receive email
Syntax:
Data8DataEnrichment.IsValidEmail (IsValidEmailParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Type:IsValidEmailResponse
Summary: Validate Telephone Number
Description: Checks to see if an inputted email address is valid to receive email
Syntax:
Data8DataEnrichment.IsValidTelephone (IsValidTelephoneParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary: Clean Address
Description: Formats, verifies and corrects a given address into a full formatted address.
Syntax:
Data8DataEnrichment.CleanAddress ([Optional]CleanAddressParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
False |
Returns:
Type:CleanAddressResponse
Summary: Get Full Address
Description: Searches for an addresses based on input data such as building number and postcode
Syntax:
Data8DataEnrichment.GetFullAddress (GetFullAddressParameterBody body)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
body |
|
|
True |
Returns:
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
address |
|
address |
|
options |
|
options |
Summary:
Description: address
Properties:
|
Name |
Type |
Summary |
|
Lines |
array of (string)
|
Lines |
Summary:
Description: options
Properties:
|
Name |
Type |
Summary |
|
DefaultCountryCode |
string
|
An ISO 2 character code for the country to assume the address is in unless otherwise specified. This defaults to GB. |
|
DetectCountry |
boolean
|
Set to true to attempt to automatically detect the country from the provided address information, possibly overriding the default country |
|
Country |
string
|
If DetectCountry is set to true, this is taken as additional user input alongside the address to influence the country detection function. The format of this is not enforced, so could be provided as "US", "USA" or "United States" |
|
IncludeCountry |
boolean
|
Includes the CountryName field in the main part of the result |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Status |
|
Status |
|
Result |
|
Result |
|
MatchLevel |
string
|
Contains a MatchLevel to indicate how well the address matched to PAF. Possible values are OK_Unchanged, OK_Corrected, NOK_Building, NOK_Street, NOK_Town, NOK_NoMatch |
|
CountryName |
string
|
Contains the name of the country the address is in. |
Summary:
Description: Status
Properties:
|
Name |
Type |
Summary |
|
Success |
boolean
|
Flag to determine if the request to Data8 succeeded, regardless of result |
|
ErrorMessage |
string
|
Returned Error Message, if any |
|
CreditsRemaining |
number(float)
|
Data8 Credits Remaining for the called service |
Summary:
Description: Result
Properties:
|
Name |
Type |
Summary |
|
Address |
|
Address |
Summary:
Description: Address
Properties:
|
Name |
Type |
Summary |
|
Lines |
array of (string)
|
Lines |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
licence |
string
|
As the Royal Mail PAF database can be licensed in multiple ways, this parameter indicates under which license you are accessing the data. This must match the variant you have a license or credits for - if you are unsure which option to choose, please contact your account manager Values: [InternalUserFull, InternalUserFullArea, SmallUserFull, WebClickFull, WebServerFull, Lookup, InternalServerFull, FreeTrial] |
|
postcode |
string
|
The full postcode to get addresses for. Formatting of the postcode does not matter so "ch24ne", "CH2 4NE", "ch02 4Ne" are all accepted. |
|
building |
string
|
An optional value to filter the returned addresses by building name, number, sub-premise (e.g. flat number) or company name. If null or "" are supplied, all addresses on the postcode are included in the result. |
|
options |
|
options |
Summary:
Description: options
Properties:
|
Name |
Type |
Summary |
|
FixTownCounty |
boolean
|
true to ensure the town and county are returned in the last two address lines, or false if they should appear in the first available line. |
|
MaxLines |
integer(int32)
|
The number of lines to format the address over. An additional line will be included in the result for the postcode. |
|
MaxLineLength |
integer(int32)
|
The maximum number of characters that can appear in each address line. |
|
NormalizeCase |
boolean
|
Converts all text in the address except the town name to proper case. |
|
NormalizeTownCase |
boolean
|
Converts the town name to proper case |
|
ExcludeCounty |
boolean
|
Excludes the county, if any, from the formatted address |
|
UseAnyAvailableCounty |
boolean
|
Uses any available county to populate the formatted address, not just the postal county |
|
UnwantedPunctuation |
boolean
|
A string containing any punctuation characters to be removed from the formatted address |
|
FixBuilding |
boolean
|
Ensures the building name/number is always placed in the first line |
|
IncludeUDPRN |
boolean
|
Set to true to have the UniqueReference field of each returned address populated with the UDPRN |
|
IncludeLocation |
boolean
|
Set to true to have the Location field of each returned address populated with the geocoding details for the address |
|
ReturnResultCount |
boolean
|
Indicates if the ResultCount field in the result should be populated with the total number of addresses returned. |
|
IncludeNYB |
boolean
|
Set to true to include addresses from the Not Yet Built database in the results (requires additional licensing) |
|
IncludeMR |
boolean
|
Set to true to include addresses from the Multiple Residency database in the results (requires additional licensing) |
|
Formatter |
string
|
Pick from one of the available formatters to control how the raw address is converted into a human-readable address Values: [DefaultFormatter, PAFStandardFormatter, NoOrganisationFormatter] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Status |
|
Status |
|
ResultCount |
integer(int32)
|
|
|
Results |
array of (ResultsItem)
|
Results |
Summary:
Description: Status
Properties:
|
Name |
Type |
Summary |
|
Success |
boolean
|
Success |
|
ErrorMessage |
string
|
Error Message (if applicable) |
|
CreditsRemaining |
number(float)
|
Credits Remaining |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Address |
|
Formatted Address |
|
RawAddress |
|
Raw Address |
Summary:
Description: Formatted Address
Properties:
|
Name |
Type |
Summary |
|
Lines |
array of (string)
|
Formatted Address Lines |
Summary:
Description: Raw Address
Properties:
|
Name |
Type |
Summary |
|
Organisation |
string
|
Organisation |
|
Department |
string
|
Department |
|
AddressKey |
integer(int32)
|
Address Key |
|
OrganisationKey |
integer(int32)
|
Organisation Key |
|
PostcodeType |
string
|
Postcode Type |
|
BuildingNumber |
integer(int32)
|
Building Number |
|
SubBuildingName |
string
|
Sub Building Name |
|
BuildingName |
string
|
Building Name |
|
DependentThoroughfareName |
string
|
Dependent Thoroughfare Name |
|
DependentThoroughfareDesc |
string
|
Dependent Thoroughfare Desc |
|
ThoroughfareName |
string
|
Thoroughfare Name |
|
ThoroughfareDesc |
string
|
Thoroughfare Desc |
|
DoubleDependentLocality |
string
|
Double Dependent Locality |
|
DependentLocality |
string
|
Dependent Locality |
|
Locality |
string
|
Locality |
|
Postcode |
string
|
Postcode |
|
Dps |
string
|
DPS |
|
PoBox |
string
|
PO Box |
|
PostalCounty |
string
|
Postal County |
|
TraditionalCounty |
string
|
Traditional County |
|
AdministrativeCounty |
string
|
Administrative County |
|
CountryISO2 |
string
|
Country ISO2 |
|
UniqueReference |
string
|
Unique Reference |
|
Location |
|
Location |
Summary:
Description: Location
Properties:
|
Name |
Type |
Summary |
|
Easting |
integer(int32)
|
Easting |
|
Northing |
integer(int32)
|
Northing |
|
GridReference |
string
|
GridReference |
|
Longitude |
number(float)
|
Longitude |
|
Latitude |
number(float)
|
Latitude |
|
CountyCode |
string
|
CountyCode |
|
County |
string
|
County |
|
DistrictCode |
string
|
DistrictCode |
|
District |
string
|
District |
|
WardCode |
string
|
WardCode |
|
Ward |
string
|
Ward |
|
Country |
string
|
Country |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
number |
string
|
The telephone number you wish to CTPS check |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Status |
|
Status |
|
Callable |
boolean
|
Returns a boolean value letting you know if it's callable. If false, the number is currently on the CTPS. |
|
TelephoneNumber |
string
|
If populated, the telephone number is callable and null if not |
Summary:
Description: Status
Properties:
|
Name |
Type |
Summary |
|
Success |
boolean
|
Flag to determine if the request to Data8 succeeded, regardless of result |
|
ErrorMessage |
string
|
Returned Error Message, if any |
|
CreditsRemaining |
number(float)
|
Data8 Credits Remaining for the called service |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
number |
string
|
The telephone number you want to TPS check |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Status |
|
Status |
|
Callable |
boolean
|
Returns a boolean value letting you know if it's callable. If false, the number is currently on the TPS. |
|
TelephoneNumber |
string
|
Returns the telephone number if callable, null if not. |
Summary:
Description: Status
Properties:
|
Name |
Type |
Summary |
|
Success |
boolean
|
Flag to determine if the request to Data8 succeeded, regardless of result |
|
ErrorMessage |
string
|
Returned Error Message, if any |
|
CreditsRemaining |
number(float)
|
Data8 Credits Remaining for the called service |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
name |
|
name |
Summary:
Description: name
Properties:
|
Name |
Type |
Summary |
|
Title |
string
|
The title of the name |
|
Forename |
string
|
The first name of the full name |
|
MiddleName |
string
|
The middle name of the full name |
|
Surname |
string
|
The last name of the full name |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Status |
|
Status |
|
Result |
string
|
A blank value indiciates the name is a usable name. If a value is returned it will be one of the following: "IncompleteName", "RandomName" or "SalaciousName" Values: [, IncompleteName, RandomName, SalaciousName] |
Summary:
Description: Status
Properties:
|
Name |
Type |
Summary |
|
Success |
boolean
|
Flag to determine if the request to Data8 succeeded, regardless of result |
|
ErrorMessage |
string
|
Returned Error Message, if any |
|
CreditsRemaining |
number(float)
|
Data8 Credits Remaining for the called service |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
sortCode |
string
|
The sort code you wish to validate |
|
bankAccountNumber |
string
|
The bank account number you wish to validate |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Status |
|
Status |
|
Valid |
string
|
Indicates if the incoming sort code and bank account number could be validated. |
|
SortCode |
string
|
The sort code that has been validated. |
|
AccountNumber |
string
|
The account number that has been validated. |
|
BICCode |
string
|
The BIC code of the bank branch indicated by the sort code. |
|
IBAN |
string
|
The IBAN code of the bank account indicated by the sort code and account number. |
|
BranchName |
string
|
The name of the bank branch indicated by the sort code. |
|
ShortBankName |
string
|
A short name for the bank indicated by the sort code. |
|
FullBankName |
string
|
The full name for the bank indicated by the sort code. |
|
Address |
|
Address |
|
AcceptsBACSPayments |
boolean
|
Indicates if the bank branch can accept payments made through the BACS system. |
|
AcceptsDirectDebitTransactions |
boolean
|
Indicates if the bank branch can accept direct debit payments. |
|
AcceptsDirectCreditTransactions |
boolean
|
Indicates if the bank branch can accept direct credit payments. |
|
AcceptsUnpaidChequeClaimTransactions |
boolean
|
Indicates if the bank branch can accept claims for unpaid cheques. |
|
AcceptsBuildingSocietyCreditTransactions |
boolean
|
Indicates if the bank branch can accept credits from building societies. |
|
AcceptsDividendInterestPaymentTransactions |
boolean
|
Indicates if the bank branch can accept dividend interest payments. |
|
AcceptsDirectDebitInstructionTransactions |
boolean
|
Indicates if the bank branch can accept direct debit instructions. |
|
AcceptsCHAPSPayments |
boolean
|
Indicates if the bank branch can accept payments made through the CHAPS system. |
|
AcceptsCheques |
boolean
|
Indicates if the bank branch can accept payments made by cheque. |
|
AcceptsFasterPayments |
boolean
|
|
Summary:
Description: Status
Properties:
|
Name |
Type |
Summary |
|
Success |
boolean
|
Flag to determine if the request to Data8 succeeded, regardless of result |
|
ErrorMessage |
string
|
Returned Error Message, if any |
|
CreditsRemaining |
number(float)
|
Data8 Credits Remaining for the called service |
Summary:
Description: Address
Properties:
|
Name |
Type |
Summary |
|
Address |
|
The address of the bank branch indicated by the sort code. |
Summary:
Description: The address of the bank branch indicated by the sort code.
Properties:
|
Name |
Type |
Summary |
|
Lines |
array of (string)
|
Lines |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
|
string
|
The email address you wish to validate |
|
level |
string
|
The level to which you wish to validate - please check https://www.data-8.co.uk/resources/support/service-documentation/email-validation/reference/isvalid for more information Values: [Syntax, MX, Server, Address] |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Status |
|
|
|
Result |
string
|
Contains a status code indicating if the email address could be validated. For more information on the possible status code, please read https://www.data-8.co.uk/resources/support/service-documentation/email-validation/reference/isvalid |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Success |
boolean
|
Flag to determine if the request to Data8 succeeded, regardless of result |
|
ErrorMessage |
string
|
Returned Error Message, if any |
|
CreditsRemaining |
number(float)
|
Data8 Credits Remaining for the called service |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
telephoneNumber |
string
|
The number you want to validate |
|
defaultCountry |
string
|
Formatted as numbers i.e. 44 for UK |
|
options |
|
options |
Summary:
Description: options
Properties:
|
Name |
Type |
Summary |
|
UseLineValidation |
boolean
|
If set to true then the service will use Data8 LandlineValidation on any number it recognises as a UK landline number and InternationalTelephoneValidation on all other numbers. Any validation call will be debited either an InternationalTelephoneValidation credit or a LandlineValidation credit accordingly so please ensure you have LandlineValidation credits available before using this option. The option defaults to false. |
|
UseMobileValidation |
boolean
|
If set to true then the service will use Data8 MobileValidation on any number it recognises as a mobile number and InternationalTelephoneValidation on all other numbers. Any validation call will be debited either an InternationalTelephoneValidation credit or a MobileValidation credit accordingly so please ensure you have MobileValidation credits available before using this option. The option defaults to false. |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
Status |
|
Status |
|
Result |
|
Result |
Summary:
Description: Status
Properties:
|
Name |
Type |
Summary |
|
Success |
boolean
|
Flag to determine if the request to Data8 succeeded, regardless of result |
|
ErrorMessage |
string
|
Returned Error Message, if any |
|
CreditsRemaining |
number(float)
|
Data8 Credits Remaining for the called service |
Summary:
Description: Result
Properties:
|
Name |
Type |
Summary |
|
TelephoneNumber |
string
|
The inputted telephone number formatted |
|
ValidationResult |
string
|
The simple result for the validation of the telephone number |
|
ValidationLevel |
string
|
The level of validation found for the phone number. |
|
NumberType |
string
|
Specifies the type of the number provided i.e. Landline or Mobile |
|
Location |
string
|
Current location of the telephone number if available |
|
Provider |
string
|
The network provider of the telephone number |
|
CountryCode |
string
|
Country ISO2 code of the telephone number |
|
CountryName |
string
|
Country name of the telephone number |