API Documentation

With the WebSanitize API you can make requests to have text scanned for profanity or undesirable words and then replaced with either a character or alternative word.

All URLs referenced in the documentation have the following base:


HTTP Request to the API are protected using you API key placed in the header of the request.

How to sanitize a message
To sanitise a message
An example cURL request would be:

curl -XPOST -H 'x-api-key: This1sN0tS3cure' \
-H "Content-type: application/json" \
-d '{"filter":"word", "message":"What the fuck man!"}' \

Parameter Description
Content-type - required application/json
message - required The message string or body that needs to be inspected and sanitized
filter - optional If you want a word or character swap. By default this is 'word'


An example response is:

{"JobID":"O47ILVfzoLQiggDENAtenJARYP9pW7","MessageAlert":true,"OriginalMessage":"What the fuck man!","CleanerMessage":"what the duck man!"}

Parameter Description
JobID - String The ID of this request
MessageAlert - true/false A true or false flag that identifies if the message contained banned words
OriginalMessage - String The original message in its raw unedited format
CleanerMessage - String The processed message with banned words replaced