Skip to main content
GET
Get Plaid sync status for a bank account

Authorizations

Authorization
string
header
required

API key issued per entity via Settings > Developers > API Keys. Each key carries scopes (e.g. orders:read, products:write). Bearer token format: Authorization: Bearer ark_live_ent_Test keys use ark_test_ent_. Both are issued per entity
via Settings > Developers > API Keys.

Path Parameters

id
string<uuid>
required

Response

Plaid status

id
string<uuid>

The bank account id.

entity_id
string<uuid>
plaid_account_id
string | null
plaid_item_id
string | null
sync_status
enum<string>

Feed health, derived from the Plaid item SSOT.

Available options:
active,
login_required,
removed,
legacy,
not_connected
sync_error_code
string | null

The Plaid error code behind an unhealthy feed (for example ITEM_LOGIN_REQUIRED, PENDING_EXPIRATION), or null.

sync_expires_at
string<date-time> | null
deprecated

Reserved. Always null: Plaid exposes no feed-expiry instant, so no value is inferred. Do not depend on this field.

last_synced_at
string<date-time> | null
is_active
boolean

Whether the bank account itself is active.

item_status
enum<string> | null

Raw Plaid item status, or null when no item backs this bank account (legacy / not_connected).

Available options:
active,
login_required,
removed,
null
item_last_error
string | null

The last failure Plaid reported for this item, formatted as "CODE: message".

feed_hold
boolean | null

True when ingestion is paused for the whole bank login.

account_feed_enabled
boolean | null

False when this specific sub-account feed is switched off.

reauth_required
boolean

True when the operator needs to reconnect the bank login. Also true for Plaid's 7-day advance warnings (PENDING_EXPIRATION, PENDING_DISCONNECT) while the feed is still running.