Share via


Cloudmersive Data Validation (Preview)

The validation APIs help you validate data. Check if an E-mail address is real. Check if a domain is real. Check up on an IP address, and even where it is located. All this and much more is available in the validation API.

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
URL https://account.cloudmersive.com/contact-support
Connector Metadata
Publisher Cloudmersive, LLC
Website https://cloudmersive.com/validate-api
Privacy policy https://cloudmersive.com/privacy-policy

This connector is critical for any data validation needs to valide email addresses, phone numbers, names, addresses, VAT numbers, and more. You can learn more at the Email Verification API page, the VAT Verification API page, or the Phone Verification API page.

To use this connector, you need a Cloudmersive account. You can sign up with a Microsoft Account or create a Cloudmersive account. Follow the steps below to get your API Key.

Get the API Key and Secret

  • Register for a Cloudmersive Account
  • Sign In with your Cloudmersive Account and click on API Keys

Here you can create and see your API key(s) listed on the API Keys page. Simply copy and paste this API Key into the Cloudmersive Data Validation Connector.

Now you are ready to start using the Cloudmersive Data Validation Connector.

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

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Fully validate an email address

Performs a full validation of the email address. Checks for syntactic correctness, identifies the mail server in question if any, and then contacts the email server to validate the existence of the account - without sending any emails.

Geolocate an IP address

Identify an IP address Country, State/Provence, City, Zip/Postal Code, etc. Useful for security and UX applications.

Get the gender of a first name

Determines the gender of a first name (given name)

Get WHOIS information for a domain

Validate whether a domain name exists, and also return the full WHOIS record for that domain name. WHOIS records include all the registration details of the domain name, such as information about the domain's owners.

Lookup a VAT code

Checks if a VAT code is valid, and if it is, returns more information about it

Parse an HTTP User-Agent string, identify robots

Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.

Parse an unstructured input text string into an international, formatted address

Uses machine learning and Natural Language Processing (NLP) to handle a wide array of cases, including non-standard and unstructured address strings across a wide array of countries and address formatting norms.

Parse and validate a full name

Parses a full name string (e.g. "Mr. Jon van der Waal Jr.") into its component parts (and returns these component parts), and then validates whether it is a valid name string or not

Validate a code identifier

Determines if the input name is a valid technical / code identifier. Configure input rules such as whether whitespace, hyphens, underscores, etc. are allowed. For example, a valid identifier might be "helloWorld" but not "hello*World".

Validate a domain name

Check whether a domain name is valid or not. API performs a live validation by contacting DNS services to validate the existence of the domain name.

Validate a first name

Determines if a string is a valid first name (given name)

Validate a last name

Determines if a string is a valid last name (surname)

Validate a URL fully

Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks. Accepts various types of input and produces a well-formed URL as output.

Validate a URL syntactically

Validate whether a URL is syntactically valid (does not check endpoint for validity). Accepts various types of input and produces a well-formed URL as output.

Validate phone number (basic)

Validate a phone number by analyzing the syntax

Fully validate an email address

Performs a full validation of the email address. Checks for syntactic correctness, identifies the mail server in question if any, and then contacts the email server to validate the existence of the account - without sending any emails.

Parameters

Name Key Required Type Description
Email address to validate, e.g. "support@cloudmersive.com". The inp...
email True string

Email address to validate, e.g. "support@cloudmersive.com". The inp...

Returns

Full email addresss validation result

Geolocate an IP address

Identify an IP address Country, State/Provence, City, Zip/Postal Code, etc. Useful for security and UX applications.

Parameters

Name Key Required Type Description
IP address to geolocate, e.g. "55.55.55.55". The input is a string so...
value True string

IP address to geolocate, e.g. "55.55.55.55". The input is a string so...

Returns

Geolocation result

Get the gender of a first name

Determines the gender of a first name (given name)

Parameters

Name Key Required Type Description
CountryCode
CountryCode string

Optional; the country for this name, possible values are "US", "LY", "NI", "TT", "MK", "KZ", "BO", "UG", "TZ", "CL", "SI", "MA", "RW", "VN", "AW", "CY", "BH", "SG", "ZA", "MU", "BR", "TN", "KH", "US", "TH", "TW", "UY", "DO", "CO", "UA", "QA", "BY", "SN", "SD", "FJ", "LB", "BE", "ML", "LV", "FR", "TM", "NG", "EC", "NO", "SL", "CR", "PA", "GE", "CH", "KR", "RS", "ZM", "FI", "BF", "MC", "AU", "GA", "LS", "RU", "IN", "SE", "LK", "BZ", "MX", "GH", "AF", "TJ", "BN", "DZ", "CM", "GR", "MD", "HN", "AT", "NZ", "SV", "GW", "NA", "AR", "MZ", "PK", "MN", "IQ", "BW", "VE", "PT", "BS", "AL", "TG", "ID", "ET", "CF", "JP", "BB", "PH", "CU", "BD", "AO", "SM", "LC", "ME", "RO", DANIL"O"", "ES", "EE", "IL", "ZW", "SY", "MW", "LU", "IR", "SC", "NL", "JO", "AM", "DE", "GL", "OM", "DK", "HR", "LI", "TD", "KM", "BA", "GM", "GD", "CA", "CZ", "MR", "ST", "IS", "LR", "IE", "VC", "AE", "KG", "DJ", "TR", "KE", "NE", "UZ", "CN", "GQ", "SK", "BJ", "MG", "BT", "EG", "PL", "IT", "SA", "MY", "CI", "AG", "AD", "KS", "HU", "CG", "KP", "DM", "GN", "GT", "NP", "JM", "LA", "GB", "BG", "HT", "PE", "AZ", "LT", "SZ", "PY", "MT", "VA"

FirstName
FirstName string

Input first name (given name) to get the gender of

Returns

Result of the GetGender operation

Get WHOIS information for a domain

Validate whether a domain name exists, and also return the full WHOIS record for that domain name. WHOIS records include all the registration details of the domain name, such as information about the domain's owners.

Parameters

Name Key Required Type Description
Domain name to check, for example "cloudmersive.com". The input is a...
domain True string

Domain name to check, for example "cloudmersive.com". The input is a...

Returns

Result of a WHOIS operation

Lookup a VAT code

Checks if a VAT code is valid, and if it is, returns more information about it

Parameters

Name Key Required Type Description
VatCode
VatCode string

VAT code to lookup; example "CZ25123891"

Returns

Parse an HTTP User-Agent string, identify robots

Uses a parsing system and database to parse the User-Agent into its structured component parts, such as Browser, Browser Version, Browser Engine, Operating System, and importantly, Robot identification.

Parameters

Name Key Required Type Description
UserAgentString
UserAgentString string

The user agent string you wish to parse and validate

Returns

The result of a User-Agent validation request

Parse an unstructured input text string into an international, formatted address

Uses machine learning and Natural Language Processing (NLP) to handle a wide array of cases, including non-standard and unstructured address strings across a wide array of countries and address formatting norms.

Parameters

Name Key Required Type Description
AddressString
AddressString string

A mailing address or street address formatted as a single text string; this will be parsed into its components

CapitalizationMode
CapitalizationMode string

Optional; indicates how the parsed output should be capitalized; default is Title Case; possible values are: "Uppercase" will set the capitalization to UPPER CASE; "Lowercase" will set the capitalization to lower case; "Titlecase" will set the capitalization to Title Case; and "Originalcase" will preserve the original casing as much as possible

Returns

Result of parsing an address into its component parts

Parse and validate a full name

Parses a full name string (e.g. "Mr. Jon van der Waal Jr.") into its component parts (and returns these component parts), and then validates whether it is a valid name string or not

Parameters

Name Key Required Type Description
FullNameString
FullNameString string

Full name to process as a free-form string; supports many components such as First Name, Middle Name, Last Name, Title, Nickname, Suffix, and Display Name

Returns

Result of a full name validation operation

Validate a code identifier

Determines if the input name is a valid technical / code identifier. Configure input rules such as whether whitespace, hyphens, underscores, etc. are allowed. For example, a valid identifier might be "helloWorld" but not "hello*World".

Parameters

Name Key Required Type Description
AllowHyphens
AllowHyphens boolean

True if hyphens are allowd in the identifier, false otherwise

AllowNumbers
AllowNumbers boolean

True if numbers are allowed in the identifier, false otherwise

AllowPeriods
AllowPeriods boolean

True if periods are allowed in the identifier, false otherwise

AllowUnderscore
AllowUnderscore boolean

True if underscores are allowed in the identifier, false otherwise

AllowWhitespace
AllowWhitespace boolean

True if whitespace is allowed in the identifier, false otherwise

Input
Input string

Text string identifier input

MaxLength
MaxLength integer

Optional; maximum length, if any, of the identifier

MinLength
MinLength integer

Optional; minimum length, if any, of the identifier

Returns

Result of performing an identifier validation operation

Validate a domain name

Check whether a domain name is valid or not. API performs a live validation by contacting DNS services to validate the existence of the domain name.

Parameters

Name Key Required Type Description
Domain name to check, for example "cloudmersive.com". The input is a ...
domain True string

Domain name to check, for example "cloudmersive.com". The input is a ...

Returns

Result of a validation operation

Validate a first name

Determines if a string is a valid first name (given name)

Parameters

Name Key Required Type Description
FirstName
FirstName string

First name to process

Returns

Result of a first name validation operation

Validate a last name

Determines if a string is a valid last name (surname)

Parameters

Name Key Required Type Description
LastName
LastName string

Last name to process

Returns

Result of a last name validation operation

Validate a URL fully

Validate whether a URL is syntactically valid (does not check endpoint for validity), whether it exists, and whether the endpoint is up and passes virus scan checks. Accepts various types of input and produces a well-formed URL as output.

Parameters

Name Key Required Type Description
URL
URL string

URL to validate

Returns

Result of validating a URL with full validation

Validate a URL syntactically

Validate whether a URL is syntactically valid (does not check endpoint for validity). Accepts various types of input and produces a well-formed URL as output.

Parameters

Name Key Required Type Description
URL
URL string

URL to validate

Returns

Result of validating a URL with syntax only

Validate phone number (basic)

Validate a phone number by analyzing the syntax

Parameters

Name Key Required Type Description
DefaultCountryCode
DefaultCountryCode string

Optional, default country code. If left blank, will default to "US".

PhoneNumber
PhoneNumber string

Raw phone number string to parse as input for validation

Returns

Result from validating a phone number

Definitions

CheckResponse

Result of a validation operation

Name Path Type Description
ValidDomain
ValidDomain boolean

True if the domain name was valid, false if it is not

FirstNameValidationResponse

Result of a first name validation operation

Name Path Type Description
Successful
Successful boolean

True if the validation operation was successful, false otherwise

ValidationResult
ValidationResult string

Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty

FullEmailValidationResponse

Full email addresss validation result

Name Path Type Description
Domain
Domain string

Domain name of the email address

IsCatchallDomain
IsCatchallDomain boolean

True if the domain is a catch-all domain name, false otherwise. Catch-all domain names, while rare, always accept inbound email to ensure they do not lose any potentially useful emails. Catch-all domain names can occassionally be configured to first accept and store all inbound email, but then later send a bounce email back to the sender after a delayed period of time.

IsDisposable
IsDisposable boolean

True if the email address is a disposable email address, false otherwise; these disposable providers are not typically used to receive email and so will have a low likelihood of opening mail sent there.

IsFreeEmailProvider
IsFreeEmailProvider boolean

True if the email domain name is a free provider (typically a free to sign up web email provider for consumers / personal use), false otherwise.

MailServerUsedForValidation
MailServerUsedForValidation string

Email server connected to for verification

ValidAddress
ValidAddress boolean

True if the email address is valid overall, false otherwise

Valid_Domain
Valid_Domain boolean

True if the domain name of the email address is valid, false otherwise. This is one component of ValidAddress, but not the only one.

Valid_SMTP
Valid_SMTP boolean

True if the email address was verified by the remote server, false otherwise. This is one component of ValidAddress, but not the only one.

Valid_Syntax
Valid_Syntax boolean

True if the syntax of the email address is valid, false otherwise. This is one component of ValidAddress, but not the only one.

FullNameValidationResponse

Result of a full name validation operation

Name Path Type Description
DisplayName
DisplayName string

The full display name of the name

FirstName
FirstName string

The first name (given name)

LastName
LastName string

The last name (surname)

MiddleName
MiddleName string

The middle name(s); if there are multiple names they will be separated by spaces

NickName
NickName string

Nickname (if supplied)

Successful
Successful boolean

True if the validation operation was successful, false otherwise

Suffix
Suffix string

Suffix to the name, e.g. "Jr." or "Sr."

Title
Title string

The person's title (if supplied), e.g. "Mr." or "Ms."

ValidationResult_FirstName
ValidationResult_FirstName string

Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty

ValidationResult_LastName
ValidationResult_LastName string

Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty

GeolocateResponse

Geolocation result

Name Path Type Description
City
City string

City of IP address

CountryCode
CountryCode string

Two-letter country code of IP address

CountryName
CountryName string

Country name of IP address

Latitude
Latitude double

Latitude of IP address

Longitude
Longitude double

Longitude of IP address

RegionCode
RegionCode string

State/region code of IP address

RegionName
RegionName string

State/region of IP address

TimezoneStandardName
TimezoneStandardName string

Timezone of IP address

ZipCode
ZipCode string

Zip or postal code of IP address

GetGenderResponse

Result of the GetGender operation

Name Path Type Description
Gender
Gender string

Gender for this name; possible values are Male, Female, and Neutral (can be applied to Male or Female)

Successful
Successful boolean

True if successful, false otherwise

LastNameValidationResponse

Result of a last name validation operation

Name Path Type Description
Successful
Successful boolean

True if the validation operation was successful, false otherwise

ValidationResult
ValidationResult string

Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty

ParseAddressResponse

Result of parsing an address into its component parts

Name Path Type Description
Building
Building string

The name of the building, house or structure if applicable, such as "Cloudmersive Building 2". This will often by null.

City
City string

The city of the address.

Country
Country string

Country of the address, if present in the address. If not included in the address it will be null.

PostalCode
PostalCode string

The postal code or zip code of the address.

StateOrProvince
StateOrProvince string

The state or province of the address.

Street
Street string

The name of the street or road of the address. For example, in the address "1600 Pennsylvania Avenue NW" the street number would be "Pennsylvania Avenue NW".

StreetNumber
StreetNumber string

The street number or house number of the address. For example, in the address "1600 Pennsylvania Avenue NW" the street number would be "1600". This value will typically be populated for most addresses.

Successful
Successful boolean

True if the parsing operation was successful, false otherwise

PhoneNumberValidationResponse

Result from validating a phone number

Name Path Type Description
CountryCode
CountryCode string

Two digit country code of the phone number

CountryName
CountryName string

User-friendly long name of the country for the phone number

E164Format
E164Format string

E.164 format of the phone number

InternationalFormat
InternationalFormat string

Internaltional format of the phone number

IsValid
IsValid boolean

True if the phone number is valid, false otherwise

NationalFormat
NationalFormat string

National format of the phone number

PhoneNumberType
PhoneNumberType string

Type of phone number; possible values are: FixedLine, Mobile, FixedLineOrMobile, TollFree, PremiumRate, SharedCost, Voip, PersonalNumber, Pager, Uan, Voicemail, Unknown

Successful
Successful boolean

True if the operation was successful, false if there was an error during validation. See IsValid for validation result.

UserAgentValidateResponse

The result of a User-Agent validation request

Name Path Type Description
BotName
BotName string

Optional; name of the robot if the request was from a known robot, otherwise null

BotURL
BotURL string

Optional; if available, the URL to the robot

BrowserEngineName
BrowserEngineName string

Name of the Browser Engine

BrowserEngineVersion
BrowserEngineVersion string

Version of the Browser Engine

BrowserName
BrowserName string

Name of the Browser

BrowserVersion
BrowserVersion string

Version of the Browser

DeviceBrandName
DeviceBrandName string

Brand name of the User-Agent

DeviceModel
DeviceModel string

Model name or number of the User-Agent

DeviceType
DeviceType string

Device type of the User-Agent; possible values are "DESKTOP", "SMARTPHONE", "TABLET"

IsBot
IsBot boolean

True if the request is a known robot, false otherwise

OperatingSystem
OperatingSystem string

Operating System of the User-Agent (e.g. Windows)

OperatingSystemCPUPlatform
OperatingSystemCPUPlatform string

The CPU platform of the User-Agent (e.g. x64)

OperatingSystemVersion
OperatingSystemVersion string

The version of the operating system of the User-Agent (e.g. "10" for Windows 10)

Successful
Successful boolean

True if the operation was successful, false otherwise

ValidateIdentifierResponse

Result of performing an identifier validation operation

Name Path Type Description
Error
Error string

Resulting error from the identifier validation; possible errors are: "InputIsEmpty", "ContainsWhitespace", "ContainsNumbers", "ContainsHyphen", "ContainsUnderscore", "ContainsPeriod", "TooShort", "TooLong", "ContainsSpecialCharacters"

ValidIdentifier
ValidIdentifier boolean

True if the input identifier is valid, false otherwise

ValidateUrlResponseFull

Result of validating a URL with full validation

Name Path Type Description
ValidURL
ValidURL boolean

True if the URL has valid syntax, a valid domain, a valid endpoint, and passes virus scan checks; false otherwise

Valid_Domain
Valid_Domain boolean

True if the domain name is valid and exists, false otherwise

Valid_Endpoint
Valid_Endpoint boolean

True if the endpoint is up and responsive and passes a virus scan check, false otherwise

Valid_Syntax
Valid_Syntax boolean

True if the URL has valid syntax, false otherwise

WellFormedURL
WellFormedURL string

Well-formed version of the URL

ValidateUrlResponseSyntaxOnly

Result of validating a URL with syntax only

Name Path Type Description
ValidURL
ValidURL boolean

True if the URL is valid, false otherwise

WellFormedURL
WellFormedURL string

Well-formed version of the URL

VatLookupResponse

Name Path Type Description
BusinessAddress
BusinessAddress string

Business address

BusinessName
BusinessName string

Name of the business

CountryCode
CountryCode string

Two-letter country code

IsValid
IsValid boolean

True if the VAT code is valid, false otherwise

VatNumber
VatNumber string

VAT number

WhoisResponse

Result of a WHOIS operation

Name Path Type Description
CreatedDt
CreatedDt date-time

Creation date for the record

RawTextRecord
RawTextRecord string

WHOIS raw text record

ValidDomain
ValidDomain boolean

True if the domain is valid, false if it is not

WhoisServer
WhoisServer string

Server used to lookup WHOIS information (may change based on lookup).