validateapi API 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.

Swagger OpenAPI Specification | .NET Framework Client | .NET Core Client | Java Client | Node.JS Client | Python Client | Drupal Client

API Endpoint
https://api.cloudmersive.com
Schemes: https
Version: v1

Authentication

Apikey

API Key Authentication

type
apiKey
name
Apikey
in
header

Domain

Validate a domain name

POST /validate/domain/check


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.



Domain name to check, for example "cloudmersive.com". The input is a string so be sure to enclose it in double-quotes.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "ValidDomain": "boolean"
}

Get WHOIS information for a domain

POST /validate/domain/whois


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.



Domain name to check, for example "cloudmersive.com". The input is a string so be sure to enclose it in double-quotes.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
200 OK

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "ValidDomain": "boolean",
  "WhoisServer": "string",
  "RawTextRecord": "string",
  "CreatedDt": "string (date-time)"
}

Email

Validate email adddress for syntactic correctness only

POST /validate/email/address/syntaxOnly


Validate whether a given email address is syntactically correct via a limited local-only check. Use the address/full API to do a full validation.



Email address to validate, e.g. " support@cloudmersive.com". The input is a string so be sure to enclose it in double-quotes.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "ValidAddress": "boolean"
}

Partially check whether an email address is valid

POST /validate/email/address/servers


Validate an email address by identifying whether its parent domain has email servers defined. This call is less limited than syntaxOnly but not as comprehensive as address/full.



Email address to validate, e.g. " support@cloudmersive.com". The input is a string so be sure to enclose it in double-quotes.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "Success": "boolean",
  "Servers": [
    "string"
  ]
}

Fully validate an email address

POST /validate/email/address/full


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.



Email address to validate, e.g. " support@cloudmersive.com". The input is a string so be sure to enclose it in double-quotes.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "ValidAddress": "boolean",
  "MailServerUsedForValidation": "string"
}

IPAddress

Geolocate an IP address

POST /validate/ip/geolocate


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



IP address to geolocate, e.g. "55.55.55.55". The input is a string so be sure to enclose it in double-quotes.

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
"string"

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "CountryCode": "string",
  "CountryName": "string",
  "City": "string",
  "RegionCode": "string",
  "RegionName": "string",
  "ZipCode": "string",
  "TimezoneStandardName": "string",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}

Name

Parse and validate a full name

POST /validate/name/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



Validation request information

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "FullNameString": "string"
}
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "Successful": "boolean",
  "ValidationResult_FirstName": "string",
  "ValidationResult_LastName": "string",
  "Title": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "NickName": "string",
  "Suffix": "string",
  "DisplayName": "string"
}

Validate a first name

POST /validate/name/first


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



Validation request information

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "FirstName": "string"
}
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "Successful": "boolean",
  "ValidationResult": "string"
}

Validate a last name

POST /validate/name/last


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



Validation request information

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "LastName": "string"
}
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "Successful": "boolean",
  "ValidationResult": "string"
}

Get the gender of a first name

POST /validate/name/get-gender


Determines the gender of a first name (given name)



Gender request information

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "FirstName": "string",
  "CountryCode": "string"
}

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "Successful": "boolean",
  "Gender": "string"
}

PhoneNumber

Validate phone number (basic)

POST /validate/phonenumber/basic


Validate a phone number by analyzing the syntax



Phone number to validate in a PhoneNumberValidateRequest object. Try a phone number such as "1.800.463.3339", and either leave DefaultCountryCode blank or use "US".

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "PhoneNumber": "string",
  "DefaultCountryCode": "string"
}
Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "IsValid": "boolean",
  "Successful": "boolean",
  "PhoneNumberType": "string",
  "E164Format": "string",
  "InternationalFormat": "string",
  "NationalFormat": "string",
  "CountryCode": "string",
  "CountryName": "string"
}

Vat

Vat

Lookup a VAT code

POST /validate/vat/lookup


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



Input VAT code

Code Example:
Request Content-Types: application/json, text/json, application/xml, text/xml, application/x-www-form-urlencoded
Request Example
{
  "VatCode": "string"
}

OK

Response Content-Types: application/json, text/json, application/xml, text/xml
Response Example (200 OK)
{
  "CountryCode": "string",
  "VatNumber": "string",
  "IsValid": "boolean",
  "BusinessName": "string",
  "BusinessAddress": "string"
}

Schema Definitions

CheckResponse: object

Result of a validation operation

ValidDomain: boolean

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

Example
{
  "ValidDomain": "boolean"
}

WhoisResponse: object

Result of a WHOIS operation

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).

RawTextRecord: string

WHOIS raw text record

CreatedDt: string (date-time)

Creation date for the record

Example
{
  "ValidDomain": "boolean",
  "WhoisServer": "string",
  "RawTextRecord": "string",
  "CreatedDt": "string (date-time)"
}

AddressVerifySyntaxOnlyResponse: object

Syntactic validity of email address

ValidAddress: boolean

True if the email address is syntactically valid, false if it is not

Example
{
  "ValidAddress": "boolean"
}

AddressGetServersResponse: object

Result of a partial email address validation

Success: boolean
Servers: string[]
string
Example
{
  "Success": "boolean",
  "Servers": [
    "string"
  ]
}

FullEmailValidationResponse: object

Full email addresss validation result

ValidAddress: boolean

True if the email address is valid, false otherwise

MailServerUsedForValidation: string

Email server connected to for verification

Example
{
  "ValidAddress": "boolean",
  "MailServerUsedForValidation": "string"
}

GeolocateResponse: object

Geolocation result

CountryCode: string

Two-letter country code of IP address

CountryName: string

Country name of IP address

City: string

City of IP address

RegionCode: string

State/region code of IP address

RegionName: string

State/region of IP address

ZipCode: string

Zip or postal code of IP address

TimezoneStandardName: string

Timezone of IP address

Latitude: number (double)

Latitude of IP address

Longitude: number (double)

Longitude of IP address

Example
{
  "CountryCode": "string",
  "CountryName": "string",
  "City": "string",
  "RegionCode": "string",
  "RegionName": "string",
  "ZipCode": "string",
  "TimezoneStandardName": "string",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}

FullNameValidationRequest: object

Request to validate a full name string

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

Example
{
  "FullNameString": "string"
}

FullNameValidationResponse: object

Result of a full name validation operation

Successful: boolean

True if the validation operation was successful, false otherwise

ValidationResult_FirstName: string

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

ValidationResult_LastName: string

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

Title: string

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

FirstName: string

The first name (given name)

MiddleName: string

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

LastName: string

The last name (surname)

NickName: string

Nickname (if supplied)

Suffix: string

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

DisplayName: string

The full display name of the name

Example
{
  "Successful": "boolean",
  "ValidationResult_FirstName": "string",
  "ValidationResult_LastName": "string",
  "Title": "string",
  "FirstName": "string",
  "MiddleName": "string",
  "LastName": "string",
  "NickName": "string",
  "Suffix": "string",
  "DisplayName": "string"
}

FirstNameValidationRequest: object

Request to validate a first name

FirstName: string

First name to process

Example
{
  "FirstName": "string"
}

FirstNameValidationResponse: object

Result of a first name validation operation

Successful: boolean

True if the validation operation was successful, false otherwise

ValidationResult: string

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

Example
{
  "Successful": "boolean",
  "ValidationResult": "string"
}

LastNameValidationRequest: object

Request to validate a last name

LastName: string

Last name to process

Example
{
  "LastName": "string"
}

LastNameValidationResponse: object

Result of a last name validation operation

Successful: boolean

True if the validation operation was successful, false otherwise

ValidationResult: string

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

Example
{
  "Successful": "boolean",
  "ValidationResult": "string"
}

GetGenderRequest: object

Request to get the gender from a first name

FirstName: string

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

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"

Example
{
  "FirstName": "string",
  "CountryCode": "string"
}

GetGenderResponse: object

Result of the GetGender operation

Successful: boolean

True if successful, false otherwise

Gender: string

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

Example
{
  "Successful": "boolean",
  "Gender": "string"
}

PhoneNumberValidateRequest: object

Request to validate a phone number

PhoneNumber: string

Raw phone number string to parse as input for validation

DefaultCountryCode: string

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

Example
{
  "PhoneNumber": "string",
  "DefaultCountryCode": "string"
}

PhoneNumberValidationResponse: object

Result from validating a phone number

IsValid: boolean

True if the phone number is valid, false otherwise

Successful: boolean

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

PhoneNumberType: string

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

E164Format: string

E.164 format of the phone number

InternationalFormat: string

Internaltional format of the phone number

NationalFormat: string

National format of the phone number

CountryCode: string

Two digit country code of the phone number

CountryName: string

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

Example
{
  "IsValid": "boolean",
  "Successful": "boolean",
  "PhoneNumberType": "string",
  "E164Format": "string",
  "InternationalFormat": "string",
  "NationalFormat": "string",
  "CountryCode": "string",
  "CountryName": "string"
}

VatLookupRequest: object

Input to a VAT lookup request

VatCode: string
Example
{
  "VatCode": "string"
}

VatLookupResponse: object

CountryCode: string
VatNumber: string
IsValid: boolean
BusinessName: string
BusinessAddress: string
Example
{
  "CountryCode": "string",
  "VatNumber": "string",
  "IsValid": "boolean",
  "BusinessName": "string",
  "BusinessAddress": "string"
}