The unread badge (no notification rows)

GET

/notifications/summary

const url = 'https://api.tovarifinancial.com/notifications/summary';
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 https://api.tovarifinancial.com/notifications/summary \
  --header 'Authorization: Bearer <token>'

The cheap poll the shell runs every 60s. It returns NO notification rows — no title, no body, no payload — which is the entire reason it exists beside GET /notifications. highestUnreadSeverity is derived over the WHOLE unread set server-side, so a client must not compute the badge colour from a page it happens to hold.

Authorizations

bearerAuth

Responses

200

The badge

application/json

object

data

required

object

unreadCount

required

integer

highestUnreadSeverity

required

Null exactly when unreadCount is 0.

string

nullable

Allowed values: info warning critical

latestCreatedAt

required

string format: date-time

nullable

dataTrust

required

object

suppressed

required

TRUE only when a suppressible type is ACTUALLY being withheld under the scoped gate.

boolean

reason

required

string

nullable

Allowed values: feed_stalled reauth_required

institutionName

required

string

nullable

suppressedTypes

required

The notification type codes currently withheld. Empty when nothing is suppressed.

Array<string>

message

string

requestId

required

string

timestamp

required

string format: date-time

Example

{
  "data": {
    "highestUnreadSeverity": "info",
    "dataTrust": {
      "reason": "feed_stalled"
    }
  }
}

401

Missing, invalid, or expired bearer token

application/json

object

errorCode

required

Machine-readable error code (AUTH_ERROR_CODES).

string

Allowed values: INVALID_EMAIL_FORMAT USER_ALREADY_EXISTS INVALID_INVITE_CODE WRONG_PASSWORD USER_NOT_FOUND AUTHENTICATION_FAILED EXPIRED_CODE INVALID_CODE INVALID_PASSWORD VALIDATION_ERROR SIGNUP_FAILED DATABASE_ERROR SERVICE_UNAVAILABLE PLAID_ERROR IDEMPOTENCY_CONFLICT ACCOUNT_ALREADY_LINKED NOT_FOUND

message

required

string

fieldErrors

Optional field-level validation errors, keyed by field name.

object

key

additional properties

Array<string>

requestId

required

string

timestamp

required

string format: date-time

Example

{
  "errorCode": "INVALID_EMAIL_FORMAT"
}

403

Authenticated, but the tenant gate refuses the request until the caller resolves a precondition. errorCode is one of EMAIL_NOT_VERIFIED, POLICY_ACCEPTANCE_REQUIRED, or SUBSCRIPTION_REQUIRED, evaluated in exactly that order (contract term CCR-1: email verification first, then policy acceptance, then subscription — so a subscriber who has merely not re-accepted the current policies always sees POLICY_ACCEPTANCE_REQUIRED). A POLICY_ACCEPTANCE_REQUIRED body additionally carries details.outstanding (the policy versions still to accept) and details.firstAcceptance. The SUBSCRIPTION_REQUIRED arm is INERT unless the server-side BILLING_ENABLED flag is exactly the string true; while it is off, only the first two codes are reachable. Not retryable as sent — resolve the named condition, then resend.

application/json

object

errorCode

required

Which precondition refused the request. Evaluated in this order (CCR-1); SUBSCRIPTION_REQUIRED is unreachable while BILLING_ENABLED is not exactly true.

string

Allowed values: EMAIL_NOT_VERIFIED POLICY_ACCEPTANCE_REQUIRED SUBSCRIPTION_REQUIRED

message

required

string

details

object

outstanding

required

Active policy versions the user has not yet accepted.

Array<object>

object

required

string format: uuid

policyType

required

string

version

required

integer

title

required

string

firstAcceptance

required

True when the user has accepted no policy before — the client renders the new-signup screen rather than the re-acceptance one.

boolean

requestId

required

string

timestamp

required

string format: date-time

Example

{
  "errorCode": "EMAIL_NOT_VERIFIED"
}

500

Internal error (no internal detail leaked)

application/json

object

errorCode

required

Machine-readable error code (AUTH_ERROR_CODES).

string

message

required

string

fieldErrors

Optional field-level validation errors, keyed by field name.

object

key

additional properties

Array<string>

requestId

required

string

timestamp

required

string format: date-time

Example

{
  "errorCode": "INVALID_EMAIL_FORMAT"
}

503

Service temporarily unavailable — errorCode is SERVICE_UNAVAILABLE. A TRANSIENT, RETRYABLE condition rather than a defect in the request: a query that exceeded its time budget, a lost or refused database connection, a saturated connection pool, or an outage at an upstream provider the request depends on (the authentication provider, or the bank data provider on a bank-connection operation). The identical request may succeed on retry — back off briefly and, on a write, resend the same X-Idempotency-Key where the operation accepts one.

application/json

object

errorCode

required

Machine-readable error code (AUTH_ERROR_CODES).

string

message

required

string

fieldErrors

Optional field-level validation errors, keyed by field name.

object

key

additional properties

Array<string>

requestId

required

string

timestamp

required

string format: date-time

Example

{
  "errorCode": "INVALID_EMAIL_FORMAT"
}