WebPurify™ Profanity Filter | Documentation | Methods

webpurify.live.check

A profanity checking method. If profanity is found it returns 1. If the text is clean 0 (zero) is returned.

Arguments

api_key (Required): Your API application key.
text (Required): the text you want checked for profanity.
lang (Optional): the 2 letter language code for the text you are submitting.
More information on languages can be found here.
semail (Optional): treat email addresses like profanity. set = 1
sphone (Optional): treat phone numbers like profanity. set = 1
slink (Optional): treat urls like profanity. set = 1
rsp (Optional): To include our reponse time in the result. set = 1
format (Optional): Response format: xml or json. Defaults to xml.

Example XML Response

<?xml version="1.0" encoding="utf-8" ?> 
<rsp stat="ok">
  <method>webpurify.live.check</method> 
  <format>rest</format> 
  <found>1</found>
  <api_key>api_key</api_key> 
</rsp>

Error Codes

100: Invalid API Key: The API key passed was not valid.
101: API Key is inactive: The API key passed is inactive or has been revoked.
102: API Key was not included in request: this method requires an API Key.
103: Service currently unavailable: The requested service is temporarily unavailable.
104: Rate limit exceeded: You have exceeded the number of simultaneous requests for your license.
Please go to: http://www.webpurify.com/pricing to see the limits for your license.