CAPTCHA Options

Options can be specified as a JSON object that is passed as the value of the options parameter in a POST request. See Quick Startfor a detailed example.

We have developed a Java client to simplify some of these operations. If you'd like to access this client please contact us.

Basic
A JSON object containing the following:
backgroundColorsarray of hexadecimal color code string
a set of colors eligible to be the background color of the CAPTCHA
default value: ["fafafa"]
includeLineBackgroundboolean
if true, the CAPTCHA will have a background of colorful lines
lineColorsarray of hexadecimal color code string
a set of colors eligible to be the in the line background of the CAPTCHA
default value: ["9b1111", "2d5fc4", "e27909", "027a36", "424242", "35259b", "22730e"]
maxAttemptsnumber
the maximum number of attempts that can be made on a CAPTCHA
default value: 5
sizestring
size of the CAPTCHA ("small", "medium" or "large")
default value: "medium"
textColors(optional)array of hexadecimal color code string
a set of colors eligible to be the text color of the CAPTCHA
default value: ["9b1111"]
validCharactersarray of characters
a set of characters eligible to be included in the CAPTCHA
default value: NaN'k', 'n', 'r', 't', 'y', 'A', 'B', 'D', 'E', 'F', 'G', 'H', 'J', 'K', 'L', 'N', 'Q', 'R', 'T', 'Y', '3', '4', '6', '7', '8']
Date
A JSON object containing the following:
backgroundColorsarray of hexadecimal color code string
a set of colors eligible to be the background color of the CAPTCHA
default value: ["fafafa"]
maxAttemptsnumber
the maximum number of attempts that can be made on a CAPTCHA
default value: 5
sizestring
size of the CAPTCHA ("small", "medium" or "large")
default value: "medium"
Math
A JSON object containing the following:
backgroundColorsarray of hexadecimal color code string
a set of colors eligible to be the background color of the CAPTCHA
default value: ["fafafa"]
includeLineBackgroundboolean
if true, the CAPTCHA will have a background of colorful lines
default value: false
includeParenthesesboolean
if true, expressions with more than two terms will use parentheses
lineColorsarray of hexadecimal color code string
a set of colors eligible to be the in the line background of the CAPTCHA
default value: ["9b1111", "2d5fc4", "e27909", "027a36", "424242", "35259b", "22730e"]
maxAttemptsnumber
the maximum number of attempts that can be made on a CAPTCHA
default value: 5
sizestring
size of the CAPTCHA ("small", "medium" or "large")
default value: "medium"
textColors(optional)array of hexadecimal color code string
a set of colors eligible to be the text color of the CAPTCHA
default value: ["9b1111", "2d5fc4", "e27909", "027a36", "424242", "35259b", "22730e"]
Naval Command
A JSON object containing the following:
backgroundColorsarray of hexadecimal color code string
a set of colors eligible to be the background color of the CAPTCHA
default value: ["22347d"]
maxAttemptsnumber
the maximum number of attempts that can be made on a CAPTCHA
default value: 5
sizestring
size of the CAPTCHA ("small", "medium" or "large")
default value: "medium"
Path
A JSON object containing the following:
backgroundColorsarray of hexadecimal color code string
a set of colors eligible to be the background color of the CAPTCHA
default value: ["333333"]
maxAttemptsnumber
the maximum number of attempts that can be made on a CAPTCHA
default value: 5
maxPathLengthnumber
maximum length for the path (must be greater than 2 and less than 21)
default value: 15
minPathLengthnumber
minimum length for the path (must be greater than 2 and less than 21)
default value: 10
pathColorsarray of hexadecimal color code string
a set of colors eligible to be the color of the path
default value: ["808080"]
resetTextstring
the text to be displayed on the reset button
default value: "Start over"
sizestring
size of the CAPTCHA ("small", "medium" or "large")
default value: "medium"
squareColorsarray of hexadecimal color code string
a set of colors eligible to be the color of the moveable square
default value: ["ff0000"]
Split
A JSON object containing the following:
backgroundColorsarray of hexadecimal color code string
a set of colors eligible to be the background color of the CAPTCHA
default value: ["e5e5e5"]
imageSetsarray of strings
which sets of images should be included (options are "pictures" or "strings")
default value: ["pictures", "strings"]
maxAttemptsnumber
the maximum number of attempts that can be made on a CAPTCHA
default value: 5
resetTextstring
the text to be displayed on the reset button
default value: "Start over"
sizestring
size of the CAPTCHA ("small", "medium" or "large")
default value: "medium"
Spotter
A JSON object containing the following:
backgroundColorsarray of hexadecimal color code string
a set of colors eligible to be the background color of the CAPTCHA
default value: ["fafafa"]
includeLineBackgroundboolean
if true, the CAPTCHA will have a background of colorful lines
default value: false
keyShapesarray of strings
which types of shapes are eligible to be the key shape (options are "circle", "star", "square" or "triangle")
default value: ["circle", "star", "triangle", "square"]
lineColorsarray of hexadecimal color code string
a set of colors eligible to be the in the line background of the CAPTCHA
default value: ["9b1111", "2d5fc4", "e27909", "027a36", "424242", "35259b", "22730e"]
maxAttemptsnumber
the maximum number of attempts that can be made on a CAPTCHA
default value: 5
maxKeyShapesnumber
minimum number of key shapes to be included (must be greater than 0 and less than 21)
default value: 5
maxShapesnumber
minimum number of total shapes to be included (must be greater than 0 and less than 21)
default value: 15
minKeyShapesnumber
minimum number of key shapes to be included (must be greater than 0 and less than 21)
default value: 3
minShapesnumber
minimum number of total shapes to be included (must be greater than 0 and less than 21)
default value: 10
nonKeyShapesarray of strings
which types of shapes are eligible to be non-key shapes (options are "circle", "star", "square" or "triangle")
default value: ["circle", "star", "triangle", "square"]
onlyIncludeKeyShapeboolean
if true, only the key shape type will be included
default value: false
resetTextstring
the text to be displayed on the reset button
default value: "Start over"
shapeColorsarray of hexadecimal color code string
a set of colors for the shapes
default value: ["9b1111", "2d5fc4", "e27909", "027a36", "424242", "35259b", "22730e"]
sizestring
size of the CAPTCHA ("small", "medium" or "large")
default value: "medium"
Substring
A JSON object containing the following:
backgroundColorsarray of hexadecimal color code string
a set of colors eligible to be the background color of the CAPTCHA
default value: ["fafafa"]
includeLineBackgroundboolean
if true, the CAPTCHA will have a background of colorful lines
default value: false
lineColorsarray of hexadecimal color code string
a set of colors eligible to be the in the line background of the CAPTCHA
default value: ["9b1111", "2d5fc4", "e27909", "027a36", "424242", "35259b", "22730e"]
maxAttemptsnumber
the maximum number of attempts that can be made on a CAPTCHA
default value: 5
sizestring
size of the CAPTCHA ("small", "medium" or "large")
default value: "medium"
textColors(optional)array of hexadecimal color code string
a set of colors eligible to be the text color of the CAPTCHA
default value: ["9b1111"]