Sign in

v1

latestSwagger 2.02026-07-173611.2 KB
CoreApi

Verify the CAPTCHA solution,

The response will tell you whether the CAPTCHA solution is valid and hasn't been used before. If you receive a response code other than 200 in production, you should probably accept the user's form despite not having been able to verify the CAPTCHA solution.

post/api/v1/siteverify

Request body

secretstring required

An API key that proves it's you, create one on the Friendly Captcha website

sitekeystring

Optional: the sitekey that you want to make sure the puzzle was generated from.

solutionstring required

The solution value that the user submitted in the frc-captcha-solution field

Response

OK

detailsstring
errorsstring[]

If you are seeing status code 400 or 401 your server code is probably not configured correctly. secret_missing (400) You forgot to add the secret (=API key) parameter. secret_invalid (401) The API key you provided was invalid. solution_missing (400) You forgot to add the solution parameter. bad_request (400) Something else is wrong with your request, e.g. your request body is empty. solution_invalid (200) The solution you provided was invalid (perhaps the user tried to tamper with the puzzle). solution_timeout_or_duplicate (200) The puzzle that the solution was for has expired or has already been used.

successboolean required

If success is false, errors will be a list containing at least one of the error codes.