Captcha endpoints

get
State of captcha challenge
https://alpina.cloud/api/v1/client/captchas/{PROFILE_ID}/{CAPTCHA_ID}/challenge/{CHALLENGE_ID}
Return information about a particular captcha challenge which you can use on the backend to verify whether or not the captcha was solved by the user.
Request
Response
Request
Path Parameters
PROFILE_UUID
required
string
UUID of profile that owns the captcha
CAPTCHA_UUID
required
string
UUID of the captcha configuration
CHALLENGE_UUID
required
string
UUID of the challenge (you can learn how to access it by reading the integration guide for Captchas)
Headers
x-api-key
required
string
API key with WEB_ANALYTICS_SCOPE
x-api-secret
required
string
API secret with WEB_ANALYTICS_SCOPE
Response
200: OK
"state" may contain "UNRESOLVED", "SUCCESS" or "FAILURE"

UNRESOLVED state is returned if the challenge has been generated for user but there have been no attempts to solve it.
---
FAILURE is returned if the captcha has not been solved.
---
SUCCESS is returned if the user has successfully solved the captcha.
{
  "state": "UNRESOLVED",
  "updatedAt": "2020-08-22T22:59:59.999Z"
}
​

API - Previous

Web Analytics endpoints

Next - API

Rollouts endpoints

Last updated 6 months ago

Captcha endpoints

getState of captcha challenge

get
State of captcha challenge