Request a Demo

webpurify.live.return

A profanity search method. Returns the number of profane words found and a list of the profane words. 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 response time in the result. set = 1
format (Optional)
Response format: xml or json. Defaults to xml.
cdata (Optional)
Set equal to 1 to wrap the listed words in <![CDATA[ ]]>
Use this if you plan on passing strings that may break XML (ie “<” and “&”).
Example XML Response
<?xml version="1.0" encoding="utf-8" ?>
<rsp stat="ok">
  <method>webpurify.live.return</method>
  <format>rest</format>
  <found>2</found>
  <expletive>profane1</expletive>
  <expletive>profane2</expletive>
  <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.
HTTP 503
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.