Skip to main content
POST
auth.bot-check.verify

Authorizations

Authorization
string
header
required

API key: sk_live_…

Headers

Idempotency-Key
string

Optional. A retry with the same key returns the stored result.

Maximum string length: 255
Pramaan-Account
string

Optional. One of your account ids (GET /v1/accounts): run on that account, whatever your routing rules say. The response header X-Pramaan-Account names the account that ran.

Pramaan-End-User
string

Optional. Your own tag for your end user: a sticky: end_user rule keeps them on the account that first served them.

Maximum string length: 256
Pramaan-End-User-Group
string

Optional. Your end user's group, matched by rules with endUserGroup.

Maximum string length: 64

Body

application/json
token
string
required

Single-use token from your client challenge widget.

Required string length: 1 - 16384
widget
string

Widget product key. When several accounts are connected, name one with the Pramaan-Account header.

Required string length: 1 - 32
remoteIp
string

Visitor IP address; sent only when you supply it.

expectedHostname
string

Required hostname from the challenge evidence.

expectedAction
string

Required action label from the challenge evidence.

Required string length: 1 - 100
minimumScore
number

Minimum event score, only with a score-bearing widget account.

Required range: 0 <= x <= 1

Response

The result

passed
boolean
required

Whether the challenge and your evidence checks passed.

challengeTime
string

Challenge time, ISO 8601 UTC, when known.

action
string

Challenge action label, when known.