Connectors Reference
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.
|
Status: Preview |
Tier: Premium |
Version: v1 |
|
Name |
Summary |
|
Parse an unstructured input text string into an international, formatted address |
|
|
Validate a domain name |
|
|
Validate a URL fully |
|
|
Validate a URL syntactically |
|
|
Get WHOIS information for a domain |
|
|
Fully validate an email address |
|
|
Geolocate an IP address |
|
|
Validate a first name |
|
|
Parse and validate a full name |
|
|
Get the gender of a first name |
|
|
Validate a code identifier |
|
|
Validate a last name |
|
|
Validate phone number (basic) |
|
|
Parse an HTTP User-Agent string, identify robots |
|
|
Lookup a VAT code |
|
Name |
Summary |
|
Name |
Summary |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Summary: Parse an unstructured input text string into an international, formatted address
Description: 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.
Syntax:
CloudmersiveDataValidation.Address_ParseString (ParseAddressRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Request to parse an address formatted as a string/free text into a structured address |
True |
Returns:
Type:ParseAddressResponse
Description: Result of parsing an address into its component parts
Summary: Validate a domain name
Description: 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.
Syntax:
CloudmersiveDataValidation.Domain_Check (string domain)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
domain |
string
|
|
True |
Returns:
Type:CheckResponse
Description: Result of a validation operation
Summary: Validate a URL fully
Description: 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.
Syntax:
CloudmersiveDataValidation.Domain_UrlFull (ValidateUrlRequestFull request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Request to determine if a URL is valid |
True |
Returns:
Description: Result of validating a URL with full validation
Summary: Validate a URL syntactically
Description: 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.
Syntax:
CloudmersiveDataValidation.Domain_UrlSyntaxOnly (ValidateUrlRequestSyntaxOnly request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
Request to determine if a URL is valid |
True |
Returns:
Type:ValidateUrlResponseSyntaxOnly
Description: Result of validating a URL with syntax only
Summary: Get WHOIS information for a domain
Description: 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.
Syntax:
CloudmersiveDataValidation.Domain_Post (string domain)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
domain |
string
|
|
True |
Returns:
Type:WhoisResponse
Description: Result of a WHOIS operation
Summary: Fully validate an email address
Description: 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.
Syntax:
CloudmersiveDataValidation.Email_FullValidation (string email)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
|
string
|
|
True |
Returns:
Type:FullEmailValidationResponse
Description: Full email addresss validation result
Summary: Geolocate an IP address
Description: Identify an IP address Country, State/Provence, City, Zip/Postal Code, etc. Useful for security and UX applications.
Syntax:
CloudmersiveDataValidation.IPAddress_Post (string value)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
value |
string
|
|
True |
Returns:
Type:GeolocateResponse
Description: Geolocation result
Summary: Validate a first name
Description: Determines if a string is a valid first name (given name)
Syntax:
CloudmersiveDataValidation.Name_ValidateFirstName (FirstNameValidationRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Request to validate a first name |
True |
Returns:
Type:FirstNameValidationResponse
Description: Result of a first name validation operation
Summary: Parse and validate a full name
Description: 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
Syntax:
CloudmersiveDataValidation.Name_ValidateFullName (FullNameValidationRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Request to validate a full name string |
True |
Returns:
Type:FullNameValidationResponse
Description: Result of a full name validation operation
Summary: Get the gender of a first name
Description: Determines the gender of a first name (given name)
Syntax:
CloudmersiveDataValidation.Name_GetGender (GetGenderRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Request to get the gender from a first name |
True |
Returns:
Type:GetGenderResponse
Description: Result of the GetGender operation
Summary: Validate a code identifier
Description: 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".
Syntax:
CloudmersiveDataValidation.Name_Identifier (ValidateIdentifierRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Identifier validation request, including the input identifier as well as various identifier rules |
True |
Returns:
Type:ValidateIdentifierResponse
Description: Result of performing an identifier validation operation
Summary: Validate a last name
Description: Determines if a string is a valid last name (surname)
Syntax:
CloudmersiveDataValidation.Name_ValidateLastName (LastNameValidationRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Request to validate a last name |
True |
Returns:
Type:LastNameValidationResponse
Description: Result of a last name validation operation
Summary: Validate phone number (basic)
Description: Validate a phone number by analyzing the syntax
Syntax:
CloudmersiveDataValidation.PhoneNumber_SyntaxOnly (PhoneNumberValidateRequest value)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
value |
|
Request to validate a phone number |
True |
Returns:
Type:PhoneNumberValidationResponse
Description: Result from validating a phone number
Summary: Parse an HTTP User-Agent string, identify robots
Description: 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.
Syntax:
CloudmersiveDataValidation.UserAgent_Parse (UserAgentValidateRequest request)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
request |
|
User-Agent parse and validation request |
True |
Returns:
Type:UserAgentValidateResponse
Description: The result of a User-Agent validation request
Summary: Lookup a VAT code
Description: Checks if a VAT code is valid, and if it is, returns more information about it
Syntax:
CloudmersiveDataValidation.Vat_VatLookup (VatLookupRequest input)
Parameters:
|
Name |
Type |
Summary |
Required |
Related Action |
|
input |
|
Input to a VAT lookup request |
True |
Returns:
Type:VatLookupResponse
Summary:
Description: Result of a validation operation
Properties:
|
Name |
Type |
Summary |
|
ValidDomain |
boolean
|
True if the domain name was valid, false if it is not |
Summary:
Description: Request to validate a first name
Properties:
|
Name |
Type |
Summary |
|
FirstName |
string
|
First name to process |
Summary:
Description: Result of a first name validation operation
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the validation operation was successful, false otherwise |
|
ValidationResult |
string
|
Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty |
Summary:
Description: Full email addresss validation result
Properties:
|
Name |
Type |
Summary |
|
Domain |
string
|
Domain name of the email address |
|
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 |
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 |
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 |
string
|
Email server connected to for verification |
|
ValidAddress |
boolean
|
True if the email address is valid overall, false otherwise |
|
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 |
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 |
boolean
|
True if the syntax of the email address is valid, false otherwise. This is one component of ValidAddress, but not the only one. |
Summary:
Description: Request to validate a full name string
Properties:
|
Name |
Type |
Summary |
|
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 |
Summary:
Description: Result of a full name validation operation
Properties:
|
Name |
Type |
Summary |
|
DisplayName |
string
|
The full display name of the name |
|
FirstName |
string
|
The first name (given name) |
|
LastName |
string
|
The last name (surname) |
|
MiddleName |
string
|
The middle name(s); if there are multiple names they will be separated by spaces |
|
NickName |
string
|
Nickname (if supplied) |
|
Successful |
boolean
|
True if the validation operation was successful, false otherwise |
|
Suffix |
string
|
Suffix to the name, e.g. "Jr." or "Sr." |
|
Title |
string
|
The person's title (if supplied), e.g. "Mr." or "Ms." |
|
ValidationResult_FirstName |
string
|
Possible values are: ValidFirstName, ValidUnknownFirstName, InvalidSpamInput, InvalidCharacters, InvalidEmpty |
|
ValidationResult_LastName |
string
|
Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty |
Summary:
Description: Geolocation result
Properties:
|
Name |
Type |
Summary |
|
City |
string
|
City of IP address |
|
CountryCode |
string
|
Two-letter country code of IP address |
|
CountryName |
string
|
Country name of IP address |
|
Latitude |
number(double)
|
Latitude of IP address |
|
Longitude |
number(double)
|
Longitude of IP address |
|
RegionCode |
string
|
State/region code of IP address |
|
RegionName |
string
|
State/region of IP address |
|
TimezoneStandardName |
string
|
Timezone of IP address |
|
ZipCode |
string
|
Zip or postal code of IP address |
Summary:
Description: Request to get the gender from a first name
Properties:
|
Name |
Type |
Summary |
|
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 |
string
|
Input first name (given name) to get the gender of |
Summary:
Description: Result of the GetGender operation
Properties:
|
Name |
Type |
Summary |
|
Gender |
string
|
Gender for this name; possible values are Male, Female, and Neutral (can be applied to Male or Female) |
|
Successful |
boolean
|
True if successful, false otherwise |
Summary:
Description: Request to validate a last name
Properties:
|
Name |
Type |
Summary |
|
LastName |
string
|
Last name to process |
Summary:
Description: Result of a last name validation operation
Properties:
|
Name |
Type |
Summary |
|
Successful |
boolean
|
True if the validation operation was successful, false otherwise |
|
ValidationResult |
string
|
Possible values are: ValidLastName, ValidUnknownLastName, InvalidSpamInput, InvalidCharacters, InvalidEmpty |
Summary:
Description: Request to parse an address formatted as a string/free text into a structured address
Properties:
|
Name |
Type |
Summary |
|
AddressString |
string
|
A mailing address or street address formatted as a single text string; this will be parsed into its components |
|
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 |
Summary:
Description: Result of parsing an address into its component parts
Properties:
|
Name |
Type |
Summary |
|
Building |
string
|
The name of the building, house or structure if applicable, such as "Cloudmersive Building 2". This will often by null. |
|
City |
string
|
The city of the address. |
|
Country |
string
|
Country of the address, if present in the address. If not included in the address it will be null. |
|
PostalCode |
string
|
The postal code or zip code of the address. |
|
StateOrProvince |
string
|
The state or province of the address. |
|
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 |
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 |
boolean
|
True if the parsing operation was successful, false otherwise |
Summary:
Description: Request to validate a phone number
Properties:
|
Name |
Type |
Summary |
|
DefaultCountryCode |
string
|
Optional, default country code. If left blank, will default to "US". |
|
PhoneNumber |
string
|
Raw phone number string to parse as input for validation |
Summary:
Description: Result from validating a phone number
Properties:
|
Name |
Type |
Summary |
|
CountryCode |
string
|
Two digit country code of the phone number |
|
CountryName |
string
|
User-friendly long name of the country for the phone number |
|
E164Format |
string
|
E.164 format of the phone number |
|
InternationalFormat |
string
|
Internaltional format of the phone number |
|
IsValid |
boolean
|
True if the phone number is valid, false otherwise |
|
NationalFormat |
string
|
National format of the phone number |
|
PhoneNumberType |
string
|
Type of phone number; possible values are: FixedLine, Mobile, FixedLineOrMobile, TollFree, PremiumRate, SharedCost, Voip, PersonalNumber, Pager, Uan, Voicemail, Unknown |
|
Successful |
boolean
|
True if the operation was successful, false if there was an error during validation. See IsValid for validation result. |
Summary:
Description: User-Agent parse and validation request
Properties:
|
Name |
Type |
Summary |
|
UserAgentString |
string
|
The user agent string you wish to parse and validate |
Summary:
Description: The result of a User-Agent validation request
Properties:
|
Name |
Type |
Summary |
|
BotName |
string
|
Optional; name of the robot if the request was from a known robot, otherwise null |
|
BotURL |
string
|
Optional; if available, the URL to the robot |
|
BrowserEngineName |
string
|
Name of the Browser Engine |
|
BrowserEngineVersion |
string
|
Version of the Browser Engine |
|
BrowserName |
string
|
Name of the Browser |
|
BrowserVersion |
string
|
Version of the Browser |
|
DeviceBrandName |
string
|
Brand name of the User-Agent |
|
DeviceModel |
string
|
Model name or number of the User-Agent |
|
DeviceType |
string
|
Device type of the User-Agent; possible values are "DESKTOP", "SMARTPHONE", "TABLET" |
|
IsBot |
boolean
|
True if the request is a known robot, false otherwise |
|
OperatingSystem |
string
|
Operating System of the User-Agent (e.g. Windows) |
|
OperatingSystemCPUPlatform |
string
|
The CPU platform of the User-Agent (e.g. x64) |
|
OperatingSystemVersion |
string
|
The version of the operating system of the User-Agent (e.g. "10" for Windows 10) |
|
Successful |
boolean
|
True if the operation was successful, false otherwise |
Summary:
Description: Identifier validation request, including the input identifier as well as various identifier rules
Properties:
|
Name |
Type |
Summary |
|
AllowHyphens |
boolean
|
True if hyphens are allowd in the identifier, false otherwise |
|
AllowNumbers |
boolean
|
True if numbers are allowed in the identifier, false otherwise |
|
AllowPeriods |
boolean
|
True if periods are allowed in the identifier, false otherwise |
|
AllowUnderscore |
boolean
|
True if underscores are allowed in the identifier, false otherwise |
|
AllowWhitespace |
boolean
|
True if whitespace is allowed in the identifier, false otherwise |
|
Input |
string
|
Text string identifier input |
|
MaxLength |
integer(int32)
|
Optional; maximum length, if any, of the identifier |
|
MinLength |
integer(int32)
|
Optional; minimum length, if any, of the identifier |
Summary:
Description: Result of performing an identifier validation operation
Properties:
|
Name |
Type |
Summary |
|
Error |
string
|
Resulting error from the identifier validation; possible errors are: "InputIsEmpty", "ContainsWhitespace", "ContainsNumbers", "ContainsHyphen", "ContainsUnderscore", "ContainsPeriod", "TooShort", "TooLong", "ContainsSpecialCharacters" |
|
ValidIdentifier |
boolean
|
True if the input identifier is valid, false otherwise |
Summary:
Description: Request to determine if a URL is valid
Properties:
|
Name |
Type |
Summary |
|
URL |
string
|
URL to validate |
Summary:
Description: Request to determine if a URL is valid
Properties:
|
Name |
Type |
Summary |
|
URL |
string
|
URL to validate |
Summary:
Description: Result of validating a URL with full validation
Properties:
|
Name |
Type |
Summary |
|
ValidURL |
boolean
|
True if the URL has valid syntax, a valid domain, a valid endpoint, and passes virus scan checks; false otherwise |
|
Valid_Domain |
boolean
|
True if the domain name is valid and exists, false otherwise |
|
Valid_Endpoint |
boolean
|
True if the endpoint is up and responsive and passes a virus scan check, false otherwise |
|
Valid_Syntax |
boolean
|
True if the URL has valid syntax, false otherwise |
|
WellFormedURL |
string
|
Well-formed version of the URL |
Summary:
Description: Result of validating a URL with syntax only
Properties:
|
Name |
Type |
Summary |
|
ValidURL |
boolean
|
True if the URL is valid, false otherwise |
|
WellFormedURL |
string
|
Well-formed version of the URL |
Summary:
Description: Input to a VAT lookup request
Properties:
|
Name |
Type |
Summary |
|
VatCode |
string
|
VAT code to lookup; example "CZ25123891" |
Summary:
Description:
Properties:
|
Name |
Type |
Summary |
|
BusinessAddress |
string
|
Business address |
|
BusinessName |
string
|
Name of the business |
|
CountryCode |
string
|
Two-letter country code |
|
IsValid |
boolean
|
True if the VAT code is valid, false otherwise |
|
VatNumber |
string
|
VAT number |
Summary:
Description: Result of a WHOIS operation
Properties:
|
Name |
Type |
Summary |
|
CreatedDt |
string(date-time)
|
Creation date for the record |
|
RawTextRecord |
string
|
WHOIS raw text record |
|
ValidDomain |
boolean
|
True if the domain is valid, false if it is not |
|
WhoisServer |
string
|
Server used to lookup WHOIS information (may change based on lookup). |