Data Validation API 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

header

Address

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

POST /validate/address/parse

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.

ParseAddressRequest

Input parse request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "AddressString": "string",
  "CapitalizationMode": "string"
}

200 OK

ParseAddressResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "Building": "string",
  "StreetNumber": "string",
  "Street": "string",
  "City": "string",
  "StateOrProvince": "string",
  "PostalCode": "string",
  "CountryFullName": "string",
  "ISOTwoLetterCode": "string"
}


Apikey

Address

Validate a street address

POST /validate/address/street-address

Determines if an input structured street address is valid or invalid. If the address is valid, also returns the latitude and longitude of the address. Supports all major international addresses.

ValidateAddressRequest

Input parse request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "StreetAddress": "string",
  "City": "string",
  "StateOrProvince": "string",
  "PostalCode": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}

200 OK

ValidateAddressResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidAddress": "boolean",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}


Apikey

Address

Normalize a street address

POST /validate/address/street-address/normalize

Normalizes an input structured street address is valid or invalid. If the address is valid, also returns the latitude and longitude of the address. Supports all major international addresses.

ValidateAddressRequest

Input parse request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "StreetAddress": "string",
  "City": "string",
  "StateOrProvince": "string",
  "PostalCode": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}

200 OK

NormalizeAddressResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidAddress": "boolean",
  "Building": "string",
  "StreetNumber": "string",
  "Street": "string",
  "City": "string",
  "StateOrProvince": "string",
  "PostalCode": "string",
  "CountryFullName": "string",
  "ISOTwoLetterCode": "string",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}


Apikey

Address

Validate a City and State/Province combination, get location information about it

POST /validate/address/city

Checks if the input city and state name or code is valid, and returns information about it such as normalized City name, State name and more. Supports all major international addresses.

ValidateCityRequest

Input parse request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "City": "string",
  "StateOrProvince": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}

200 OK

ValidateCityResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidCity": "boolean",
  "City": "string",
  "StateOrProvince": "string",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}


Apikey

Address

Validate a state or province, name or abbreviation, get location information about it

POST /validate/address/state

Checks if the input state name or code is valid, and returns information about it such as normalized State name and more. Supports all major countries.

ValidateStateRequest

Input parse request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "StateOrProvince": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}

200 OK

ValidateStateResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidState": "boolean",
  "StateOrProvince": "string",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}


Apikey

Address

Validate a postal code, get location information about it

POST /validate/address/postal-code

Checks if the input postal code is valid, and returns information about it such as City, State and more. Supports all major countries.

ValidatePostalCodeRequest

Input parse request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "PostalCode": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}

200 OK

ValidatePostalCodeResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidPostalCode": "boolean",
  "City": "string",
  "StateOrProvince": "string",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}


Apikey

Address

Validate and normalize country information, return ISO 3166-1 country codes and country name

POST /validate/address/country

Validates and normalizes country information, and returns key information about a country, as well as whether it is a member of the European Union. Also returns distinct time zones in the country.

ValidateCountryRequest

Input request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "RawCountryInput": "string"
}

200 OK

ValidateCountryResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "CountryFullName": "string",
  "ISOTwoLetterCode": "string",
  "FIPSTwoLetterCode": "string",
  "ThreeLetterCode": "string",
  "IsEuropeanUnionMember": "boolean",
  "Timezones": [
    {
      "Name": "string",
      "BaseUTCOffset": "string",
      "Now": "string (date-time)"
    }
  ],
  "ISOCurrencyCode": "string",
  "CurrencySymbol": "string",
  "CurrencyEnglishName": "string",
  "Region": "string",
  "Subregion": "string"
}


Apikey

Address

Get a list of ISO 3166-1 countries

POST /validate/address/country/list

Enumerates the list of ISO 3166-1 countries, including name, country codes, and more.

Code Example:

200 OK

CountryListResult

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "Countries": [
    {
      "CountryName": "string",
      "ThreeLetterCode": "string",
      "ISOTwoLetterCode": "string",
      "IsEuropeanUnionMember": "boolean",
      "ISOCurrencyCode": "string",
      "CurrencySymbol": "string",
      "CurrencyEnglishName": "string",
      "Region": "string",
      "Subregion": "string"
    }
  ]
}


Apikey

Address

Check if a country is a member of the European Union (EU)

POST /validate/address/country/check-eu-membership

Checks if the input country is a member of the European Union or not.

ValidateCountryRequest

Input request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "RawCountryInput": "string"
}

200 OK

ValidateCountryResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "CountryFullName": "string",
  "ISOTwoLetterCode": "string",
  "FIPSTwoLetterCode": "string",
  "ThreeLetterCode": "string",
  "IsEuropeanUnionMember": "boolean",
  "Timezones": [
    {
      "Name": "string",
      "BaseUTCOffset": "string",
      "Now": "string (date-time)"
    }
  ],
  "ISOCurrencyCode": "string",
  "CurrencySymbol": "string",
  "CurrencyEnglishName": "string",
  "Region": "string",
  "Subregion": "string"
}


Apikey

Address

Get the currency of the input country

POST /validate/address/country/get-currency

Gets the currency information for the input country, including the ISO three-letter country code, currency symbol, and English currency name.

ValidateCountryRequest

Input request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "RawCountryInput": "string"
}

200 OK

ValidateCountryResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "CountryFullName": "string",
  "ISOTwoLetterCode": "string",
  "FIPSTwoLetterCode": "string",
  "ThreeLetterCode": "string",
  "IsEuropeanUnionMember": "boolean",
  "Timezones": [
    {
      "Name": "string",
      "BaseUTCOffset": "string",
      "Now": "string (date-time)"
    }
  ],
  "ISOCurrencyCode": "string",
  "CurrencySymbol": "string",
  "CurrencyEnglishName": "string",
  "Region": "string",
  "Subregion": "string"
}


Apikey

Address

Get the region, subregion and continent of the country

POST /validate/address/country/get-region

Gets the continent information including region and subregion for the input country.

ValidateCountryRequest

Input request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "RawCountryInput": "string"
}

200 OK

ValidateCountryResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "CountryFullName": "string",
  "ISOTwoLetterCode": "string",
  "FIPSTwoLetterCode": "string",
  "ThreeLetterCode": "string",
  "IsEuropeanUnionMember": "boolean",
  "Timezones": [
    {
      "Name": "string",
      "BaseUTCOffset": "string",
      "Now": "string (date-time)"
    }
  ],
  "ISOCurrencyCode": "string",
  "CurrencySymbol": "string",
  "CurrencyEnglishName": "string",
  "Region": "string",
  "Subregion": "string"
}


Apikey

Address

Gets IANA/Olsen time zones for a country

POST /validate/address/country/get-timezones

Gets the IANA/Olsen time zones for a country.

GetTimezonesRequest

Input request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "CountryCodeOrName": "string"
}

200 OK

GetTimezonesResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "CountryFullName": "string",
  "ISOTwoLetterCode": "string",
  "FIPSTwoLetterCode": "string",
  "ThreeLetterCode": "string",
  "Timezones": [
    {
      "Name": "string",
      "BaseUTCOffset": "string",
      "Now": "string (date-time)"
    }
  ]
}


Apikey

Address

Geocode a street address into latitude and longitude

POST /validate/address/geocode

Geocodes a street address into latitude and longitude.

ValidateAddressRequest

Input parse request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "StreetAddress": "string",
  "City": "string",
  "StateOrProvince": "string",
  "PostalCode": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}

200 OK

ValidateAddressResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidAddress": "boolean",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}


Apikey

Address

Reverse geocode a lattitude and longitude into an address

POST /validate/address/geocode/reverse

Converts lattitude and longitude coordinates into an address through reverse-geocoding.

ReverseGeocodeAddressRequest

Input reverse geocoding request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}

200 OK

ReverseGeocodeAddressResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "StreetAddress": "string",
  "City": "string",
  "StateOrProvince": "string",
  "PostalCode": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}


Apikey

DateTime

Get current date and time as of now

GET /validate/date-time/get/now

Gets the current date and time. Response time is syncronized with atomic clocks, and represents a monotonic, centrally available, consistent clock.

Code Example:

200 OK

DateTimeNowResult

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "Now": "string (date-time)",
  "NowGmt": "string (date-time)"
}


Apikey

DateTime

Get public holidays in the specified country and year

POST /validate/date-time/get/holidays

Enumerates all public holidays in a given country for a given year. Supports over 100 countries.

GetPublicHolidaysRequest

Input request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "RawCountryInput": "string",
  "Year": "integer (int32)"
}

200 OK

PublicHolidaysResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "PublicHolidays": [
    {
      "EnglishName": "string",
      "LocalName": "string",
      "OccurrenceDate": "string (date-time)",
      "HolidayType": "string",
      "Nationwaide": "boolean"
    }
  ]
}


Apikey

DateTime

Parses a standardized date and time string into a date and time

POST /validate/date-time/parse/date-time/structured

Parses a structured date and time string into a date time object. This is intended for standardized date strings that adhere to formatting conventions, rather than natural language input.

DateTimeStandardizedParseRequest

Input request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "RawDateTimeInput": "string",
  "CountryCode": "string"
}

200 OK

DateTimeStandardizedParseResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "ParsedDateResult": "string (date-time)",
  "Year": "integer (int32)",
  "Month": "integer (int32)",
  "Day": "integer (int32)",
  "Hour": "integer (int32)",
  "Minute": "integer (int32)",
  "Second": "integer (int32)",
  "DayOfWeek": "string"
}


Apikey

DateTime

Parses a free-form natural language date and time string into a date and time

POST /validate/date-time/parse/date-time/natural-language

Parses an unstructured, free-form, natural language date and time string into a date time object. This is intended for lightweight human-entered input, such as "tomorrow at 3pm" or "tuesday".

DateTimeNaturalLanguageParseRequest

Input request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "RawDateTimeInput": "string"
}

200 OK

DateTimeStandardizedParseResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "ParsedDateResult": "string (date-time)",
  "Year": "integer (int32)",
  "Month": "integer (int32)",
  "Day": "integer (int32)",
  "Hour": "integer (int32)",
  "Minute": "integer (int32)",
  "Second": "integer (int32)",
  "DayOfWeek": "string"
}


Apikey

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

Request Example

"string"

200 OK

CheckResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidDomain": "boolean"
}


Apikey

Domain

Validate a domain name's quality score

POST /validate/domain/quality-score

Check the quality of a domain name. Supports over 9 million domain names. Higher quality scores indicate more trust and authority in the domain name, with values ranging from 0.0 (low quality) to 10.0 (maximum quality).

Domain name to check, for example "cloudmersive.com".

Code Example:

Request Content-Types: application/json, text/json

Request Example

"string"

200 OK

DomainQualityResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "DomainQualityScore": "number (double)"
}


Apikey

Domain

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

Request Example

"string"

200 OK

WhoisResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidDomain": "boolean",
  "RegistrantName": "string",
  "RegistrantOrganization": "string",
  "RegistrantEmail": "string",
  "RegistrantStreetNumber": "string",
  "RegistrantStreet": "string",
  "RegistrantCity": "string",
  "RegistrantStateOrProvince": "string",
  "RegistrantPostalCode": "string",
  "RegistrantCountry": "string",
  "RegistrantRawAddress": "string",
  "RegistrantTelephone": "string",
  "WhoisServer": "string",
  "RawTextRecord": "string",
  "CreatedDt": "string (date-time)"
}


Apikey

Domain

Validate a URL syntactically

POST /validate/domain/url/syntax-only

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.

ValidateUrlRequestSyntaxOnly

Input URL information

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "URL": "string"
}

200 OK

ValidateUrlResponseSyntaxOnly

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidURL": "boolean",
  "WellFormedURL": "string",
  "TopLevelDomainName": "string"
}


Apikey

Domain

Validate a URL fully

POST /validate/domain/url/full

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.

ValidateUrlRequestFull

Input URL request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "URL": "string"
}

200 OK

ValidateUrlResponseFull

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidURL": "boolean",
  "Valid_Syntax": "boolean",
  "Valid_Domain": "boolean",
  "Valid_Endpoint": "boolean",
  "WellFormedURL": "string"
}


Apikey

Domain

Get top-level domain name from URL

POST /validate/domain/url/get-top-level-domain

Gets the top-level domain name from a URL, such as mydomain.com.

ValidateUrlRequestSyntaxOnly

Input URL information

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "URL": "string"
}

200 OK

ValidateUrlResponseSyntaxOnly

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidURL": "boolean",
  "WellFormedURL": "string",
  "TopLevelDomainName": "string"
}


Apikey

Domain

Check a URL for SSRF threats

POST /validate/domain/url/ssrf-threat-check

Checks if an input URL is at risk of being an SSRF (Server-side request forgery) threat or attack.

UrlSsrfRequestFull

Input URL request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "URL": "string",
  "BlockedDomains": [
    "string"
  ]
}

200 OK

UrlSsrfResponseFull

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "CleanURL": "boolean",
  "ThreatLevel": "string"
}


Apikey

Domain

Check a URL for SSRF threats in batches

POST /validate/domain/url/ssrf-threat-check/batch

Batch-checks if input URLs are at risk of being an SSRF (Server-side request forgery) threat or attack.

UrlSsrfRequestBatch

Input URL request as a batch of multiple URLs

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "InputItems": [
    {
      "URL": "string",
      "BlockedDomains": [
        "string"
      ]
    }
  ]
}

200 OK

UrlSsrfResponseBatch

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "OutputItems": [
    {
      "CleanURL": "boolean",
      "ThreatLevel": "string"
    }
  ]
}


Apikey

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

Request Example

"string"

200 OK

AddressVerifySyntaxOnlyResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidAddress": "boolean",
  "Domain": "string",
  "IsFreeEmailProvider": "boolean",
  "IsDisposable": "boolean"
}


Apikey

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

Request Example

"string"

200 OK

AddressGetServersResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

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


Apikey

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

Request Example

"string"

200 OK

FullEmailValidationResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidAddress": "boolean",
  "MailServerUsedForValidation": "string",
  "Valid_Syntax": "boolean",
  "Valid_Domain": "boolean",
  "Valid_SMTP": "boolean",
  "IsCatchallDomain": "boolean",
  "Domain": "string",
  "IsFreeEmailProvider": "boolean",
  "IsDisposable": "boolean"
}


Apikey

IPAddress

Get intelligence on an IP address

POST /validate/ip/intelligence

Identify key intelligence about an IP address, including if it is a known threat IP, known bot, Tor exit node, as well as the location of the IP address.

IP address to process, 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

Request Example

"string"

200 OK

IPIntelligenceResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "IsBot": "boolean",
  "IsTorNode": "boolean",
  "IsThreat": "boolean",
  "IsEU": "boolean",
  "Location": {
    "CountryCode": "string",
    "CountryName": "string",
    "City": "string",
    "RegionCode": "string",
    "RegionName": "string",
    "ZipCode": "string",
    "TimezoneStandardName": "string",
    "Latitude": "number (double)",
    "Longitude": "number (double)"
  },
  "CurrencyCode": "string",
  "CurrencyName": "string",
  "RegionArea": "string",
  "SubregionArea": "string"
}


Apikey

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

Request Example

"string"

200 OK

GeolocateResponse

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)"
}


Apikey

IPAddress

Geolocate an IP address to a street address

POST /validate/ip/geolocate/street-address

Identify an IP address's street address. 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

Request Example

"string"

200 OK

GeolocateStreetAddressResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "CountryCode": "string",
  "CountryName": "string",
  "StreetAddress": "string",
  "City": "string",
  "RegionName": "string",
  "ZipCode": "string"
}


Apikey

IPAddress

Check if IP address is a known threat

POST /validate/ip/is-threat

Check if the input IP address is a known threat IP address. Checks against known bad IPs, botnets, compromised servers, and other lists of threats.

IP address to check, 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

Request Example

"string"

200 OK

IPThreatResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "IsThreat": "boolean",
  "ThreatType": "string"
}


Apikey

IPAddress

Check if IP address is a Tor node server

POST /validate/ip/is-tor-node

Check if the input IP address is a Tor exit node server. Tor servers are a type of privacy-preserving technology that can hide the original IP address who makes a request.

IP address to check, 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

Request Example

"string"

200 OK

TorNodeResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "IsTorNode": "boolean"
}


Apikey

IPAddress

Check if IP address is a Bot client

POST /validate/ip/is-bot

Check if the input IP address is a Bot, robot, or otherwise a non-user entity. Leverages real-time signals to check against known high-probability bots..

IP address to check, 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

Request Example

"string"

200 OK

BotCheckResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "IsBot": "boolean"
}


Apikey

IPAddress

Perform a reverse domain name (DNS) lookup on an IP address

POST /validate/ip/reverse-domain-lookup

Gets the domain name, if any, associated with the IP address.

IP address to check, 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

Request Example

"string"

200 OK

IPReverseDNSLookupResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "HostName": "string"
}


Apikey

LeadEnrichment

Enrich an input lead with additional fields of data

POST /validate/lead-enrichment/lead/enrich

LeadEnrichmentRequest

Input lead with known fields set, and unknown fields left blank (null)

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "ContactBusinessEmail": "string",
  "ContactFirstName": "string",
  "ContactLastName": "string",
  "CompanyName": "string",
  "CompanyDomainName": "string",
  "CompanyHouseNumber": "string",
  "CompanyStreet": "string",
  "CompanyCity": "string",
  "CompanyStateOrProvince": "string",
  "CompanyPostalCode": "string",
  "CompanyCountry": "string",
  "CompanyCountryCode": "string",
  "CompanyTelephone": "string",
  "CompanyVATNumber": "string"
}

200 OK

LeadEnrichmentResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "LeadType": "string",
  "ContactBusinessEmail": "string",
  "ContactFirstName": "string",
  "ContactLastName": "string",
  "ContactGender": "string",
  "CompanyName": "string",
  "CompanyDomainName": "string",
  "CompanyHouseNumber": "string",
  "CompanyStreet": "string",
  "CompanyCity": "string",
  "CompanyStateOrProvince": "string",
  "CompanyPostalCode": "string",
  "CompanyCountry": "string",
  "CompanyCountryCode": "string",
  "CompanyTelephone": "string",
  "CompanyVATNumber": "string",
  "EmployeeCount": "integer (int32)"
}


Apikey

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

FullNameValidationRequest

Validation request information

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "FullNameString": "string"
}

200 OK

FullNameValidationResponse

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


Apikey

Name

Validate a first name

POST /validate/name/first

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

FirstNameValidationRequest

Validation request information

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "FirstName": "string"
}

200 OK

FirstNameValidationResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

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


Apikey

Name

Validate a last name

POST /validate/name/last

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

LastNameValidationRequest

Validation request information

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "LastName": "string"
}

200 OK

LastNameValidationResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

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


Apikey

Name

Get the gender of a first name

POST /validate/name/get-gender

Determines the gender of a first name (given name)

GetGenderRequest

Gender request information

Code Example:

Request Content-Types: application/json, text/json

Request Example

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

200 OK

GetGenderResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

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


Apikey

Name

Validate a code identifier

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

ValidateIdentifierRequest

Identifier validation request information

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "Input": "string",
  "AllowWhitespace": "boolean",
  "AllowHyphens": "boolean",
  "AllowUnderscore": "boolean",
  "AllowNumbers": "boolean",
  "AllowPeriods": "boolean",
  "MaxLength": "integer (int32)",
  "MinLength": "integer (int32)"
}

200 OK

ValidateIdentifierResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ValidIdentifier": "boolean",
  "Error": "string"
}


Apikey

PhoneNumber

Validate phone number (basic)

POST /validate/phonenumber/basic

Validate a phone number by analyzing the syntax

PhoneNumberValidateRequest

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

Request Example

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

200 OK

PhoneNumberValidationResponse

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


Apikey

TextInput

Check text input for Cross-Site-Scripting (XSS) attacks

POST /validate/text-input/check/xss

Detects XSS (Cross-Site-Scripting) attacks from text input.

User-facing text input.

Code Example:

Request Content-Types: application/json, text/json

Request Example

"string"

200 OK

XssProtectionResult

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "ContainedXss": "boolean",
  "OriginalInput": "string",
  "NormalizedResult": "string"
}


Apikey

TextInput

Protect text input from Cross-Site-Scripting (XSS) attacks through normalization

POST /validate/text-input/protect/xss

Detects and removes XSS (Cross-Site-Scripting) attacks from text input through normalization. Returns the normalized result, as well as information on whether the original input contained an XSS risk.

User-facing text input.

Code Example:

Request Content-Types: application/json, text/json

Request Example

"string"

200 OK

XssProtectionResult

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "ContainedXss": "boolean",
  "OriginalInput": "string",
  "NormalizedResult": "string"
}


Apikey

TextInput

Check and protect multiple text inputs for Cross-Site-Scripting (XSS) attacks in batch

POST /validate/text-input/check-and-protect/xss/batch

Detects XSS (Cross-Site-Scripting) attacks from multiple text input. Output preverses order of input items.

XssProtectionBatchRequest

User-facing text input.

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "RequestItems": [
    {
      "InputText": "string"
    }
  ]
}

200 OK

XssProtectionBatchResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "ResultItems": [
    {
      "Successful": "boolean",
      "ContainedXss": "boolean",
      "OriginalInput": "string",
      "NormalizedResult": "string"
    }
  ]
}


Apikey

UserAgent

Parse an HTTP User-Agent string, identify robots

POST /validate/useragent/parse

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.

UserAgentValidateRequest

Input parse request

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "UserAgentString": "string"
}

200 OK

UserAgentValidateResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "Successful": "boolean",
  "IsBot": "boolean",
  "BotName": "string",
  "BotURL": "string",
  "OperatingSystem": "string",
  "OperatingSystemCPUPlatform": "string",
  "OperatingSystemVersion": "string",
  "DeviceType": "string",
  "DeviceBrandName": "string",
  "DeviceModel": "string",
  "BrowserName": "string",
  "BrowserVersion": "string",
  "BrowserEngineName": "string",
  "BrowserEngineVersion": "string"
}


Apikey

Vat

Validate a VAT number

POST /validate/vat/lookup

Checks if a VAT code is valid, and if it is, returns more information about it. The first two letters of the VAT number must be letters that indicate the country, such as LU20260743. Possible country codes include Austria (AT), Belgium (BE), Bulgaria (BG), Cyprus (CY), Czech Republic (CZ), Germany (DE), Denmark (DK), Estonia (EE), Greece (EL), Spain (ES), Finland (FI), France (FR), United Kingdom (GB), Croatia (HR), Hungary (HU), Ireland (IE), Italy (IT), Lithuania (LT), Luxembourg (LU), Latvia (LV), Malta (MT), The Netherlands (NL), Poland (PL), Portugal (PT), Romania (RO), Sweden (SE), Slovenia (SI), Slovakia (SK).

VatLookupRequest

Input VAT code

Code Example:

Request Content-Types: application/json, text/json

Request Example

{
  "VatCode": "string"
}

200 OK

VatLookupResponse

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",
  "BusinessBuilding": "string",
  "BusinessStreetNumber": "string",
  "BusinessStreet": "string",
  "BusinessCity": "string",
  "BusinessStateOrProvince": "string",
  "BusinessPostalCode": "string",
  "BusinessCountry": "string"
}


Apikey

Schema Definitions

ParseAddressRequest: object

Request to parse an address formatted as a string/free text into a structured address

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

Example

{
  "AddressString": "string",
  "CapitalizationMode": "string"
}

ParseAddressResponse: object

Result of parsing an address into its component parts

Successful: boolean: True if the parsing operation was successful, false otherwise
Building: string: The name of the building, house or structure if applicable, such as "Cloudmersive Building 2". This will often by null.
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.
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".
City: string: The city of the address.
StateOrProvince: string: The state or province of the address.
PostalCode: string: The postal code or zip code of the address.
CountryFullName: string: Country of the address, if present in the address. If not included in the address it will be null.
ISOTwoLetterCode: string: Two-letter ISO 3166-1 country code

Example

{
  "Successful": "boolean",
  "Building": "string",
  "StreetNumber": "string",
  "Street": "string",
  "City": "string",
  "StateOrProvince": "string",
  "PostalCode": "string",
  "CountryFullName": "string",
  "ISOTwoLetterCode": "string"
}

ValidateAddressRequest: object

Request to Validate a Street Address

StreetAddress: string: Required; Street address to validate, such as '2950 Buskirk Ave.'
City: string: Required; City part of the addrerss to validate, such as 'Walnut Creek'
StateOrProvince: string: Required; State or province of the address to validate, such as 'CA' or 'California'
PostalCode: string: Optional (recommended); Zip code or postal code of the address to validate, such as '94597'
CountryFullName: string: Optional (recommended); Name of the country, such as 'United States'. If left blank, and CountryCode is also left blank, will default to United States. Global countries are supported.
CountryCode: string: Optional; two-letter country code (Two-letter ISO 3166-1 country code) of the country. If left blank, and CountryFullName is also left blank, will default to United States. Global countries are supported.

Example

{
  "StreetAddress": "string",
  "City": "string",
  "StateOrProvince": "string",
  "PostalCode": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}

ValidateAddressResponse: object

Result of validating a street address

ValidAddress: boolean: True if the address is valid, false otherwise
Latitude: number (double): If the address is valid, the degrees latitude of the validated address, null otherwise
Longitude: number (double): If the address is valid, the degrees longitude of the validated address, null otherwise

Example

{
  "ValidAddress": "boolean",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}

NormalizeAddressResponse: object

Result of validating a street address

ValidAddress: boolean: True if the address is valid, false otherwise
Building: string: The name of the building, house or structure if applicable, such as "Cloudmersive Building 2". This will often by null.
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.
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".
City: string: The city of the address.
StateOrProvince: string: The state or province of the address.
PostalCode: string: The postal code or zip code of the address.
CountryFullName: string: Country of the address, if present in the address. If not included in the address it will be null.
ISOTwoLetterCode: string: Two-letter ISO 3166-1 country code
Latitude: number (double): If the address is valid, the degrees latitude of the validated address, null otherwise
Longitude: number (double): If the address is valid, the degrees longitude of the validated address, null otherwise

Example

{
  "ValidAddress": "boolean",
  "Building": "string",
  "StreetNumber": "string",
  "Street": "string",
  "City": "string",
  "StateOrProvince": "string",
  "PostalCode": "string",
  "CountryFullName": "string",
  "ISOTwoLetterCode": "string",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}

ValidateCityRequest: object

Request to Validate a City and State or Province in a country

City: string: Required: City of the address to validate, such as 'San Francisco' or 'London'
StateOrProvince: string: Required: State or province of the address to validate, such as 'California' or 'CA'
CountryFullName: string: Optional (recommended); Name of the country, such as 'United States'. If left blank, and CountryCode is also left blank, will default to United States. Global countries are supported.
CountryCode: string: Optional; two-letter country code (Two-letter ISO 3166-1 country code) of the country. If left blank, and CountryFullName is also left blank, will default to United States. Global countries are supported.

Example

{
  "City": "string",
  "StateOrProvince": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}

ValidateCityResponse: object

Result of validating a city

ValidCity: boolean: True if the city is valid, false otherwise
City: string: If valid, City corresponding to the input postal code, such as 'Walnut Creek'
StateOrProvince: string: If valid; State or province corresponding to the input state name, such as 'CA' or 'California'
Latitude: number (double): If the postal code is valid, the degrees latitude of the centroid of the state, null otherwise
Longitude: number (double): If the postal code is valid, the degrees longitude of the centroid of the state, null otherwise

Example

{
  "ValidCity": "boolean",
  "City": "string",
  "StateOrProvince": "string",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}

ValidateStateRequest: object

Request to Validate a State or Province in a country

StateOrProvince: string: Required: State or province of the address to validate, such as 'California' or 'CA'
CountryFullName: string: Optional (recommended); Name of the country, such as 'United States'. If left blank, and CountryCode is also left blank, will default to United States. Global countries are supported.
CountryCode: string: Optional; two-letter country code (Two-letter ISO 3166-1 country code) of the country. If left blank, and CountryFullName is also left blank, will default to United States. Global countries are supported.

Example

{
  "StateOrProvince": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}

ValidateStateResponse: object

Result of validating a state

ValidState: boolean: True if the address is valid, false otherwise
StateOrProvince: string: If valid; State or province corresponding to the input state name, such as 'CA' or 'California'
Latitude: number (double): If the postal code is valid, the degrees latitude of the centroid of the state, null otherwise
Longitude: number (double): If the postal code is valid, the degrees longitude of the centroid of the state, null otherwise

Example

{
  "ValidState": "boolean",
  "StateOrProvince": "string",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}

ValidatePostalCodeRequest: object

Request to Validate a Postal Code

PostalCode: string: Required: Zip code or postal code of the address to validate, such as '94597'
CountryFullName: string: Optional (recommended); Name of the country, such as 'United States'. If left blank, and CountryCode is also left blank, will default to United States. Global countries are supported.
CountryCode: string: Optional; two-letter country code (Two-letter ISO 3166-1 country code) of the country. If left blank, and CountryFullName is also left blank, will default to United States. Global countries are supported.

Example

{
  "PostalCode": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}

ValidatePostalCodeResponse: object

Result of validating a postal code

ValidPostalCode: boolean: True if the Postal Code is valid, false otherwise
City: string: If valid, City corresponding to the input postal code, such as 'Walnut Creek'
StateOrProvince: string: If valid; State or province corresponding to the input postal code, such as 'CA' or 'California'
Latitude: number (double): If the postal code is valid, the degrees latitude of the centroid of the postal code, null otherwise
Longitude: number (double): If the postal code is valid, the degrees longitude of the centroid of the postal code, null otherwise

Example

{
  "ValidPostalCode": "boolean",
  "City": "string",
  "StateOrProvince": "string",
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}

ValidateCountryRequest: object

Input parameter to a country validation request

RawCountryInput: string: Raw country input - can be a two-letter code (FIPS 10-4 or ISO 3166-1), three-letter code (ISO 3166-1) or country name

Example

{
  "RawCountryInput": "string"
}

ValidateCountryResponse: object

Result of performing a country validation operation

Successful: boolean: True if successful, false otherwise
CountryFullName: string: Full name of the country
ISOTwoLetterCode: string: Two-letter ISO 3166-1 country code
FIPSTwoLetterCode: string: Two-letter FIPS 10-4 country code
ThreeLetterCode: string: Three-letter ISO 3166-1 country code
IsEuropeanUnionMember: boolean: True if this country is currently a member of the European Union (EU), false otherwise
Timezones: Timezone: Time zones (IANA/Olsen) in the country
Timezone
ISOCurrencyCode: string: ISO 4217 currency three-letter code associated with the country
CurrencySymbol: string: Symbol associated with the currency
CurrencyEnglishName: string: Full name of the currency
Region: string: Region (continent) in which the country is located; possible values are None, Europe, Americas, Asia, Africa, Oceania
Subregion: string: Subregion in which the country is located; possible values are None, NorthernEurope, WesternEurope, SouthernEurope, EasternEurope, CentralAmerica, NorthernAmerica, SouthAmerica, EasternAfrica, MiddleAfrica, NorthernAfrica , SouthernAfrica , WesternAfrica , CentralAsia , EasternAsia , SouthernAsia , SouthEasternAsia , WesternAsia , Southern , Middle , AustraliaandNewZealand , Melanesia , Polynesia , Micronesia , Caribbean,

Example

{
  "Successful": "boolean",
  "CountryFullName": "string",
  "ISOTwoLetterCode": "string",
  "FIPSTwoLetterCode": "string",
  "ThreeLetterCode": "string",
  "IsEuropeanUnionMember": "boolean",
  "Timezones": [
    {
      "Name": "string",
      "BaseUTCOffset": "string",
      "Now": "string (date-time)"
    }
  ],
  "ISOCurrencyCode": "string",
  "CurrencySymbol": "string",
  "CurrencyEnglishName": "string",
  "Region": "string",
  "Subregion": "string"
}

Timezone: object

IANA/Olsen time zone

Name: string: Name of the Time Zone
BaseUTCOffset: string: UTC offset for this time zone
Now: string (date-time): The current time (Now) in this time zone

Example

{
  "Name": "string",
  "BaseUTCOffset": "string",
  "Now": "string (date-time)"
}

CountryListResult: object

Result of enumerating available countries

Successful: boolean: True if the operation was successful, false otherwise
Countries: CountryDetails: List of current ISO 3166-1 countries in the world
CountryDetails

Example

{
  "Successful": "boolean",
  "Countries": [
    {
      "CountryName": "string",
      "ThreeLetterCode": "string",
      "ISOTwoLetterCode": "string",
      "IsEuropeanUnionMember": "boolean",
      "ISOCurrencyCode": "string",
      "CurrencySymbol": "string",
      "CurrencyEnglishName": "string",
      "Region": "string",
      "Subregion": "string"
    }
  ]
}

CountryDetails: object

Details of one country

CountryName: string: Name of the country
ThreeLetterCode: string: Three-letter ISO 3166-1 country code
ISOTwoLetterCode: string: Two-letter ISO 3166-1 country code
IsEuropeanUnionMember: boolean: True if this country is currently a member of the European Union (EU), false otherwise
ISOCurrencyCode: string: ISO 4217 currency three-letter code associated with the country
CurrencySymbol: string: Symbol associated with the currency
CurrencyEnglishName: string: Full name of the currency
Region: string: Region (continent) in which the country is located; possible values are None, Europe, Americas, Asia, Africa, Oceania
Subregion: string: Subregion in which the country is located; possible values are None, NorthernEurope, WesternEurope, SouthernEurope, EasternEurope, CentralAmerica, NorthernAmerica, SouthAmerica, EasternAfrica, MiddleAfrica, NorthernAfrica , SouthernAfrica , WesternAfrica , CentralAsia , EasternAsia , SouthernAsia , SouthEasternAsia , WesternAsia , Southern , Middle , AustraliaandNewZealand , Melanesia , Polynesia , Micronesia , Caribbean,

Example

{
  "CountryName": "string",
  "ThreeLetterCode": "string",
  "ISOTwoLetterCode": "string",
  "IsEuropeanUnionMember": "boolean",
  "ISOCurrencyCode": "string",
  "CurrencySymbol": "string",
  "CurrencyEnglishName": "string",
  "Region": "string",
  "Subregion": "string"
}

GetTimezonesRequest: object

Request to get time zones for a country

CountryCodeOrName: string: Can be the two-letter, three-letter country codes or country name

Example

{
  "CountryCodeOrName": "string"
}

GetTimezonesResponse: object

Result of performing a get time zones operation

Successful: boolean: True if successful, false otherwise
CountryFullName: string: Full name of the country
ISOTwoLetterCode: string: Two-letter ISO 3166-1 country code
FIPSTwoLetterCode: string: Two-letter FIPS 10-4 country code
ThreeLetterCode: string: Three-letter ISO 3166-1 country code
Timezones: Timezone: Time zones (IANA/Olsen) in the country
Timezone

Example

{
  "Successful": "boolean",
  "CountryFullName": "string",
  "ISOTwoLetterCode": "string",
  "FIPSTwoLetterCode": "string",
  "ThreeLetterCode": "string",
  "Timezones": [
    {
      "Name": "string",
      "BaseUTCOffset": "string",
      "Now": "string (date-time)"
    }
  ]
}

ReverseGeocodeAddressRequest: object

Request to reverse geocode a Street Address

Latitude: number (double): Latitude coordinate in WGS84 format
Longitude: number (double): Longitude coordinate in WGS84 format

Example

{
  "Latitude": "number (double)",
  "Longitude": "number (double)"
}

ReverseGeocodeAddressResponse: object

Result of reverse geocoding a street address

Successful: boolean: True if the address operation was successful, false otherwise
StreetAddress: string: Street address to validate, such as '2950 Buskirk Ave.'
City: string: City part of the addrerss to validate, such as 'Walnut Creek'
StateOrProvince: string: State or province of the address to validate, such as 'CA' or 'California'
PostalCode: string: Zip code or postal code of the address to validate, such as '94597'
CountryFullName: string: Name of the country, such as 'United States'. Global countries are supported.
CountryCode: string: Three-letter ISO 3166-1 country code

Example

{
  "Successful": "boolean",
  "StreetAddress": "string",
  "City": "string",
  "StateOrProvince": "string",
  "PostalCode": "string",
  "CountryFullName": "string",
  "CountryCode": "string"
}

DateTimeNowResult: object

Current date and time response

Successful: boolean: True if successful, false otherwise
Now: string (date-time): Current date, time, and time zone in standard JSON date format
NowGmt: string (date-time): Current GMT-time-zone date, time, and time zone in standard JSON date format

Example

{
  "Successful": "boolean",
  "Now": "string (date-time)",
  "NowGmt": "string (date-time)"
}

GetPublicHolidaysRequest: object

Input parameter to a country validation request

RawCountryInput: string: Two-letter code (FIPS 10-4 or ISO 3166-1) of the country; if not specified, defaults to United States
Year: integer (int32): Optional - the year in which to retrieve the holidays; if left blank (0) it will default to the current year

Example

{
  "RawCountryInput": "string",
  "Year": "integer (int32)"
}

PublicHolidaysResponse: object

Result of performing a get public holidays request operation

Successful: boolean: True if successful, false otherwise
PublicHolidays: PublicHolidayOccurrence: Public holidays in the requested country and year
PublicHolidayOccurrence

Example

{
  "Successful": "boolean",
  "PublicHolidays": [
    {
      "EnglishName": "string",
      "LocalName": "string",
      "OccurrenceDate": "string (date-time)",
      "HolidayType": "string",
      "Nationwaide": "boolean"
    }
  ]
}

PublicHolidayOccurrence: object

Public holiday occurrence

EnglishName: string: Name of the holiday in English
LocalName: string: Local name of the holiday
OccurrenceDate: string (date-time): Date of the holiday (start time)
HolidayType: string: Type of the holiday; possible values are: Public, Bank, School, Authorities, Optional, Observance
Nationwaide: boolean: True if the holiday is celebrated in all locales in the country, false otherwise

Example

{
  "EnglishName": "string",
  "LocalName": "string",
  "OccurrenceDate": "string (date-time)",
  "HolidayType": "string",
  "Nationwaide": "boolean"
}

DateTimeStandardizedParseRequest: object

Input parameter to a date time parsing request

RawDateTimeInput: string: Raw string input of a standard-formatted date and time for parsing
CountryCode: string: Optional: specify the two-letter country code to optimzie date formatting; default is US

Example

{
  "RawDateTimeInput": "string",
  "CountryCode": "string"
}

DateTimeStandardizedParseResponse: object

Result of performing a date time parsing

Successful: boolean: True if successful, false otherwise
ParsedDateResult: string (date-time): Result of performing a date time parsing
Year: integer (int32): Year of the parsed date time result
Month: integer (int32): Month of the parsed date time result
Day: integer (int32): Day of the parsed date time result
Hour: integer (int32): Hour of the parsed date time result (24-hour)
Minute: integer (int32): Minute of the parsed date time result
Second: integer (int32): Second of the parsed date time result
DayOfWeek: string: Day of week

Example

{
  "Successful": "boolean",
  "ParsedDateResult": "string (date-time)",
  "Year": "integer (int32)",
  "Month": "integer (int32)",
  "Day": "integer (int32)",
  "Hour": "integer (int32)",
  "Minute": "integer (int32)",
  "Second": "integer (int32)",
  "DayOfWeek": "string"
}

DateTimeNaturalLanguageParseRequest: object

Input parameter to a date time parsing request

RawDateTimeInput: string: Raw string input of a natural language-formatted date and time for parsing

Example

{
  "RawDateTimeInput": "string"
}

CheckResponse: object

Result of a validation operation

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

Example

{
  "ValidDomain": "boolean"
}

DomainQualityResponse: object

Result of performing a domain quality score operation

DomainQualityScore: number (double): The quality score of the domain name; possible values are 0.0 to 10.0 with 10.0 being the highest and 0.0 being the lowest quality.

Example

{
  "DomainQualityScore": "number (double)"
}

WhoisResponse: object

Result of a WHOIS operation

ValidDomain: boolean: True if the domain is valid, false if it is not
RegistrantName: string: Name of the domain registrant
RegistrantOrganization: string: Organization name of the domain registrant
RegistrantEmail: string: Email address of the domain registrant
RegistrantStreetNumber: string: Street number of the address of the domain registrant, if available
RegistrantStreet: string: Street name of the address of the domain registrant, if available
RegistrantCity: string: City of the domain registrant, if available
RegistrantStateOrProvince: string: State or Province of the address of the domain registrant, if available
RegistrantPostalCode: string: Postal code of the address of the domain registrant, if available
RegistrantCountry: string: Country of the address of the domain registrant, if available
RegistrantRawAddress: string: Raw address string of the domain registrant, if available
RegistrantTelephone: string: Telephone number of the address of the domain registrant
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",
  "RegistrantName": "string",
  "RegistrantOrganization": "string",
  "RegistrantEmail": "string",
  "RegistrantStreetNumber": "string",
  "RegistrantStreet": "string",
  "RegistrantCity": "string",
  "RegistrantStateOrProvince": "string",
  "RegistrantPostalCode": "string",
  "RegistrantCountry": "string",
  "RegistrantRawAddress": "string",
  "RegistrantTelephone": "string",
  "WhoisServer": "string",
  "RawTextRecord": "string",
  "CreatedDt": "string (date-time)"
}

ValidateUrlRequestSyntaxOnly: object

Request to determine if a URL is valid

URL: string: URL to validate

Example

{
  "URL": "string"
}

ValidateUrlResponseSyntaxOnly: object

Result of validating a URL with syntax only

ValidURL: boolean: True if the URL is valid, false otherwise
WellFormedURL: string: Well-formed version of the URL
TopLevelDomainName: string: The top-level domain name of the URL, e.g. mydomain.com

Example

{
  "ValidURL": "boolean",
  "WellFormedURL": "string",
  "TopLevelDomainName": "string"
}

ValidateUrlRequestFull: object

Request to determine if a URL is valid

URL: string: URL to validate

Example

{
  "URL": "string"
}

ValidateUrlResponseFull: object

Result of validating a URL with full validation

ValidURL: boolean: True if the URL has valid syntax, a valid domain, a valid endpoint, and passes virus scan checks; false otherwise
Valid_Syntax: boolean: True if the URL has valid syntax, 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
WellFormedURL: string: Well-formed version of the URL

Example

{
  "ValidURL": "boolean",
  "Valid_Syntax": "boolean",
  "Valid_Domain": "boolean",
  "Valid_Endpoint": "boolean",
  "WellFormedURL": "string"
}

UrlSsrfRequestFull: object

Request to determine if a URL is an SSRF threat check

URL: string: URL to validate
BlockedDomains: string[]: Top level domains that you do not want to allow access to, e.g. mydomain.com - will block all subdomains as well
string

Example

{
  "URL": "string",
  "BlockedDomains": [
    "string"
  ]
}

UrlSsrfResponseFull: object

Result of checking a URL for SSRF threats

CleanURL: boolean: True if the URL is clean, false if it is at risk of containing an SSRF threat or attack
ThreatLevel: string: Threat level of the URL; possible values are High, Medium, Low and None

Example

{
  "CleanURL": "boolean",
  "ThreatLevel": "string"
}

UrlSsrfRequestBatch: object

Batch operation to perform SSRF threat checks on multiple URLs

InputItems: UrlSsrfRequestFull: Input URLs to check for SSRF threats
UrlSsrfRequestFull

Example

{
  "InputItems": [
    {
      "URL": "string",
      "BlockedDomains": [
        "string"
      ]
    }
  ]
}

UrlSsrfResponseBatch: object

Result of performing SSRF threat checks on multiple URLs

OutputItems: UrlSsrfResponseFull: Results of the operation, with indexes matched to input values
UrlSsrfResponseFull

Example

{
  "OutputItems": [
    {
      "CleanURL": "boolean",
      "ThreatLevel": "string"
    }
  ]
}

AddressVerifySyntaxOnlyResponse: object

Syntactic validity of email address

ValidAddress: boolean: True if the email address is syntactically valid, false if it is not
Domain: string: Domain name of the email address
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.
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.

Example

{
  "ValidAddress": "boolean",
  "Domain": "string",
  "IsFreeEmailProvider": "boolean",
  "IsDisposable": "boolean"
}

AddressGetServersResponse: object

Result of a partial email address validation

Success: boolean: True if partial address validation was successufl, false otherwise
Servers: string[]: Email servers for this email address
string

Example

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

FullEmailValidationResponse: object

Full email addresss validation result

ValidAddress: boolean: True if the email address is valid overall, false otherwise
MailServerUsedForValidation: string: Email server connected to for verification
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.
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.
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.
Domain: string: Domain name of the email address
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.
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.

Example

{
  "ValidAddress": "boolean",
  "MailServerUsedForValidation": "string",
  "Valid_Syntax": "boolean",
  "Valid_Domain": "boolean",
  "Valid_SMTP": "boolean",
  "IsCatchallDomain": "boolean",
  "Domain": "string",
  "IsFreeEmailProvider": "boolean",
  "IsDisposable": "boolean"
}

IPIntelligenceResponse: object

IP address intelligence result

IsBot: boolean: True if the IP address is a known bot, otherwise false
IsTorNode: boolean: True if the IP address is a known Tor exit node, otherwise false
IsThreat: boolean: True if the IP address is a known threat IP, otherwise false
IsEU: boolean: True if the IP address is in the European Union, otherwise false
Location: GeolocateResponse: Returns the location of the IP address
CurrencyCode: string: ISO 4217 currency code for the IP address location
CurrencyName: string: Name of the currency in English
RegionArea: string: Region (continent) in which the country is located; possible values are None, Europe, Americas, Asia, Africa, Oceania
SubregionArea: string: Subregion in which the country is located; possible values are None, NorthernEurope, WesternEurope, SouthernEurope, EasternEurope, CentralAmerica, NorthernAmerica, SouthAmerica, EasternAfrica, MiddleAfrica, NorthernAfrica , SouthernAfrica , WesternAfrica , CentralAsia , EasternAsia , SouthernAsia , SouthEasternAsia , WesternAsia , Southern , Middle , AustraliaandNewZealand , Melanesia , Polynesia , Micronesia , Caribbean,

Example

{
  "IsBot": "boolean",
  "IsTorNode": "boolean",
  "IsThreat": "boolean",
  "IsEU": "boolean",
  "Location": {
    "CountryCode": "string",
    "CountryName": "string",
    "City": "string",
    "RegionCode": "string",
    "RegionName": "string",
    "ZipCode": "string",
    "TimezoneStandardName": "string",
    "Latitude": "number (double)",
    "Longitude": "number (double)"
  },
  "CurrencyCode": "string",
  "CurrencyName": "string",
  "RegionArea": "string",
  "SubregionArea": "string"
}

GeolocateResponse: object

Geolocation result of performing an IP address geolocation operation. This product includes GeoLite2 data created by MaxMind, available from www.maxmind.com.

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)"
}

GeolocateStreetAddressResponse: object

Geolocation street address result

CountryCode: string: Two-letter country code of IP address
CountryName: string: Country name of IP address
StreetAddress: string: Street address of IP address
City: string: City of IP address
RegionName: string: State/region of IP address
ZipCode: string: Zip or postal code of IP address

Example

{
  "CountryCode": "string",
  "CountryName": "string",
  "StreetAddress": "string",
  "City": "string",
  "RegionName": "string",
  "ZipCode": "string"
}

IPThreatResponse: object

Result of performing a IP threat check on an IP address

IsThreat: boolean: True if the input IP address is a threat, false otherwise
ThreatType: string: Specifies the type of IP threat; possible values include Blocklist, Botnet, WebBot

Example

{
  "IsThreat": "boolean",
  "ThreatType": "string"
}

TorNodeResponse: object

Result of performing a Tor node check on an IP address

IsTorNode: boolean: True if the input IP address is a Tor exit node, false otherwise

Example

{
  "IsTorNode": "boolean"
}

BotCheckResponse: object

Result of performing a Bot check on an IP address

IsBot: boolean: True if the input IP address is a Bot or Robot, false otherwise

Example

{
  "IsBot": "boolean"
}

IPReverseDNSLookupResponse: object

Result of performing a Reverse Domain (DNS) lookup on an IP address

Successful: boolean: True if a domain was found, false otherwise
HostName: string: Host name (fully-qualified) associated with the IP address, if any

Example

{
  "Successful": "boolean",
  "HostName": "string"
}

LeadEnrichmentRequest: object

Input lead contact; fill in known fields to extend them with matched field values

ContactBusinessEmail: string: The person's business email address for the lead
ContactFirstName: string: The person's first name for the lead
ContactLastName: string: The person's last name for the lead
CompanyName: string: Name of the company for the lead
CompanyDomainName: string: Domain name / website for the lead
CompanyHouseNumber: string: House number of the address of the company for the lead
CompanyStreet: string: Street name of the address of the company for the lead
CompanyCity: string: City of the address of the company for the lead
CompanyStateOrProvince: string: State or Province of the address of the company for the lead
CompanyPostalCode: string: Postal Code of the address of the company for the lead
CompanyCountry: string: Country of the address of the company for the lead
CompanyCountryCode: string: Country Code (2-letter ISO 3166-1) of the address of the company for the lead
CompanyTelephone: string: Telephone of the company office for the lead
CompanyVATNumber: string: VAT number of the company for the lead

Example

{
  "ContactBusinessEmail": "string",
  "ContactFirstName": "string",
  "ContactLastName": "string",
  "CompanyName": "string",
  "CompanyDomainName": "string",
  "CompanyHouseNumber": "string",
  "CompanyStreet": "string",
  "CompanyCity": "string",
  "CompanyStateOrProvince": "string",
  "CompanyPostalCode": "string",
  "CompanyCountry": "string",
  "CompanyCountryCode": "string",
  "CompanyTelephone": "string",
  "CompanyVATNumber": "string"
}

LeadEnrichmentResponse: object

Result of the lead enrichment process

Successful: boolean: True if the operation was successful, false otherwise
LeadType: string: The type of the lead; possible types are Junk (a single individual using a disposable/throwaway email address); Individual (a single individual, typically a consumer, not purchasing on behalf of a business); SmallBusiness (a small business, typically with fewer than 100 employees); MediumBusiness (a medium business, larger than 100 employees but fewer than 1000 employees); Enterprise (a large business with greater than 1000 employees); Business (a business customer of unknown size)
ContactBusinessEmail: string: The person's business email address for the lead
ContactFirstName: string: The person's first name for the lead
ContactLastName: string: The person's last name for the lead
ContactGender: string: Gender for contact name; possible values are Male, Female, and Neutral (can be applied to Male or Female). Requires ContactFirstName.
CompanyName: string: Name of the company for the lead
CompanyDomainName: string: Domain name / website for the lead
CompanyHouseNumber: string: House number of the address of the company for the lead
CompanyStreet: string: Street name of the address of the company for the lead
CompanyCity: string: City of the address of the company for the lead
CompanyStateOrProvince: string: State or Province of the address of the company for the lead
CompanyPostalCode: string: Postal Code of the address of the company for the lead
CompanyCountry: string: Country Name of the address of the company for the lead
CompanyCountryCode: string: Country Code (2-letter ISO 3166-1) of the address of the company for the lead
CompanyTelephone: string: Telephone of the company office for the lead
CompanyVATNumber: string: VAT number of the company for the lead
EmployeeCount: integer (int32): Count of employees at the company (estimated), if available

Example

{
  "Successful": "boolean",
  "LeadType": "string",
  "ContactBusinessEmail": "string",
  "ContactFirstName": "string",
  "ContactLastName": "string",
  "ContactGender": "string",
  "CompanyName": "string",
  "CompanyDomainName": "string",
  "CompanyHouseNumber": "string",
  "CompanyStreet": "string",
  "CompanyCity": "string",
  "CompanyStateOrProvince": "string",
  "CompanyPostalCode": "string",
  "CompanyCountry": "string",
  "CompanyCountryCode": "string",
  "CompanyTelephone": "string",
  "CompanyVATNumber": "string",
  "EmployeeCount": "integer (int32)"
}

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

ValidateIdentifierRequest: object

Identifier validation request, including the input identifier as well as various identifier rules

Input: string: Text string identifier input
AllowWhitespace: boolean: True if whitespace is allowed in the identifier, false otherwise
AllowHyphens: boolean: True if hyphens are allowd in the identifier, false otherwise
AllowUnderscore: boolean: True if underscores are allowed 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
MaxLength: integer (int32): Optional; maximum length, if any, of the identifier
MinLength: integer (int32): Optional; minimum length, if any, of the identifier

Example

{
  "Input": "string",
  "AllowWhitespace": "boolean",
  "AllowHyphens": "boolean",
  "AllowUnderscore": "boolean",
  "AllowNumbers": "boolean",
  "AllowPeriods": "boolean",
  "MaxLength": "integer (int32)",
  "MinLength": "integer (int32)"
}

ValidateIdentifierResponse: object

Result of performing an identifier validation operation

ValidIdentifier: boolean: True if the input identifier is valid, false otherwise
Error: string: Resulting error from the identifier validation; possible errors are: "InputIsEmpty", "ContainsWhitespace", "ContainsNumbers", "ContainsHyphen", "ContainsUnderscore", "ContainsPeriod", "TooShort", "TooLong", "ContainsSpecialCharacters"

Example

{
  "ValidIdentifier": "boolean",
  "Error": "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"
}

XssProtectionResult: object

Result of performing an XSS protection operation

Successful: boolean: True if the operation was successful, false otherwise
ContainedXss: boolean: True if the input contained XSS scripting, false otherwise
OriginalInput: string: Original input string
NormalizedResult: string: Normalized string result, with XSS removed

Example

{
  "Successful": "boolean",
  "ContainedXss": "boolean",
  "OriginalInput": "string",
  "NormalizedResult": "string"
}

XssProtectionBatchRequest: object

Input to a batch XSS protection operation

RequestItems: XssProtectionRequestItem: Multiple items to protect for XSS
XssProtectionRequestItem

Example

{
  "RequestItems": [
    {
      "InputText": "string"
    }
  ]
}

XssProtectionRequestItem: object

Individual item to protect for XSS

InputText: string: Individual input text item to protect from XSS

Example

{
  "InputText": "string"
}

XssProtectionBatchResponse: object

Result of performing a batch XSS protection operation

ResultItems: XssProtectionResult: Results from performing a batch XSS protection operation
XssProtectionResult

Example

{
  "ResultItems": [
    {
      "Successful": "boolean",
      "ContainedXss": "boolean",
      "OriginalInput": "string",
      "NormalizedResult": "string"
    }
  ]
}

UserAgentValidateRequest: object

User-Agent parse and validation request

UserAgentString: string: The user agent string you wish to parse and validate

Example

{
  "UserAgentString": "string"
}

UserAgentValidateResponse: object

The result of a User-Agent validation request

Successful: boolean: True if the operation was successful, false otherwise
IsBot: boolean: True if the request is a known robot, false otherwise
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
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)
DeviceType: string: Device type of the User-Agent; possible values are "DESKTOP", "SMARTPHONE", "TABLET"
DeviceBrandName: string: Brand name of the User-Agent
DeviceModel: string: Model name or number of the User-Agent
BrowserName: string: Name of the Browser
BrowserVersion: string: Version of the Browser
BrowserEngineName: string: Name of the Browser Engine
BrowserEngineVersion: string: Version of the Browser Engine

Example

{
  "Successful": "boolean",
  "IsBot": "boolean",
  "BotName": "string",
  "BotURL": "string",
  "OperatingSystem": "string",
  "OperatingSystemCPUPlatform": "string",
  "OperatingSystemVersion": "string",
  "DeviceType": "string",
  "DeviceBrandName": "string",
  "DeviceModel": "string",
  "BrowserName": "string",
  "BrowserVersion": "string",
  "BrowserEngineName": "string",
  "BrowserEngineVersion": "string"
}

VatLookupRequest: object

Input to a VAT lookup request

VatCode: string: VAT code to lookup; example "CZ25123891"

Example

{
  "VatCode": "string"
}

VatLookupResponse: object

CountryCode: string: Two-letter country code
VatNumber: string: VAT number
IsValid: boolean: True if the VAT code is valid, false otherwise
BusinessName: string: Name of the business
BusinessAddress: string: Business address as a single string
BusinessBuilding: string: For the business address, the name of the building, house or structure if applicable, such as "Cloudmersive Building 2". This will often by null.
BusinessStreetNumber: string: For the business address, 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.
BusinessStreet: string: For the business address, 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".
BusinessCity: string: For the business address, the city of the address.
BusinessStateOrProvince: string: For the business address, the state or province of the address.
BusinessPostalCode: string: For the business address, the postal code or zip code of the address.
BusinessCountry: string: For the business address, country of the address, if present in the address. If not included in the address it will be null.

Example

{
  "CountryCode": "string",
  "VatNumber": "string",
  "IsValid": "boolean",
  "BusinessName": "string",
  "BusinessAddress": "string",
  "BusinessBuilding": "string",
  "BusinessStreetNumber": "string",
  "BusinessStreet": "string",
  "BusinessCity": "string",
  "BusinessStateOrProvince": "string",
  "BusinessPostalCode": "string",
  "BusinessCountry": "string"
}