If you've chosen an async method, you're provided with a list of API requests.
Note: <secret_key> is an access key provided to you when you implement BotProtection.
Get results by UUID
POST /api/v1/result/uuid
Host: bp.yourcompany.com
X-Secret-Key: <secret_key>
Body: [uuid1, uuid2, uuid3 ...] // JSON-array of identifiers
BotProtection machine response:
200 OK
Body: [12, 43, null ...] // JSON-array of identifier matches and the likelihood of their proximity to bots (if null, this means that this user did not pass the challenge in the BP SDK)
Get results by Device ID
POST /api/v1/result/device
Host: bp.yourcompany.com
X-Secret-Key: <secret_key>
Body: [deviceid1, deviceid2, deviceid3 ...] // JSON-array of device IDs
BotProtection machine response:
200 OK
Body: ["0.10", "0.95", null ...] // JSON-array of identifier matches and the likelihood of their proximity to bots (if null, this means that this user did not pass the challenge in the BP SDK)
Get results by Challenge ID
POST /api/v1/result
Host: bp.yourcompany.com
X-Secret-Key: <secret_key>
Body: [challengeid1, challengeid2, challengeid3 ...] // JSON-array of challenge IDs
BotProtection machine response:
200 OK
Body: ["0.10", "0.95", null ...] // JSON-array of identifier matches and the likelihood of their proximity to bots (if null, this means that this user did not pass the challenge in the BP SDK)