Challenge

Base URL: $PUBLIC_API

The object

algorithmstring · required
challengestring · required
maxnumberinteger · required
saltstring · required
signaturestring · required
Endpoints
The object
{
  "algorithm": "SHA-256",
  "challenge": "challenge",
  "maxnumber": 1,
  "salt": "salt",
  "signature": "signature"
}

Get challenge

Logs

GET /challenge

Issue a proof-of-work bot challenge when the builtin provider is active

Issues a short-lived SHA-256 proof-of-work challenge when the server is configured with security.challenge.provider=builtin. Returns 404 otherwise. Served with Cache-Control: no-store and rate-limited per IP.

Parameters

scopestring · query · required

The form the challenge protects. The solved challenge is bound to this scope and is accepted only by the request of that form.

one of identity.signup, identity.login, identity.password_reset, identity.verification_code, connection.estimate, connection.request, intake.contact, intake.docs_feedback

Returns

200 Challenge issued

Show attributes
algorithmstring · required
challengestring · required
maxnumberinteger · required
saltstring · required
signaturestring · required

Errors 400 · 404 · 429

curl -X GET "$PUBLIC_API/challenge"
Response 200
{
  "algorithm": "SHA-256",
  "challenge": "challenge",
  "maxnumber": 1,
  "salt": "salt",
  "signature": "signature"
}