共用方式為


DQ on Demand

DQ on Demand is a Data Quality as a Service (DQaaS) Data Quality Improvement Platform that is designed to make the task of data management simpler.

DQ on Demand is for those who are not prepared to accept the high cost of low-quality data, are frustrated with differing levels of quality, conflicting rules and levels of and data governance.

Billing is transactional, i.e. each request will consume credits, which can be spent on any of the available services.

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 Support
URL https://dqglobal.com/support
Email support@dqglobal.com
Connector Metadata
Publisher DQ Global
Website https://www.dqglobal.com
Privacy policy https://www.dqglobal.com/privacy-policy
Categories Data

DQ on Demand is for those who are not prepared to accept the high cost of low-quality data, are frustrated with differing levels of quality, conflicting rules and levels of and data governance.

Prerequisites

You will need the following to proceed:

  • A Microsoft Power Automate plan with premium connector feature
  • A DQ on Demand account
  • A Client Id & Client Secret
  • Credits for the service

How to get credentials

Sign up for a new account. Upon signing up your trial period will automatically start, and you will be given a small sum of credits so that you can get started straight away.

Register an application to get a Client Id & Client Secret.

Note: Make sure to set the Redirect URL to: https://global.consent.azure-apim.net/redirect

Throttling Limits

Name Calls Renewal Period
API calls per connection 2000 60 seconds

Actions

Authenticate Email

Truly confirm if your email is authentic and will deliver.

Authenticate Phone

Truly confirm if your phonenumber is authentic and will dial.

Binary To String

This will convert a Binary value into its string equivalent.

Case

Alter the casing of your data.

Classify

Identify extra information about a piece of data. E.g. Brian or Sven is a person name. Road, Strasse, Rue are address elements. Ltd, LLC are Company legal suffixes.

Collapse Adjacent Repeated Characters

The word Silly would be reduced to Sily if the maximum repeat was set to 1, as the l is repeated once. However, The word Silly would remain unchanged if the maximum repeat was set to 2, as the l is not repeated more than once. Inversely, The word Global would remain the same regardless of the maximum repeat as the l is repeated, but not consecutively.

Collapse Adjacent Repeated Type

Check and replace repeated neighbouring characters of the same type. I.E.Test$$££ -> Test$£ Note: Both the $ and the £ are counted as a symbol, but they are not the same character so did not get collapsed.

Compare

Score the similarity between two values using one of the available algorithms, including: Levenshtein, Jaro, JaroWinkler and more...

Congruence Country

Check if a value is from the country you expect.

Congruence Email

Check if an Email address matches the Contact details.

Congruence Salutation

Check if the Salutation is of the same gender as the name.

Derive Country

Derive a country from your supplied data.

Derive CountryFromCity

Retrieve a list of Countries that have the placename supplied.

Derive EmailType

Derive the Domain and Mailbox type. I.E.is it a business email? or a personal email?

Derive FromPostalCode

Return Information pertaining to the supplied PostCode, Such as: Latitude & Longitude.

Derive Gender

Derive the Gender of a person using their first name.

Ends With Type

Check if the supplied value ends with the desired character type.

EndsWith

Check if a value ends in with a specific string.

Ensure EndsWith

Check if your value ends with the desired string, if it does not it will be appended.

Ensure Starts and Ends With

Check if your value both starts with and ends with the desired string, and if not it will be prepended and or appended.

Ensure StartsWith

Check if your value starts with the desired string, if not it will be prepended.

Extract Characters

Extract a given number of characters from the start or end of a string.

Extract Words

Extract a given number of words from the start or end of a string.

Format Email

Format your email address. A common example is when an email is coped from Outlook it will return Example <example@example.com> and we will convert that to example@example.com.

Format Phone International

Format your phone number in International syntax. E.G. +44 845 790 9090

Format Phone National

Format your phone number in National syntax. E.G. 0845 790 9090

Format PhoneE164

Format your phone number in the E.164 syntax. E.G. +448457909090

Format PhoneRFC3966

Format your phone number in RFC3966 syntax. E.G. tel:+44-845-790-9090

Format PostCode

Format your Postcode so its syntactically valid for the country. I.E. SW1A1AA to SW1A 1AA

Format URL

Ensure all of your URLs are in using the same Protocols and correct common mistakes.

Generate Pattern

Generate a Pattern representation of your data. I.E. Example123 -> Aaaaaaa999

Generate Token

Generate a phonetic token of your data. Example (Using DQFonetix) Xerox = YQA, Xeroks = YQA

Hex To String

Convert a Hex input into its string equivalent.

IsAllLower

Check if a value is comprised only of lower case letters.

IsAllUpper

Check if a value is comprised only of upper case letters.

IsAlphaNumeric

Check if a value is comprised of letters and/or numbers.

IsISO2Code

Check if a value is a valid ISO3166 Alpha-2 country code. I.E.GBP, UK, FR, ES, etc.

IsISO3Code

Check if a value is a valid ISO3166 Alpha-3 country code. I.E.GBR, USA, FRA, etc.

IsISO4217CurrencyCode

Check if a value is a valid ISO4217 code. I.E. GBP, USD, EUR, etc.

IsMixedCase

Check if a value is comprised only of upper case and lower case letters.

IsNumeric

Check if a value is comprised only of numbers.

Normalize AlphaNumeric Phone

Convert letters into numbers using a phone keypad. I.E. 1-800-flowers -> 1-800-3569377

Normalize WhiteSpace

Convert whitespace within a string into a single space.

Parse Email

Split an Email into its component parts: MailBox, Domain, TLD/

Parse Phone

Split a Phonenumber into its component parts: Country, Number, Prefix, Type.

Parse URL

Split a URL into its component parts: Host, Scheme, Port, Path.

Remove Single Character Words

Remove all single characters from the input I.E. This is a test -> This is test

Remove StopWords

Filter out rudimentary ENGLISH stop words E.G. a, about, after and many more.

RemoveCharacters

Remove the specified character type from the input.

RemoveHTML

Remove all HTML Tags from the Input.

RemoveLeading

Remove the specified string from the start of a value.

Replace Adjacent Repeating Text

Check and replace repeated neighbouring characters.

Replace If EndsWith

Check the end of the supplied input for a value, if found replace the found value with the specified replacement value.

Replace If StartsWith

Check the start of the supplied input for a value, if found replace the found value with the specified replacement value.

Retain Characters

This will replace all characters in the supplied input with the replacement character, except the ones you have specified to keep.

Retrieve current balance

Retrieve your current balance.

Retrieve Function Pricing

Retrieve the current price list.

Retrieve your usage

Retrieve your usage statistics for each vendor function within the given time frame. Note: Usage statistics update every 24 hours at Midnight UTC Time.

Retrieve your usage (V2)

Retrieve your usage statistics for each vendor function within the given time frame, broken down by consuming application. Note: Usage statistics update every 24 hours at Midnight UTC Time.

Reverse

Reverse a string value. I.E. example -> elpmaxe

Scoring

Score records by choosing from a large set of record scoring options; customize your group weightings, score misaligned data and select from various data specific scoring rules.

SearchAddress - Find

Return a list of possible address matches.

SearchAddress - Retrieve

Return the address details using the ID from the Find call.

Sequence Transform

Perform multiple transformations in a single request. For Example; Elaborate Numbers and Abbreviate Addresses.

Starts With Type

Check if the supplied value starts with the desired character type.

StartsWith

Check if a value starts with a specific string.

String To Binary

Convert a string value into its Binary equivalent.

String To Hex

Convert a string value into its Hex equivalent.

Suppress Address - Deceased

Check whether a person has died. Note: At present this endpoint only supports GB data.

Suppress Address - GoneAway

Check wether a person has relocated and no longer lives at the address. Note: At present this endpoint only supports GB data.

Suppress Address - Relocated

Check whether a person has moved and retrieve their new address Note: At present this endpoint only supports GB data.

Suppress Phone - Corporate

Check whether a Corporate / Business phone number is contained within a suppression list and as such should not be called. Note: At present this endpoint only supports GB data.

Suppress Phone - Personal

Check whether a Personal phone number is contained within a suppression list and as such should not be called. Note: At present this endpoint only supports GB data.

Transform

Transform data (Abbreviate, Elaborate, Exclude or Normalize) in 5 spoken languages. Choose from 11 different transformation libraries including: Business, Countries, First Names and Addressing... e.g. Abbreviate country transform (United Kingdom to UK).

Validate DateTime

Check if your DateTime values are in the syntax you expect.

Validate Email

Check the syntactical validity of an Email Address.

Validate Phone

Check the syntactical validity of a PhoneNumber.

Validate PostCode

Check the syntactical validity of a PostCode.

Validate URL

Check the syntactical validity of a URL.

ValidatePlus Email

Check the syntactical validity of an Email Address.

ValidatePlus PostCode

Check the syntactical validity of a PostCode.

ValidatePlus URL

Check the syntactical validity of a URL.

Verify Address

Check your address is deliverable by verifying it against a set of reference data.

Authenticate Email

Truly confirm if your email is authentic and will deliver.

Parameters

Name Key Required Type Description
Provider
Provider True string

The Provider to use.

Email
Email True string

The Email address to authenticate.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

emailAddress
data.emailAddress string

The Email that was supplied.

domainPart
data.domainPart string

The Domain part of the Email. I.E.Bob.Smith@Example.com -> Example.com

isCorporate
data.isCorporate boolean

Is the supplied email a business email or from a free email provider (hotmail, gmail, etc)

isDisposable
data.isDisposable boolean

Is the supplied email address a disposable mailbox.

isRoleBased
data.isRoleBased boolean

Is the Local part of the email role based (support, sales, marketing, etc)

localPart
data.localPart string

The Local part of the Email. I.E.Bob.Smith@Example.com -> Bob.Smith

result
data.result boolean

Authentication Result.

additionalInfo
data.additionalInfo object

Dictionary of additional fields returned by the provider.

Authenticate Phone

Truly confirm if your phonenumber is authentic and will dial.

Parameters

Name Key Required Type Description
Provider
Provider True string

The Provider to use.

Phone
Phone True string

The Phone number to authenticate.

Country Identifier
CountryIdentifier True string

A Country Identifier (GB, GBR, United Kingdom, etc). Note: Only required if the provided phone number is not in international format. (starting with +)

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

numberType
data.numberType string

The Type of number provided.

isO2
data.isO2 string

ISO 3166-1 alpha-2 country code.

isO3
data.isO3 string

ISO 3166-1 alpha-3 country code.

dialingCode
data.dialingCode string

Country Telephone Prefix.

nationalFormat
data.nationalFormat string

The Phonenumber in National Format.

result
data.result boolean

Authentication Result.

additionalInfo
data.additionalInfo object

Dictionary of additional fields returned by the provider.

Binary To String

This will convert a Binary value into its string equivalent.

Parameters

Name Key Required Type Description
Input
Input True string

The value to convert.

Returns

Body
DQGlobal

Case

Alter the casing of your data.

Parameters

Name Key Required Type Description
Input
Input True string

The value to submit for casing.

Casing Type
CaseType True string

The type of casing to perform.

Language
Language True string

The language your data is in.

Returns

Body
DQGlobal

Classify

Identify extra information about a piece of data. E.g. Brian or Sven is a person name. Road, Strasse, Rue are address elements. Ltd, LLC are Company legal suffixes.

Parameters

Name Key Required Type Description
Input
Input True string

The value to classify.

Categories
Categories True csv

A comma separated list of the categories that to test against.

Language
Language string

The language your data is in.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data ClassifyResponse

The response.

Collapse Adjacent Repeated Characters

The word Silly would be reduced to Sily if the maximum repeat was set to 1, as the l is repeated once. However, The word Silly would remain unchanged if the maximum repeat was set to 2, as the l is not repeated more than once. Inversely, The word Global would remain the same regardless of the maximum repeat as the l is repeated, but not consecutively.

Parameters

Name Key Required Type Description
Input
Input True string

The value to be altered.

Collapse Numbers?
collapseNumerics True boolean

Include Numbers in the check?

Maximum Repeats
maximumRepeat integer

Maximum Number of repeated characters allowed before collapsing.

Returns

Body
DQGlobal

Collapse Adjacent Repeated Type

Check and replace repeated neighbouring characters of the same type. I.E.Test$$££ -> Test$£ Note: Both the $ and the £ are counted as a symbol, but they are not the same character so did not get collapsed.

Parameters

Name Key Required Type Description
Input
Input True string

The value to be altered.

Maximum Repeats
MaximumRepeat True integer

Maximum Number of repeated characters allowed before collapsing.

Character Type
type True string

The character type to check for.

Returns

Body
DQGlobal

Compare

Score the similarity between two values using one of the available algorithms, including: Levenshtein, Jaro, JaroWinkler and more...

Parameters

Name Key Required Type Description
Input 1
Input1 True string

The first value to compare.

Input 2
Input2 True string

The second value to compare.

Comparison Algorithm
ComparisonAlgorithm True string

The name of the algorithm to use for comparison.

Returns

Congruence Country

Check if a value is from the country you expect.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Country Identifier
Country True string

A Country Identifier. I.E. GB, GBR, United Kingdom etc.

Action
ActionType True string

The type of congruence to perform.

Returns

The Response.

Congruence Email

Check if an Email address matches the Contact details.

Parameters

Name Key Required Type Description
Email
Email True string

The Email to check.

First Name
FirstName True string

The First Name to look for.

Last Name
LastName True string

The Last Name to look for.

Returns

The Response.

Congruence Salutation

Check if the Salutation is of the same gender as the name.

Parameters

Name Key Required Type Description
Salutation
Salutation True string

The salutation to check.

First Name
FirstName True string

The First Name to check.

Language
Language True string

The language your data is in.

Returns

The Response.

Derive Country

Derive a country from your supplied data.

Parameters

Name Key Required Type Description
Email
Email string

The email to use for derivation.

Website
Url string

The URL to use for derivation.

Phone
Phone string

The Phone to use for derivation.

Country Identifier
Country string

The country identifier (GB, GBR, United Kingdom, etc) for derivation.

City
City string

The City to use for derivation.

Threshold
Threshold integer

The match percentage for when a possible value should be returned.

Return Highest Match?
OnlyReturnBest boolean

Return only the highest scoring result?

Default To Country?
DefaultToCountry boolean

If the Response will be Unknown then Derive using only the Country.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data array of object

A list of possible countries.

countryName
data.countryName string

Name of the derived Country.

congruentToGivenCountry
data.congruentToGivenCountry boolean

Does derived country match supplied country?

matchCertainty
data.matchCertainty integer

Certainty Score. (0-100)

isO2
data.isO2 string

ISO 3166-1 alpha-2 code of the derived country.

isO3
data.isO3 string

ISO 3166-1 alpha-3 code of the derived country.

diallingCode
data.diallingCode string

International Dialing Code of the derived country.

Derive CountryFromCity

Retrieve a list of Countries that have the placename supplied.

Parameters

Name Key Required Type Description
City
Input True string

The City for which you would like to find the country.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data array of object

The Response.

countryName
data.countryName string

Name of the derived Country.

iSO2
data.iSO2 string

ISO 3166-1 alpha-2 code of the derived country.

iSO3
data.iSO3 string

ISO 3166-1 alpha-3 code of the derived country.

iDD
data.iDD string

International Dialing Code of the derived country.

Derive EmailType

Derive the Domain and Mailbox type. I.E.is it a business email? or a personal email?

Parameters

Name Key Required Type Description
Email
Input True string

The email to use for derivation.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

domainType
data.domainType string

The Type of Domain. (Business, FreeProvider)

mailBoxType
data.mailBoxType string

The Type of Mailbox. (Personal, Generic)

Derive FromPostalCode

Return Information pertaining to the supplied PostCode, Such as: Latitude & Longitude.

Parameters

Name Key Required Type Description
Postal Code
Input True string

The postal code to check.

Country Identifier
CountryIdentifier True string

The country identifier (GB, GBR, United Kingdom, etc) of the PostalCode supplied.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

county
data.county string

The County the Postcode is located within.

latitude
data.latitude string

The Latitude of the postCode area.

longitude
data.longitude string

The Longitude of the postCode area.

Derive Gender

Derive the Gender of a person using their first name.

Parameters

Name Key Required Type Description
First Name
Input True string

The first name to try and Derive a gender from.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

gender
data.gender string

The Gender. (Female, Male, Either, Unknown)

resultCode
data.resultCode integer

A Numeric equivalent of the Gender. (0 Female, 1 Male, 2 Either, 3 Unknown)

Ends With Type

Check if the supplied value ends with the desired character type.

Parameters

Name Key Required Type Description
Input
Input True string

The value to be checked.

Character Type
type True string

The character type to check for.

Returns

EndsWith

Check if a value ends in with a specific string.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Look For
checkfor True string

The value to check for.

Returns

Ensure EndsWith

Check if your value ends with the desired string, if it does not it will be appended.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Look For
checkFor True string

Value you want at the end.

Returns

Body
DQGlobal

Ensure Starts and Ends With

Check if your value both starts with and ends with the desired string, and if not it will be prepended and or appended.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Look For
checkFor True string

The value to look for.

Returns

Body
DQGlobal

Ensure StartsWith

Check if your value starts with the desired string, if not it will be prepended.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Look For
checkFor True string

The value you want at the start.

Returns

Body
DQGlobal

Extract Characters

Extract a given number of characters from the start or end of a string.

Parameters

Name Key Required Type Description
Input
Input True string

The value to extract from.

Extract Length
extractLength True integer

The Number of characters to extract.

Extract Location
extractFrom True string

Where in the value should the extraction happen.

Returns

Body
DQGlobal

Extract Words

Extract a given number of words from the start or end of a string.

Parameters

Name Key Required Type Description
Input
Input True string

The value to extract from.

Extract Length
extractLength True integer

The Number of words to extract.

Extract Location
extractFrom True string

Where in the value should the extraction happen.

Returns

Body
DQGlobal

Format Email

Format your email address. A common example is when an email is coped from Outlook it will return Example <example@example.com> and we will convert that to example@example.com.

Parameters

Name Key Required Type Description
Email
Input True string

The Email Address to Format.

Returns

Body
DQGlobal

Format Phone International

Format your phone number in International syntax. E.G. +44 845 790 9090

Parameters

Name Key Required Type Description
Phone
Input True string

The phone number to format.

Country Identifier
CountryIdentifier True string

The country identifier (GB, GBR, United Kingdom, etc) to format against.

Returns

Body
DQGlobal

Format Phone National

Format your phone number in National syntax. E.G. 0845 790 9090

Parameters

Name Key Required Type Description
Phone
Input True string

The phone number to format.

Country Identifier
CountryIdentifier True string

The country identifier (GB, GBR, United Kingdom, etc) to format against.

Returns

Body
DQGlobal

Format PhoneE164

Format your phone number in the E.164 syntax. E.G. +448457909090

Parameters

Name Key Required Type Description
Phone
Input True string

The phone number to format.

Country Identifier
CountryIdentifier True string

The country identifier (GB, GBR, United Kingdom, etc) to format against.

Returns

Body
DQGlobal

Format PhoneRFC3966

Format your phone number in RFC3966 syntax. E.G. tel:+44-845-790-9090

Parameters

Name Key Required Type Description
Phone
Input True string

The phone number to format.

Country Identifier
CountryIdentifier True string

The country identifier (GB, GBR, United Kingdom, etc) to format against.

Returns

Body
DQGlobal

Format PostCode

Format your Postcode so its syntactically valid for the country. I.E. SW1A1AA to SW1A 1AA

Parameters

Name Key Required Type Description
Postal Code
Input True string

The Postal Code to Format.

Country Identifier
CountryIdentifier True string

The country identifier (GB, GBR, United Kingdom, etc) to format against.

Returns

Body
DQGlobal

Format URL

Ensure all of your URLs are in using the same Protocols and correct common mistakes.

Parameters

Name Key Required Type Description
Website
Input True string

The URL to Format.

URL Prefix
URLPrefix True string

The Prefix you would like to prepend to the URL.

Returns

Body
DQGlobal

Generate Pattern

Generate a Pattern representation of your data. I.E. Example123 -> Aaaaaaa999

Parameters

Name Key Required Type Description
Input
Input True string

The value to tokenize.

Exclude from Token
DoNotTokenize True array of string

List the character types not to tokenize.

CaseSensitive
CaseSensitive True boolean

Return Upper and lower letter tokens?

LetterCategories
LetterCategories True boolean

Categories letters by type? (Categories: UpperCaseVowel = V, LowerCaseVowel = v, UpperCaseConsonant = C, LowerCaseConsonant = c)

Exclude
Exclude True array of string

Exclude the following types of letters from the pattern?

Collapse
Collapse True array of string

Collapse the following types of letters in the pattern?

NumberCategories
NumberCategories True boolean

Categories numbers by type? (Categories: OddNumber = 1, EvenNumber = 2)

Exclude
Exclude True array of string

Exclude the following types of numbers from the pattern?

Collapse
Collapse True array of string

Collapse the following types of numbers in the pattern?

Exclude
Exclude True boolean

Exclude symbols from the pattern?

Collapse
Collapse True boolean

Collapse repeated symbols into a single symbol? I.E.@@ -> @

Exclude
Exclude True boolean

Exclude whitespace from the pattern?

Collapse
Collapse True boolean

Collapse multiple whitespace characters into a single character?

Exclude
Exclude True boolean

Exclude Non Printing characters from the pattern?

Collapse
Collapse True boolean

Collapse multiple Non Printing characters into a single character?

UID
UID string

The record identifier which will be echoed back to you.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data array of object
input
data.input string

The original value.

output
data.output string

The response.

uid
data.uid string

The unique identifier provided.

status
data.status integer

HTTP Status code of this item.

message
data.message string

A message describing the request status.

Generate Token

Generate a phonetic token of your data. Example (Using DQFonetix) Xerox = YQA, Xeroks = YQA

Parameters

Name Key Required Type Description
Input
Input True string

The value you with to tokenize.

Algorithm
generateAlgorithmType True string

Which Algorithm should be used?

Language
Language string

The language of your data (required when using DQFonetix, DQMetaphone, DQSoundex).

Returns

Body
DQGlobal

Hex To String

Convert a Hex input into its string equivalent.

Parameters

Name Key Required Type Description
Input
Input True string

The value to convert.

Returns

Body
DQGlobal

IsAllLower

Check if a value is comprised only of lower case letters.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Returns

IsAllUpper

Check if a value is comprised only of upper case letters.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Returns

IsAlphaNumeric

Check if a value is comprised of letters and/or numbers.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Returns

IsISO2Code

Check if a value is a valid ISO3166 Alpha-2 country code. I.E.GBP, UK, FR, ES, etc.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Returns

IsISO3Code

Check if a value is a valid ISO3166 Alpha-3 country code. I.E.GBR, USA, FRA, etc.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Returns

IsISO4217CurrencyCode

Check if a value is a valid ISO4217 code. I.E. GBP, USD, EUR, etc.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Returns

IsMixedCase

Check if a value is comprised only of upper case and lower case letters.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Returns

IsNumeric

Check if a value is comprised only of numbers.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Returns

Normalize AlphaNumeric Phone

Convert letters into numbers using a phone keypad. I.E. 1-800-flowers -> 1-800-3569377

Parameters

Name Key Required Type Description
Input
Input True string

The value to be altered.

Returns

Body
DQGlobal

Normalize WhiteSpace

Convert whitespace within a string into a single space.

Parameters

Name Key Required Type Description
Input
Input True string

The value to be altered.

Returns

Body
DQGlobal

Parse Email

Split an Email into its component parts: MailBox, Domain, TLD/

Parameters

Name Key Required Type Description
Email
Input True string

The Email to split.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

mailbox
data.mailbox string

The Input Email.

localPart
data.localPart string

The Email local part. I.E.support

domain
data.domain string

The Email Domain. I.E. gmail.com

tld
data.tld string

The Top Level Domain. I.E. .co.uk

Parse Phone

Split a Phonenumber into its component parts: Country, Number, Prefix, Type.

Parameters

Name Key Required Type Description
Phone
Input True string

The Phone number to split.

Country Identifier
CountryIdentifier True string

A Country Identifier. I.E. GB, GBR, United Kingdom etc.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

countryCode
data.countryCode string

The Country Dialing Code.

extension
data.extension string

The Extension number. (If Applicable)

nationalNumber
data.nationalNumber string

PhoneNumber supplied, formatted in National Syntax.

numberType
data.numberType string

Type of Number. I.E. Mobile, Fixed_Line, etc.

Parse URL

Split a URL into its component parts: Host, Scheme, Port, Path.

Parameters

Name Key Required Type Description
Website
Input True string

The Website to split.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

host
data.host string

The Domain name. I.E. www.example.com

scheme
data.scheme string

The Protocol used in the URL. I.E. HTTP, HTTPS, etc.

hostNameType
data.hostNameType string

The type of the host name specified in the URL.

pathAndQuery
data.pathAndQuery string

The Path and Query parameters used. I.E. http://www.example.com/Path would return /Path

port
data.port string

The Port used.

Remove Single Character Words

Remove all single characters from the input I.E. This is a test -> This is test

Parameters

Name Key Required Type Description
Input
Input True string

The value to alter.

Returns

Body
DQGlobal

Remove StopWords

Filter out rudimentary ENGLISH stop words E.G. a, about, after and many more.

Parameters

Name Key Required Type Description
Input
Input True string

The value to be altered.

Returns

Body
DQGlobal

RemoveCharacters

Remove the specified character type from the input.

Parameters

Name Key Required Type Description
Input
Input True string

The value to alter.

Character Type
characterType True string

The type of characters to remove.

Returns

Body
DQGlobal

RemoveHTML

Remove all HTML Tags from the Input.

Parameters

Name Key Required Type Description
Input
Input True string

The value to be altered.

Returns

Body
DQGlobal

RemoveLeading

Remove the specified string from the start of a value.

Parameters

Name Key Required Type Description
Input
Input True string

The value to be altered.

Value to Remove
ValToRemove True string

The value to remove.

Leave One at the start?
LeaveOneAtStart True boolean

Leave one occurrence at the start?

Returns

Body
DQGlobal

Replace Adjacent Repeating Text

Check and replace repeated neighbouring characters.

Parameters

Name Key Required Type Description
Input
Input True string

The value to alter.

Repeating Character
RepeatingValue True string

The repeating character to remove.

Replacement Character
Replacement True string

The replacement character.

Returns

Body
DQGlobal

Replace If EndsWith

Check the end of the supplied input for a value, if found replace the found value with the specified replacement value.

Parameters

Name Key Required Type Description
Input
Input True string

The value to alter.

Value to Replace
stringToReplace True string

The value to replace.

Replacement Value
replacement True string

The replacement value.

Returns

Body
DQGlobal

Replace If StartsWith

Check the start of the supplied input for a value, if found replace the found value with the specified replacement value.

Parameters

Name Key Required Type Description
Input
Input True string

The value to alter.

Value to Replace
stringToReplace True string

The value to replace.

Replacement Value
replacement True string

The replacement value.

Returns

Body
DQGlobal

Retain Characters

This will replace all characters in the supplied input with the replacement character, except the ones you have specified to keep.

Parameters

Name Key Required Type Description
Input
Input True string

The value to be altered.

Replacement Character
replacement True string

The replacement character.

Characters To Retain
charactersToRetain True string

Concatenated list of characters to retain. I.E. to retain vowels use aeiou

Returns

Body
DQGlobal

Retrieve current balance

Retrieve your current balance.

Returns

Retrieve Function Pricing

Retrieve the current price list.

Returns

Retrieve your usage

Retrieve your usage statistics for each vendor function within the given time frame. Note: Usage statistics update every 24 hours at Midnight UTC Time.

Parameters

Name Key Required Type Description
Start Time (yyyy-MM-dd HH:mm:ss.fff)
StartDate True date-time

Usage period start.

End Time (yyyy-MM-dd HH:mm:ss.fff)
EndDate True date-time

Usage period end.

Returns

Body
GetUsage

Retrieve your usage (V2)

Retrieve your usage statistics for each vendor function within the given time frame, broken down by consuming application. Note: Usage statistics update every 24 hours at Midnight UTC Time.

Parameters

Name Key Required Type Description
Start Time (yyyy-MM-dd HH:mm:ss.fff)
StartDate True date-time

Usage period start.

End Time (yyyy-MM-dd HH:mm:ss.fff)
EndDate True date-time

Usage period end.

Summarise By
SummariseBy string

Group credit usage by interval within the given period.

Returns

Body
GetUsageV2

Reverse

Reverse a string value. I.E. example -> elpmaxe

Parameters

Name Key Required Type Description
Input
Input True string

The value to be reversed.

Returns

Body
DQGlobal

Scoring

Score records by choosing from a large set of record scoring options; customize your group weightings, score misaligned data and select from various data specific scoring rules.

Parameters

Name Key Required Type Description
Is Datum?
IsDatum True boolean

Is this record the Datum / Master record. I.E. the record you will compare others against.

Record Id
UniqueId True string

The RecordId so you can identify it in the output list.

Record Source
RecordSource True string

Name of the source this record came from so you can identify it in the output list.

Group Name
GroupFieldId True string

The Group Name.

ScoringType
ScoringType True string

IntraScore: Used for groups containing data from a single field. InterScore: Used for groups containing data from multiple fields. I.E.Email1 vs Email2 vs Email3.

Scoring Method
ScoreMethod True string

What type of scoring should be performed?

Comparison Algorithm
ComparisonAlgorithm True string

Which algorithm would you like to use? Note: Our preferred algorithm is JaroWinkler

Null vs Null Match?
IsNullToNullScored boolean

When performing the comparison should an empty value vs another empty value be considered a match or not?

Null vs Value match?
IsNullToValueScored boolean

When performing the comparison should an empty value vs a populated value be considered a match or not?

Case Sensitive?
IsCaseSensitiveScore True boolean

Should casing be considered when performing the comparison?

Alpha Sequence
AlphaSequenceParameter True string

Should any alphabetical sorting be applied to your data? This helps to minimize the effect of misaligned data.

Replace Double Space With Single Space?
IsReplaceDoubleSpaceWithSingle True boolean

Should two space characters be concatenated to a single space character?

Remove All Whitespace?
IsRemoveAllWhiteSpaces True boolean

Should all whitespace characters be removed from the input? (Space, Non breaking Space, Tab, etc)

Trim String?
IsTrimString True boolean

Should whitespace at the start and end of the input be removed?

Include Punctuation?
IsIncludePunctuation True boolean

Should Punctuation be included when performing the comparison?

Include Symbols?
IsIncludeSymbols True boolean

Should Symbols be included when performing the comparison?

Include Non-Printing?
IsIncludeNonPrinting True boolean

Should Non-Printing characters be included when performing the comparison?

Include Numbers?
IsIncludeNumbers True boolean

Should Numbers be included when performing the comparison?

Include Letters?
IsIncludeAlphaChars True boolean

Should Letters be included when performing the comparison?

Apply Weighting?
IsWeightingFactorUsed True boolean

Should a weighting be applied to the result of the group? Note: Weighting value is set using the Weighting property.

Include Pre-Transformed Data For Scoring?
IsIncludeOriginalDataForScoring True boolean

Should the original input be used in the score calculation? (I.E.before any characters have been excluded).

Include Token for Scoring?
IncludeTokenForScoring True boolean

Should the Tokenized value be used in the score calculation?

Include Transforms Data for Scoring?
IncludeTransformedDataForScoring True boolean

Should the Transformed value be used in the score calculation? (I.E.after characters have been excluded).

Auto Populate TransformedValue when empty?
AutoPopulateEmptyTransformed True boolean

Auto populate the GroupValues.TransformedValue property using GroupValues.Value if GroupValues.TransformedValue is null?

Auto Populate Token when empty?
AutoPopulateEmptyToken True boolean

Auto populate the GroupValues.Token property using GroupValues.TransformedValue (after transformation) if GroupValues.Token is null?

Group Weighting
Weighting integer

Must be a number between -100 and 100. (100 = no change to the result) (A Negative weighting would be used to lower the overall score if values in that group match)

PostalCodeNChars
PostalCodeNChars integer

How many characters should be taken from the postal code? Note: Only applies when ScoreMethod is one of: PostalCodeLeftN, PostalCodeRightN.

Positive Valid Range
PositiveValidRange integer

How far above can the number go and still be valid. I.E.5 vs 10 is a positive range of 5, but 5 vs 4 is a negative range of 1. Note: Only applies when scoreMethod is one of: PostalCodeAsZip, AddressLine1WholeInput, AddressLine1Premise.

Negative Valid Range
NegativeValidRange integer

How far below can the number go and still be valid. I.E.5 vs 10 is a positive range of 5, but 5 vs 4 is a negative range of 1. Note: Only applies when scoreMethod is one of: PostalCodeAsZip, AddressLine1WholeInput, AddressLine1Premise.

Date Format
DateFormat string

What format are your Date values in?

Scoring Method
InterScoreMethodType string

What type of multi field comparison should be used?

Threshold
ThresholdValue integer

Similarity Threshold for what counts as a match. (Between 0 and 100, Default = 100)

Value
Value True string

The Original Field Value.

Transformed Value
TransformedValue string

The Transformed field value. (I.E. After whitespace, numbers, etc have been removed).

Token Value
Token string

A Tokenized representation of the data.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data array of object

List of scoring results.

datumRecordSource
data.datumRecordSource string

The RecordSource value supplied on the Input Datum record.

datumUniqueId
data.datumUniqueId string

The UniqueId value supplied on the Input Datum record.

secondaryRecordSource
data.secondaryRecordSource string

The RecordSource value supplied on the Input Secondary record.

secondaryUniqueId
data.secondaryUniqueId string

The UniqueId value supplied on the Input Secondary record.

percentageScore
data.percentageScore float

Record similarity between 0 and 100.

groupOutput
data.groupOutput array of object

List of scoring results for each field group supplied.

groupFieldID
data.groupOutput.groupFieldID string

The Group Name.

groupPercentageScore
data.groupOutput.groupPercentageScore float

The Similarity Score of the group.

warnings
data.groupOutput.warnings array of string

List of Warnings (if any) for the group.

SearchAddress - Find

Return a list of possible address matches.

Parameters

Name Key Required Type Description
Provider
Provider True string

The Provider to use.

Query
query True string

The Address to search for.

Country Identifier
CountryIdentifier True string

A CountryIdentifier (GB, GBR, 44, United Kingdom, etc) for the country to search in.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data array of object

The response.

id
data.id string

The AddressId to use in the Retrieve call.

label
data.label string

A preview of the address.

subLabel
data.subLabel string

A preview of the address.

additionalInfo
data.additionalInfo object

SearchAddress - Retrieve

Return the address details using the ID from the Find call.

Parameters

Name Key Required Type Description
Provider
Provider True string

The Provider to use.

Address Id
Id True string

The ID from the Find request.

Country Identifier
CountryIdentifier True string

A CountryIdentifier (GB, GBR, 44, United Kingdom, etc) for the country to search in.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data array of object

The response.

dqLine1
data.dqLine1 string

Line1 of the address block.

dqLine2
data.dqLine2 string

Line2 of the address block.

dqLine3
data.dqLine3 string

Line3 of the address block.

dqLine4
data.dqLine4 string

Line4 of the address block.

dqCity
data.dqCity string

The City the address is located within.

dqCounty_District
data.dqCounty_District string

The County / District the address is located within.

dqState_Province
data.dqState_Province string

The State / Province the address is located within.

dqziP_PostalCode
data.dqziP_PostalCode string

The address ZIP / PostalCode.

dqCountry
data.dqCountry string

The name of the Country the address is located within.

dqisO3
data.dqisO3 string

The ISO 3166-1 alpha-3 code of the country the address is located within.

dqisO2
data.dqisO2 string

The ISO 3166-1 alpha-2 code of the country the address is located within.

additionalInfo
data.additionalInfo object

Sequence Transform

Perform multiple transformations in a single request. For Example; Elaborate Numbers and Abbreviate Addresses.

Parameters

Name Key Required Type Description
Input
Input True string

The value to be transformed.

Category
EntityType True string

The Category to use for transforming.

Action
OperationType True string

The type of transformation to perform.

Language
Language True string

The spoken language that the value is in.

Record Id
UID string

The record identifier which will be echoed back to you.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data array of object
input
data.input string

The original value.

output
data.output string

The response.

uid
data.uid string

The unique identifier provided.

status
data.status integer

HTTP Status code of this item.

message
data.message string

A message describing the request status.

Starts With Type

Check if the supplied value starts with the desired character type.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Character Type
type True string

The character type to check for.

Returns

StartsWith

Check if a value starts with a specific string.

Parameters

Name Key Required Type Description
Input
Input True string

The value to check.

Look For
checkfor True string

The value to check for.

Returns

String To Binary

Convert a string value into its Binary equivalent.

Parameters

Name Key Required Type Description
Input
Input True string

The value to convert.

Returns

Body
DQGlobal

String To Hex

Convert a string value into its Hex equivalent.

Parameters

Name Key Required Type Description
Input
Input True string

The value to convert.

Returns

Body
DQGlobal

Suppress Address - Deceased

Check whether a person has died. Note: At present this endpoint only supports GB data.

Parameters

Name Key Required Type Description
Provider
Provider True string

The Provider to use.

Title
Title string

Salutation of the person to check.

First Name
FirstName string

First Name of the person to check.

Last Name
LastName True string

Last Name of the person to check.

Line 1
Line1 string

Address Line 1 of the person to check.

Line 2
Line2 string

Address Line 2 of the person to check.

Line 3
Line3 string

Address Line 3 of the person to check.

Town
Town string

Address Town of the person to check.

County
County string

Address County of the person to check.

Postal Code
Postcode True string

Address PostalCode of the person to check.

Country Identifier
CountryIdentifier True string

A Country Identifier (GB, GBR, United Kingdom, etc) for the address to check.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

status
data.status string

Suppression Status based on the Confidence percentage.

confidence
data.confidence double

Confident percentage that your record should be suppressed.

additionalInfo
data.additionalInfo object

Suppress Address - GoneAway

Check wether a person has relocated and no longer lives at the address. Note: At present this endpoint only supports GB data.

Parameters

Name Key Required Type Description
Provider
Provider True string

The Provider to use.

Title
Title string

Salutation of the person to check.

First Name
FirstName string

First Name of the person to check.

Last Name
LastName True string

Last Name of the person to check.

Line 1
Line1 string

Address Line 1 of the person to check.

Line 2
Line2 string

Address Line 2 of the person to check.

Line 3
Line3 string

Address Line 3 of the person to check.

Town
Town string

Address Town of the person to check.

County
County string

Address County of the person to check.

Postal Code
Postcode True string

Address PostalCode of the person to check.

Country Identifier
ISO2 True string

A Country Identifier (GB, GBR, United Kingdom, etc) for the address to check.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

status
data.status string

Suppression Status based on the Confidence percentage.

confidence
data.confidence double

Confident percentage that your record should be suppressed.

additionalInfo
data.additionalInfo object

Suppress Address - Relocated

Check whether a person has moved and retrieve their new address Note: At present this endpoint only supports GB data.

Parameters

Name Key Required Type Description
Provider
Provider True string

The Provider to use.

Title
Title string

Salutation of the person to check.

First Name
FirstName string

First Name of the person to check.

Last Name
LastName True string

Last Name of the person to check.

Line 1
Line1 string

Address Line 1 of the person to check.

Line 2
Line2 string

Address Line 2 of the person to check.

Line 3
Line3 string

Address Line 3 of the person to check.

Town
Town string

Address Town of the person to check.

County
County string

Address County of the person to check.

Postal Code
Postcode True string

Address PostalCode of the person to check.

Country Identifier
ISO2 True string

A Country Identifier (GB, GBR, United Kingdom, etc) for the address to check.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

status
data.status string

Suppression Status based on the Confidence percentage.

confidence
data.confidence double

Confident percentage that your record should be suppressed.

title
data.newAddress.title string

Title / Salutation.

forename
data.newAddress.forename string

First Name.

surname
data.newAddress.surname string

Last Name.

moveDate
data.newAddress.moveDate date-time

Move Date.

address1
data.newAddress.address1 string

Address Line1.

address2
data.newAddress.address2 string

Address Line2.

address3
data.newAddress.address3 string

Address Line3.

town
data.newAddress.town string

Address Town.

county
data.newAddress.county string

Address County.

postcode
data.newAddress.postcode string

Address Postcode.

additionalInfo
data.additionalInfo object

Suppress Phone - Corporate

Check whether a Corporate / Business phone number is contained within a suppression list and as such should not be called. Note: At present this endpoint only supports GB data.

Parameters

Name Key Required Type Description
Provider
Provider True string

The Provider to use.

Phone Number
Input True string

The phone number to check.

Country Identifier
CountryIdentifier True string

A Country Identifier (GB, GBR, United Kingdom, etc) for the suppression list to check.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

result
data.result boolean

Boolean response for if the supplied phone number was found on a suppression list.

additionalInfo
data.additionalInfo object

Suppress Phone - Personal

Check whether a Personal phone number is contained within a suppression list and as such should not be called. Note: At present this endpoint only supports GB data.

Parameters

Name Key Required Type Description
Provider
Provider True string

The Provider to use.

Phone Number
Input True string

The phone number to check.

Country Identifier
CountryIdentifier True string

A Country Identifier (GB, GBR, United Kingdom, etc) for the suppression list to check.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

result
data.result boolean

Boolean response for if the supplied phone number was found on a suppression list.

additionalInfo
data.additionalInfo object

Transform

Transform data (Abbreviate, Elaborate, Exclude or Normalize) in 5 spoken languages. Choose from 11 different transformation libraries including: Business, Countries, First Names and Addressing... e.g. Abbreviate country transform (United Kingdom to UK).

Parameters

Name Key Required Type Description
Input
Input True string

The value to be transformed.

Category
EntityType True string

The Category to use for transforming.

Action
OperationType True string

The type of transformation to be performed.

Language
Language string

The Input Language of the data you are supplying.

Returns

Body
DQGlobal

Validate DateTime

Check if your DateTime values are in the syntax you expect.

Parameters

Name Key Required Type Description
DateTime
Input True string

The datetime to be validated.

Format
DateTimeFormat True string

The expected format. Example: yyyy-mm-dd

Returns

Validate Email

Check the syntactical validity of an Email Address.

Parameters

Name Key Required Type Description
Email
Input True string

The email to validate.

Returns

Validate Phone

Check the syntactical validity of a PhoneNumber.

Parameters

Name Key Required Type Description
Phone
Input True string

The phone to be validated.

Country Identifier
CountryIdentifier True string

A Country Identifier. I.E. GB, GBR, United Kingdom etc.

Returns

Validate PostCode

Check the syntactical validity of a PostCode.

Parameters

Name Key Required Type Description
Postal Code
Input True string

The postal code to be validated.

Country Identifier
CountryIdentifier True string

A Country Identifier. I.E. GB, GBR, United Kingdom etc.

Returns

Validate URL

Check the syntactical validity of a URL.

Parameters

Name Key Required Type Description
Website
Input True string

The URL to be validated.

Returns

ValidatePlus Email

Check the syntactical validity of an Email Address.

Parameters

Name Key Required Type Description
Email
Input True string

The email to be validated.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

isValid
data.isValid boolean

Boolean value stating the validity of the supplied value.

messages
data.messages array of string

List of reasons as to why the supplied value was invalid.

ValidatePlus PostCode

Check the syntactical validity of a PostCode.

Parameters

Name Key Required Type Description
Postal Code
Input True string

The postal code to be validated.

Country Identifier
CountryIdentifier True string

A Country Identifier. I.E. GB, GBR, United Kingdom etc.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

isValid
data.isValid boolean

Boolean value stating the validity of the supplied value.

messages
data.messages array of string

List of reasons as to why the supplied value was invalid.

ValidatePlus URL

Check the syntactical validity of a URL.

Parameters

Name Key Required Type Description
Website
Input True string

The URL to validate.

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

isValid
data.isValid boolean

Boolean value stating the validity of the supplied value.

messages
data.messages array of string

List of reasons as to why the supplied value was invalid.

Verify Address

Check your address is deliverable by verifying it against a set of reference data.

Parameters

Name Key Required Type Description
Provider
Provider True string

The Provider to use.

Line 1
Line1 string

Address Line1.

Line 2
Line2 string

Address Line2.

Line 3
Line3 string

Address Line3.

Postal Code
PostalCode string

Address PostalCode.

City
City string

Address City.

State / Province
State string

Address State / Province.

Country Identifier
CountryIdentifier True string

A CountryIdentifier I.E.(GB, GBR, 44, United Kingdom, etc)

Geocode?
Geocode True boolean

Return Latitude & Longitude information if known?

Returns

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

dqLine1
data.dqLine1 string

Line1 of the address block.

dqLine2
data.dqLine2 string

Line2 of the address block.

dqLine3
data.dqLine3 string

Line3 of the address block.

dqLine4
data.dqLine4 string

Line4 of the address block.

dqCity
data.dqCity string

The city the address is located within.

dqCounty_District
data.dqCounty_District string

The County / District the address is located within.

dqState_Province
data.dqState_Province string

The State / Province the address is located within.

dqziP_PostalCode
data.dqziP_PostalCode string

The address ZIP / PostalCode.

dqCountry
data.dqCountry string

The name of the country the address is located within.

dqisO3
data.dqisO3 string

The ISO 3166-1 alpha-3 code of the country the address is located within.

dqisO2
data.dqisO2 string

The ISO 3166-1 alpha-2 code of the country the address is located within.

dqLatitude
data.dqLatitude string

The Latitude for the address.

dqLongitude
data.dqLongitude string

The Longitude for the address.

status
data.status string

The address verification status.

additionalInfo
data.additionalInfo object

Definitions

GetUsage

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

startDate
data.FilterCriteria.startDate date-time

The StartDate entered.

endDate
data.FilterCriteria.endDate date-time

The EndDate entered.

Results
data.Results array of object

A List of your usage details.

providerName
data.Results.providerName string

The name of the provider.

usage
data.Results.usage array of object

An array containing all functions for the provider and your usage for each.

functionName
data.Results.usage.functionName string

The name of the function.

creditsUsed
data.Results.usage.creditsUsed integer

The number of credits you have spent on this function.

GetUsageV2

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

startDate
data.FilterCriteria.startDate date-time

The StartDate entered.

endDate
data.FilterCriteria.endDate date-time

The EndDate entered.

Results
data.Results array of object

A List of your usage details.

providerName
data.Results.providerName string

The name of the provider.

usage
data.Results.usage array of object

An array containing all functions for the provider and your usage for each.

functionName
data.Results.usage.functionName string

The name of the function.

creditsUsed
data.Results.usage.creditsUsed integer

The number of credits you have spent on this function.

creditsUsedBy
data.Results.usage.creditsUsedBy array of object

A list of applications that have spent credits on this function and the number of credits each app has spent.

applicationName
data.Results.usage.creditsUsedBy.applicationName string

The name of the application that consumed the credits.

creditsUsed
data.Results.usage.creditsUsedBy.creditsUsed integer

The number of credits this application has spent on this function.

Summary
data.Summary array of object

A List of your usage summarised by time.

periodStart
data.Summary.periodStart date-time

The start time of the interval.

periodEnd
data.Summary.periodEnd date-time

The end time of the interval.

label
data.Summary.label string

Display label for the summarised interval.

creditsUsed
data.Summary.creditsUsed integer

The number of credits consumed within the interval.

creditsUsedBy
data.Summary.creditsUsedBy array of object

Consumption breakdown by application within the interval.

applicationName
data.Summary.creditsUsedBy.applicationName string

The name of the application that consumed the credits.

creditsUsed
data.Summary.creditsUsedBy.creditsUsed integer

The number of credits this application consumed.

GetPricesOutput

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data array of object

The Response.

providerName
data.providerName string

The name of the provider.

functions
data.functions array of object

List of Functions offered by the provider.

functionName
data.functions.functionName string

The name of the function offered.

creditCost
data.functions.creditCost integer

The cost of the function.

functionDescription
data.functions.functionDescription string

A brief description about the function.

ClassifyResponse

The response.

Name Path Type Description
addresses
addresses array of string

List of values that matched against the Address category.

numbers
numbers array of string

List of values that matched against the Number category.

givenNames
givenNames array of string

List of values that matched against the Given Name category.

businesses
businesses array of string

List of values that matched against the Business category.

businessJobTitles
businessJobTitles array of string

List of values that matched against the Job Title category.

dates
dates array of string

List of values that matched against the Dates category.

miscellaneous
miscellaneous array of string

List of values that matched against the Miscellaneous category.

weightsAndMeasures
weightsAndMeasures array of string

List of values that matched against the Weights and Measurements category.

qualifications
qualifications array of string

List of values that matched against the Qualifications category.

salutations
salutations array of string

List of values that matched against the Salutations category.

countries
countries array of string

List of values that matched against the Countries category.

familyNames
familyNames array of string

List of values that matched against the Family Name category.

salacious
salacious array of string

List of values that matched against the Salacious category.

CongruenceResultSingle

The Response.

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

congruenceString
data.congruenceString string

Description about what type of congruence was found.

code
data.code string

Code for what type of congruence was found.

DQGlobal

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data string

The response.

DQGlobalInt

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data integer

The response.

DQGlobalFloat

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data float

The response.

DQGlobalBool

Name Path Type Description
status
status integer

The HTTP Status code of the response.

message
message string

A message describing the request status.

data
data boolean

The response.