Data8 Data Enrichment

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.

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 Technical Helpdesk
URL https://www.data-8.co.uk
Email helpdesk@data-8.co.uk
Connector Metadata
Publisher Data8 Limited
Website https://www.data-8.co.uk
Privacy Policy https://www.data-8.co.uk/privacy-policy/
Categories AI;Website

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.

Pre-requisites

You will need the following to proceed:

  • A Microsoft Power Automate plan with premium connector feature
  • A Data8 account
  • A Data8 API key
  • Credits for the application Data8 service

Getting a Data8 account

Register for a new Data8 account Once you have a Data8 account, please contact us and let us know which services you like to trial Sign In to get your API key and create a "Server Side" API key

Support and documentation:

For all the support requests and general queries you can contact helpdesk@data-8.co.uk or visit contact-us

Creating a connection

The connector supports the following authentication types:

Default Parameters for creating connection. All regions Not shareable

Default

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 securestring The API Key for this api True

Throttling Limits

Name Calls Renewal Period
API calls per connection10060 seconds

Actions

Check Usable Name

Using this action, you can check if a name is a real usable name or whether it is salacious, random or blank.

Clean Address

Formats, verifies and corrects a given address into a full formatted address.

CTPS Check

Checks if a telephone number is registered on the CTPS or not.

Get Full Address

Searches for an addresses based on input data such as building number and postcode

Is Deceased

UK - Identify deceased individuals quickly and easily, using credible sources updated on a regular basis.

PredictiveAddress (Drilldown)

DrillDown with the Data8 PredictiveAddress API - Drill down further into search results

PredictiveAddress (Retrieve)

Retrieve with the Data8 PredictiveAddress API - Retrieve the full address

PredictiveAddress (Search)

Searching with the Data8 PredictiveAddress API - Search for a partial address in our many data sources

TPS Check

Checks if a telephone number is registered on the TPS or not.

Validate Bank Account Information

Check if a sort code and bank account number are valid.

Validate Email Address

Checks to see if an inputted email address is valid to receive email

Validate Telephone Number

Checks to see if an inputted email address is valid to receive email

Check Usable Name

Using this action, you can check if a name is a real usable name or whether it is salacious, random or blank.

Parameters

Name Key Required Type Description
Title
Title string

The title of the name

First name
Forename string

The first name of the full name

Middle name
MiddleName string

The middle name of the full name

Last name
Surname string

The last name of the full name

Returns

Name Path Type Description
Success
Status.Success boolean

Flag to determine if the request to Data8 succeeded, regardless of result

Error Message
Status.ErrorMessage string

Returned Error Message, if any

Credits Remaining
Status.CreditsRemaining float

Data8 Credits Remaining for the called service

Result
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"

Clean Address

Formats, verifies and corrects a given address into a full formatted address.

Parameters

Name Key Required Type Description
Address Lines
Lines string
Default Country Code
DefaultCountryCode string

An ISO 2 character code for the country to assume the address is in unless otherwise specified. This defaults to GB.

Auto Detect Country
DetectCountry boolean

Set to true to attempt to automatically detect the country from the provided address information, possibly overriding the default country

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"

Include Country
IncludeCountry boolean

Includes the CountryName field in the main part of the result

Returns

Name Path Type Description
Success
Status.Success boolean

Flag to determine if the request to Data8 succeeded, regardless of result

Error Message
Status.ErrorMessage string

Returned Error Message, if any

Credits Remaining
Status.CreditsRemaining float

Data8 Credits Remaining for the called service

Lines
Result.Address.Lines array of string

Lines

Match Level
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

Country Name
CountryName string

Contains the name of the country the address is in.

CTPS Check

Checks if a telephone number is registered on the CTPS or not.

Parameters

Name Key Required Type Description
Telephone Number
number True string

The telephone number you wish to CTPS check

Returns

Name Path Type Description
Success
Status.Success boolean

Flag to determine if the request to Data8 succeeded, regardless of result

Error Message
Status.ErrorMessage string

Returned Error Message, if any

Credits Remaining
Status.CreditsRemaining float

Data8 Credits Remaining for the called service

Is Callable
Callable boolean

Returns a boolean value letting you know if it's callable. If false, the number is currently on the CTPS.

Telephone Number
TelephoneNumber string

If populated, the telephone number is callable and null if not

Get Full Address

Searches for an addresses based on input data such as building number and postcode

Parameters

Name Key Required Type Description
License
licence True 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

Postcode
postcode True 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
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.

FixTownCounty
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
MaxLines integer

The number of lines to format the address over. An additional line will be included in the result for the postcode.

MaxLineLength
MaxLineLength integer

The maximum number of characters that can appear in each address line.

NormalizeCase
NormalizeCase boolean

Converts all text in the address except the town name to proper case.

NormalizeTownCase
NormalizeTownCase boolean

Converts the town name to proper case

ExcludeCounty
ExcludeCounty boolean

Excludes the county, if any, from the formatted address

UseAnyAvailableCounty
UseAnyAvailableCounty boolean

Uses any available county to populate the formatted address, not just the postal county

UnwantedPunctuation
UnwantedPunctuation boolean

A string containing any punctuation characters to be removed from the formatted address

FixBuilding
FixBuilding boolean

Ensures the building name/number is always placed in the first line

IncludeUDPRN
IncludeUDPRN boolean

Set to true to have the UniqueReference field of each returned address populated with the UDPRN

IncludeLocation
IncludeLocation boolean

Set to true to have the Location field of each returned address populated with the geocoding details for the address

ReturnResultCount
ReturnResultCount boolean

Indicates if the ResultCount field in the result should be populated with the total number of addresses returned.

IncludeNYB
IncludeNYB boolean

Set to true to include addresses from the Not Yet Built database in the results (requires additional licensing)

IncludeMR
IncludeMR boolean

Set to true to include addresses from the Multiple Residency database in the results (requires additional licensing)

Formatter
Formatter string

Pick from one of the available formatters to control how the raw address is converted into a human-readable address

Returns

Name Path Type Description
Success
Status.Success boolean

Success

ErrorMessage
Status.ErrorMessage string

Error Message (if applicable)

CreditsRemaining
Status.CreditsRemaining float

Credits Remaining

Contains the number of addresses in the Results field. This field is only populated if the ReturnResultCount option is set to true
ResultCount integer
Results
Results array of object

Results

Lines
Results.Address.Lines array of string

Formatted Address Lines

Organisation
Results.RawAddress.Organisation string

Organisation

Department
Results.RawAddress.Department string

Department

AddressKey
Results.RawAddress.AddressKey integer

Address Key

OrganisationKey
Results.RawAddress.OrganisationKey integer

Organisation Key

PostcodeType
Results.RawAddress.PostcodeType string

Postcode Type

BuildingNumber
Results.RawAddress.BuildingNumber integer

Building Number

SubBuildingName
Results.RawAddress.SubBuildingName string

Sub Building Name

BuildingName
Results.RawAddress.BuildingName string

Building Name

DependentThoroughfareName
Results.RawAddress.DependentThoroughfareName string

Dependent Thoroughfare Name

DependentThoroughfareDesc
Results.RawAddress.DependentThoroughfareDesc string

Dependent Thoroughfare Desc

ThoroughfareName
Results.RawAddress.ThoroughfareName string

Thoroughfare Name

ThoroughfareDesc
Results.RawAddress.ThoroughfareDesc string

Thoroughfare Desc

DoubleDependentLocality
Results.RawAddress.DoubleDependentLocality string

Double Dependent Locality

DependentLocality
Results.RawAddress.DependentLocality string

Dependent Locality

Locality
Results.RawAddress.Locality string

Locality

Postcode
Results.RawAddress.Postcode string

Postcode

Dps
Results.RawAddress.Dps string

DPS

PoBox
Results.RawAddress.PoBox string

PO Box

PostalCounty
Results.RawAddress.PostalCounty string

Postal County

TraditionalCounty
Results.RawAddress.TraditionalCounty string

Traditional County

AdministrativeCounty
Results.RawAddress.AdministrativeCounty string

Administrative County

CountryISO2
Results.RawAddress.CountryISO2 string

Country ISO2

UniqueReference
Results.RawAddress.UniqueReference string

Unique Reference

Easting
Results.RawAddress.Location.Easting integer

Easting

Northing
Results.RawAddress.Location.Northing integer

Northing

GridReference
Results.RawAddress.Location.GridReference string

GridReference

Longitude
Results.RawAddress.Location.Longitude float

Longitude

Latitude
Results.RawAddress.Location.Latitude float

Latitude

CountyCode
Results.RawAddress.Location.CountyCode string

CountyCode

County
Results.RawAddress.Location.County string

County

DistrictCode
Results.RawAddress.Location.DistrictCode string

DistrictCode

District
Results.RawAddress.Location.District string

District

WardCode
Results.RawAddress.Location.WardCode string

WardCode

Ward
Results.RawAddress.Location.Ward string

Ward

Country
Results.RawAddress.Location.Country string

Country

Is Deceased

UK - Identify deceased individuals quickly and easily, using credible sources updated on a regular basis.

Parameters

Name Key Required Type Description
Title
Title string

The title of the name to search

Forename
Forename string

The firstname of the name to search

Middle Name
MiddleName string

The middle name of the name to search

Surname
Surname True string

The surname of the name to search

Address Lines
Lines string

A string away of the address elements

Marketing
marketing True boolean

A boolean to determine if the search is being done for marketing reasons or not.

Match Level
MatchLevel string

The minimum match level between the name supplied in the input record and the name in our reference data files. S is Surname, I is Initial and F is Forename

Returns

Name Path Type Description
Success
Status.Success boolean

Success

ErrorMessage
Status.ErrorMessage string

Error Message (if applicable)

CreditsRemaining
Status.CreditsRemaining float

Credits Remaining

Is Deceased
Result boolean

Indicates if the person is found to be deceased

PredictiveAddress (Drilldown)

DrillDown with the Data8 PredictiveAddress API - Drill down further into search results

Parameters

Name Key Required Type Description
Country
country True string

The ISO 2-character country code of the search i.e. "GB"

Id
id True string

The value property from the response of previous requests from either the Search or DrillDown methods should be supplied here.

IncludeMR
IncludeMR boolean

Includes addresses from the Multiple Residency database in the results (requires additional licensing).

IncludeNYB
IncludeNYB boolean

Includes addresses from the Not Yet Built database in the results (requires additional licensing).

Returns

Name Path Type Description
Success
Status.Success boolean

Flag to determine if the request to Data8 succeeded, regardless of result

Error Message
Status.ErrorMessage string

Returned Error Message, if any

Credits Remaining
Status.CreditsRemaining float

Data8 Credits Remaining for the called service

Results
Results array of object

Results

Label
Results.label string

The value to show to the user.

Value
Results.value string

A unique identifier for the match that can be supplied to the DrillDown or Retrieve endpoints.

Container
Results.container boolean

Indicates if this match is a container for other addresses (e.g. a town, street etc.). If this is true, the value should be supplied to the DrillDown endpoint to get the details of the addresses in the container record. If it is false, the value should be supplied to the Retrieve endpoint to get the full details of the address.

Items
Results.items integer

A list of possible matches.

Count
Count integer

The number of matches found based on the information provided.

SessionID
SessionID string

A SessionID is also included in the response. This should be included in any subsequent calls to the Search endpoint.

PredictiveAddress (Retrieve)

Retrieve with the Data8 PredictiveAddress API - Retrieve the full address

Parameters

Name Key Required Type Description
Country
country True string

The ISO-2 country code in which the address belongs.

Id
id True string

The value property from the response of previous requests from either the Search or DrillDown methods, when the container property was false, should be supplied here.

MaxLineLength
MaxLineLength integer

MaxLineLength

MaxLines
MaxLines integer

MaxLines

FixTownCounty
FixTownCounty boolean

FixTownCounty

FixPostcode
FixPostcode boolean

FixPostcode

Fix Building
FixBuilding boolean

FixBuilding

UnwantedPunctuation
UnwantedPunctuation string

UnwantedPunctuation

Formatter
Formatter string

Formatter

IncludeUDPRN
IncludeUDPRN boolean

IncludeUDPRN

IncludeUPRN
IncludeUPRN boolean

IncludeUPRN

Returns

Name Path Type Description
Success
Status.Success boolean

Flag to determine if the request to Data8 succeeded, regardless of result

Error Message
Status.ErrorMessage string

Returned Error Message, if any

Credits Remaining
Status.CreditsRemaining float

Data8 Credits Remaining for the called service

Lines
Result.Address.Lines array of string

Lines

Organisation
Result.RawAddress.Organisation string

The name of the company at the address

Department
Result.RawAddress.Department string

The department within the organisation at the address

Address Key
Result.RawAddress.AddressKey integer

Combines with OrganisationKey and PostcodeType to provide a unique key for this address

OrganisationKey
Result.RawAddress.OrganisationKey integer

Combines with AddressKey and PostcodeType to provide a unique key for this address. Will be 0 for residential addresses

PostcodeType
Result.RawAddress.PostcodeType string

Indicates if the address is on a "small user" ("S") or "large user" ("L"). A large user postcode is one that is allocated to an individual organisation as a heavy mail user, e.g. DVLA

BuildingNumber
Result.RawAddress.BuildingNumber integer

The house number for the address. Note that this is an integer number only. Building numbers such as 12A will be shown in the BuildingName field

SubBuildingName
Result.RawAddress.SubBuildingName string

The name of the sub-building for the address. This is typically a flat or apartment number

BuildingName
Result.RawAddress.BuildingName string

The name of the building. May include number information where the number is not a simple integer

DependentThoroughfareName
Result.RawAddress.DependentThoroughfareName string

The name of the dependent thoroughfare, i.e. a smaller street off a larger street

DependentThoroughfareDesc
Result.RawAddress.DependentThoroughfareDesc string

The descriptor ("street", "road" etc.) of the dependent thoroughfare

ThoroughfareName
Result.RawAddress.ThoroughfareName string

The name of the main street

ThoroughfareDesc
Result.RawAddress.ThoroughfareDesc string

The descriptor of the main street

DoubleDependentLocality
Result.RawAddress.DoubleDependentLocality string

The name of the double-dependent locality - the third-level locality

DependentLocality
Result.RawAddress.DependentLocality string

The name of the dependent locality - the second level locality

Locality
Result.RawAddress.Locality string

The name of the top-level postal town

Postcode
Result.RawAddress.Postcode string

The postcode in a fixed 7-character format

DPS
Result.RawAddress.Dps string

The 2-character delivery point suffix that uniquely identifies the address within the postcode

PoBox
Result.RawAddress.PoBox string

The details of the PO Box if the address is a PO Box address

PostalCounty
Result.RawAddress.PostalCounty string

The county name that should appear in the address

TraditionalCounty
Result.RawAddress.TraditionalCounty string

The county name that was traditionally associated with the address but is not now postally required

AdministrativeCounty
Result.RawAddress.AdministrativeCounty string

The county that the address is in for administrative purposes but is not postally required

CountryISO2
Result.RawAddress.CountryISO2 string

The 2-character ISO country code related to the address. This is not populated by the AddressCapture service

UniqueReference
Result.RawAddress.UniqueReference string

An alternative unique reference number for the address. This is set to the UDPRN number of the address by supplying the IncludeUDPRN option to the method

Easting
Result.RawAddress.Location.Easting integer

The distance of the postcode east of the OS grid origin to the southwest of Scilly

Northing
Result.RawAddress.Location.Northing integer

The distance of the postcode north of the OS grid origin

GridReference
Result.RawAddress.Location.GridReference string

The location of the postcode as a 6-digit OS grid reference

Longitude
Result.RawAddress.Location.Longitude float

The longitude of the postcode expressed in decimal degrees in the WGS84 datum

Latitude
Result.RawAddress.Location.Latitude float

The latitude of the postcode expressed in decimal degrees in the WGS84 datum

CountyCode
Result.RawAddress.Location.CountyCode string

The county code that should appear in the address

County
Result.RawAddress.Location.County string

The county name that should appear in the address

DistrictCode
Result.RawAddress.Location.DistrictCode string

The district code that should appear in the address

District
Result.RawAddress.Location.District string

The district that should appear in the address

WardCode
Result.RawAddress.Location.WardCode string

The reference code for the ward the postcode is in

Ward
Result.RawAddress.Location.Ward string

The name of the electoral ward the postcode is in

Country
Result.RawAddress.Location.Country string

The 2-character ISO country code related to the address.

Additional Data
Result.RawAddress.AdditionalData string

Any additional data returned

PredictiveAddress (Search)

Searching with the Data8 PredictiveAddress API - Search for a partial address in our many data sources

Parameters

Name Key Required Type Description
Country
country True string

The ISO-2 country code in which the address belongs.

Search
search True string

The partial address entered by the user.

TelephoneNumber
telephoneNumber string

An optional parameter, the telephone number associated with the address can be supplied.

Session
session string

The session id that was received in the previous response. This improves efficiency and lookup speeds. This should be included in any subsequent calls to the Search endpoint.

IncludeMR
IncludeMR boolean

Includes addresses from the Multiple Residency database in the results (requires additional licensing).

IncludeNYB
IncludeNYB boolean

Includes addresses from the Not Yet Built database in the results (requires additional licensing).

Returns

Name Path Type Description
Success
Status.Success boolean

Flag to determine if the request to Data8 succeeded, regardless of result

Error Message
Status.ErrorMessage string

Returned Error Message, if any

Credits Remaining
Status.CreditsRemaining float

Data8 Credits Remaining for the called service

Results
Results array of object

Results

Label
Results.label string

The value to show to the user.

value
Results.value string

value

Container
Results.container boolean

Indicates if this match is a container for other addresses (e.g. a town, street etc.). If this is true, the value should be supplied to the DrillDown endpoint to get the details of the addresses in the container record. If it is false, the value should be supplied to the Retrieve endpoint to get the full details of the address.

Items
Results.items integer

A list of possible matches.

Count
Count integer

Count

SessionID
SessionID string

A SessionID is also included in the response. This should be included in any subsequent calls to the Search endpoint.

TPS Check

Checks if a telephone number is registered on the TPS or not.

Parameters

Name Key Required Type Description
Telephone Number
number True string

The telephone number you want to TPS check

Returns

Name Path Type Description
Success
Status.Success boolean

Flag to determine if the request to Data8 succeeded, regardless of result

Error Message
Status.ErrorMessage string

Returned Error Message, if any

Credits Remaining
Status.CreditsRemaining float

Data8 Credits Remaining for the called service

Is Callable
Callable boolean

Returns a boolean value letting you know if it's callable. If false, the number is currently on the TPS.

Telephone Number
TelephoneNumber string

Returns the telephone number if callable, null if not.

Validate Bank Account Information

Check if a sort code and bank account number are valid.

Parameters

Name Key Required Type Description
Sort Code
sortCode True string

The sort code you wish to validate

Bank Account Number
bankAccountNumber string

The bank account number you wish to validate

Returns

Name Path Type Description
Success
Status.Success boolean

Flag to determine if the request to Data8 succeeded, regardless of result

Error Message
Status.ErrorMessage string

Returned Error Message, if any

Credits Remaining
Status.CreditsRemaining float

Data8 Credits Remaining for the called service

Valid
Valid string

Indicates if the incoming sort code and bank account number could be validated.

Sort Code
SortCode string

The sort code that has been validated.

Account Number
AccountNumber string

The account number that has been validated.

BIC Code
BICCode string

The BIC code of the bank branch indicated by the sort code.

IBAN
IBAN string

The IBAN code of the bank account indicated by the sort code and account number.

Branch Name
BranchName string

The name of the bank branch indicated by the sort code.

Short Bank Name
ShortBankName string

A short name for the bank indicated by the sort code.

Full Bank Name
FullBankName string

The full name for the bank indicated by the sort code.

Lines
Address.Address.Lines array of string

Lines

Accepts BACS Payments
AcceptsBACSPayments boolean

Indicates if the bank branch can accept payments made through the BACS system.

Accepts Direct Debit Transactions
AcceptsDirectDebitTransactions boolean

Indicates if the bank branch can accept direct debit payments.

Accepts Direct Credit Transactions
AcceptsDirectCreditTransactions boolean

Indicates if the bank branch can accept direct credit payments.

Accepts Unpaid Cheque Claim Transactions
AcceptsUnpaidChequeClaimTransactions boolean

Indicates if the bank branch can accept claims for unpaid cheques.

Accepts Building Society Credit Transactions
AcceptsBuildingSocietyCreditTransactions boolean

Indicates if the bank branch can accept credits from building societies.

Accepts Dividend Interest Payment Transactions
AcceptsDividendInterestPaymentTransactions boolean

Indicates if the bank branch can accept dividend interest payments.

Accepts Direct Debit Instruction Transactions
AcceptsDirectDebitInstructionTransactions boolean

Indicates if the bank branch can accept direct debit instructions.

Accepts CHAPS Payments
AcceptsCHAPSPayments boolean

Indicates if the bank branch can accept payments made through the CHAPS system.

Accepts Cheques
AcceptsCheques boolean

Indicates if the bank branch can accept payments made by cheque.

Accepts Faster Payments
AcceptsFasterPayments boolean

Indicates if the bank branch can accept faster payments.

Validate Email Address

Checks to see if an inputted email address is valid to receive email

Parameters

Name Key Required Type Description
Email Address
email True string

The email address you wish to validate

Validation Level
level True 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

Returns

Name Path Type Description
Success
Status.Success boolean

Flag to determine if the request to Data8 succeeded, regardless of result

Error Message
Status.ErrorMessage string

Returned Error Message, if any

Credits Remaining
Status.CreditsRemaining float

Data8 Credits Remaining for the called service

Result
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

Validate Telephone Number

Checks to see if an inputted email address is valid to receive email

Parameters

Name Key Required Type Description
Telephone Number
telephoneNumber True string

The number you want to validate

Default Country Code
defaultCountry True string

Formatted as numbers i.e. 44 for UK

Use Line Validation
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.

Use Mobile Validation
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.

Returns

Name Path Type Description
Success
Status.Success boolean

Flag to determine if the request to Data8 succeeded, regardless of result

Error Message
Status.ErrorMessage string

Returned Error Message, if any

Credits Remaining
Status.CreditsRemaining float

Data8 Credits Remaining for the called service

Telephone Number
Result.TelephoneNumber string

The inputted telephone number formatted

Validation Result
Result.ValidationResult string

The simple result for the validation of the telephone number

Validation Level
Result.ValidationLevel string

The level of validation found for the phone number.

Number Type
Result.NumberType string

Specifies the type of the number provided i.e. Landline or Mobile

Location
Result.Location string

Current location of the telephone number if available

Provider
Result.Provider string

The network provider of the telephone number

Country Code
Result.CountryCode string

Country ISO2 code of the telephone number

Country Name
Result.CountryName string

Country name of the telephone number