Get phone lockout status
GET
/api/auth/phone/lockout-status
const url = 'http://localhost:3001/api/auth/phone/lockout-status?phone=example';const options = {method: 'GET'};
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://localhost:3001/api/auth/phone/lockout-status?phone=example'Check whether a phone number is currently locked out from login attempts.
Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”phone
required
string
Phone number to check
Responses
Section titled “Responses”OK
Media typeapplication/json
object
failed_attempts
integer
is_locked
boolean
lock_reason
string
locked_until
string
Examplegenerated
{ "failed_attempts": 1, "is_locked": true, "lock_reason": "example", "locked_until": "example"}Bad Request
Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{ "error": "example", "success": true}Unauthorized
Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{ "error": "example", "success": true}Internal Server Error
Media typeapplication/json
object
error
string
success
boolean
Examplegenerated
{ "error": "example", "success": true}