API REFERENCE GUIDE

utilities  challenge_check

api description

purpose

challenge_check checkes the value of a challenge generated by challenge_new and returns an error if the value does not match the expected one.

PLEASE NOTE: As challenges and related tokens are single-use, when a value has been checked once, any further attempt to check it again returns an error.

http method: POST

call cost: 1 point

See the pricing section for more details.

mandatory parameter(s)

parameter values / comments
api"challenge_check"
key E.g. "c54e7837e0cd0ced286cb5995327d1ab54e35987179b2". It is an application key generated by AuverCloud Studio.
tokenToken ID generated by challenge_new.
valueUser input as answer to the challenge.

optional parameters(s)

None

call sample

This example is the code used in the test case below. It assumes that jQuery and the JavaScript AuverCloud runtime client are loaded in order to use the arc.api() method. See the API client section for more details.


							

errors

code message comments
641 Unknown token. Either the token ID is unknown or is already burned.
643 Wrong challenge or token value. The value is not the expected one.

See also the Common errors section.

test bed

Call

To test the API with your own keys, please see the section Application keys in AuverCloud Studio.

api
challenge_check
key
token
value
 send
request
 clear
response

See the API challenge_new to generate a challenge.

Response
code
msg
data
picture

discussion