Skip to content

/get_authentication_attempts

/accounts/get_authentication_attempts

Target audience: Developers

1
Release version: 4.1.1

Introduction

This endpoint returns status about a specific accounts login status. You can use this to see if the account has tried authentication to many times within a short time span and therefore been frozen.

URI

Environment URI
Stage https://payway-api.stage.adeprimo.se/external/api/v1/accounts/get_authentication_attempts
Production https://backend.worldoftulo.com/external/api/v1/accounts/get_authentication_attempts

Required scope

1
/external/account/r

Parameters

Name Required Type Description
email Required String The E-mail address of the account to query.

Curl Example

1
2
3
4
curl --request GET \
  --url 'https://payway-api.stage.adeprimo.se/external/api/v1/accounts/get_authentication_attempts?email=test@test.com' \
  --header 'accept: application/json' \
  --header 'authorization: Bearer <insert access-token here>'

Response

Example response

1
2
3
4
5
6
7
8
HTTP 200
{
  "item": {
    "account_frozen": false,
    "remaining_authentication_attempts": 5,
    "frozen_until": null
  }
}

Errors

Example error response

1
2
3
4
5
6
HTTP 400 Bad Request
{
  "code": "invalid_parameter",
  "field": "email",
  "message": "Parameter is required"
}

HTTP 400 Bad Request

Name Type Description
unknown_parameter Object One or more of the fields in the posted json was not recognized

HTTP 404 Not Found

Name Type Description
not_found Object The account could not be found

HTTP 500 Internal Server Error

Name Type Description
internal_server_error Object Something unexpected happened server side