List linked Plaid items

GET

/plaid/items

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

Authorizations

bearerAuth

Responses

200

Plaid items

application/json

object

data

required

object

items

Array<object>

object

string format: uuid

institutionId

string

institutionName

string

status

string

Allowed values: active requires_reauth error unlinked

lastSyncedAt

string format: date-time

nullable

lastDataAt

string format: date-time

nullable

feedFreshness

string

Allowed values: fresh awaiting-first-data no-recent-data

reauthCause

string

nullable

Allowed values: login-required consent-expired permission-revoked other

reauthConflictSuspected

boolean

initialBackfillDays

number

initialSyncCompletedAt

string format: date-time

nullable

backfillCompleteAt

string format: date-time

nullable

investments

object

applicable

boolean

consent

string

Allowed values: granted reconnect-required unavailable

lastValueAt

string format: date-time

nullable

accounts

Array<object>

object

accountId

string

plaidAccountId

string

name

string

mask

string

nullable

accountType

string

nullable

syncEnabled

boolean

message

string

requestId

required

string

timestamp

required

string format: date-time

Example

{
  "data": {
    "items": [
      {
        "status": "active",
        "feedFreshness": "fresh",
        "reauthCause": "login-required",
        "investments": {
          "consent": "granted"
        }
      }
    ]
  }
}

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 ORG_NAME_TAKEN 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"
}