Sign in

v1

latestOpenAPI 3.1.02026-07-26165182724.7 KB
Business Account Security

Record a security-relevant business event

Reports a security event for a business, driving progressive account lockout under PSD2. — RESET_PASSWORD_COMPLETED revokes every active SCA session for the business and clears the failed-login counter (an account already suspended at level 5 remains suspended until access is restored by support). — FAILED_LOGIN_ATTEMPT increments the cumulative counter and escalates the lock at each milestone: 5 attempts → 15 minutes, 6 → 30 minutes, 7 → 1 hour, 8 → 24 hours, 9 or more → suspension with no automatic recovery.

post/business/record-event

Request body

businessIdstring uuid required

The business the event is recorded against.

event'RESET_PASSWORD_COMPLETED' | 'FAILED_LOGIN_ATTEMPT' required

Example request

{
  "businessId": "8b1d5f2a-3c4e-4a6b-9f0d-7e2c1a4b5d6e"
}

Response

Event recorded. The populated fields depend on the event and resulting lock state: RESET_PASSWORD_COMPLETED returns only event; FAILED_LOGIN_ATTEMPT adds failedAttempts plus lockedUntil (time-bounded lock) or suspended: true (level-5 suspension).

event'RESET_PASSWORD_COMPLETED' | 'FAILED_LOGIN_ATTEMPT' required
failedAttemptsinteger

Cumulative failed-login count. Present for FAILED_LOGIN_ATTEMPT.

lockedUntilstring date-time

End of the active lock window. Present for FAILED_LOGIN_ATTEMPT when a time-bounded lock is in effect.

suspendedboolean

Present and true when the attempt escalated to level 5 and the business was SUSPENDED.