authenticator verify
/authenticators/{authenticator}/verify [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 6.2000 | 6.2000 | xml, json |
Description
Verify authenticator with the specified public-id registered for the signed-in member.
Parameters
| Name | Description | Required | Type | Default value |
|---|---|---|---|---|
| challenge | The unique identifier of the challenge to be verified | yes | string | |
| code | The authentication code that needs to be verified (required if no credential) | conditional | string | |
| credential | The challenge response provided by the user for verification (required if no code) | conditional | string |
Permission
Only the member themselves can invoke this service.
Response
<authenticator-verification authenticator="[authenticator public id]"
verified="[true|false]"
status="[success|failure|expired|invalid-challenge|locked-out|error] />
Error handling
No specific errors expected for this generator.