Get recovery status
GET
/api/v1/account/recovery
const url = 'http://127.0.0.1:8080/api/v1/account/recovery';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url http://127.0.0.1:8080/api/v1/account/recovery \ --header 'Authorization: Bearer <token>'Reports the unused code count and the provider recovery policy. Browser session authentication and CSRF apply to protected mutations. Recent authentication means a session created within five minutes. WebAuthn challenges are one-use, browser-bound and expire after five minutes. Public sign-in requires the configured Origin header. Responses must not be cached.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Completed.
Media typeapplication/json
object
allowed
required
Whether provider policy allows recovery codes for this account
boolean
remaining
required
integer format: int64
key
additional properties
any
Examplegenerated
{ "allowed": true, "remaining": 1}No valid session or API token (authentication-required), or the credential sent is invalid (invalid-credentials).
Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{ "code": "example", "detail": "example", "status": 1, "title": "example", "type": "example"}default
Section titled “default”Authentication, policy, rate, or protocol validation failure.
Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{ "code": "example", "detail": "example", "status": 1, "title": "example", "type": "example"}