List accounts

GET 
/v1/accounts

List the accounts your bank has registered. Only accounts owned by the calling bank are returned.

An account is registered for one root settlement asset (asset_id, for example usd) and identified by the core banking system (CBS) identifier your bank supplied (external_account_id). An account appears here only after its registration operation has completed (see POST /v1/accounts).

Required scope: connector:accounts:read.

Filters. All filters are exact, case-sensitive matches and are combined with AND. A filter value that matches nothing (including a value outside the documented enum) returns an empty data array, not an error.

Order. Results are returned in a stable order defined by the platform's internal account record identifier (descending). Do not rely on any other ordering.

Pagination. Cursor-based; follow links.next until it is absent.

Request

Responses

200

One page of accounts owned by the calling bank.

400

The request is malformed: invalid JSON syntax, an invalid path or query parameter, a missing required header such as Idempotency-Key, or a single field that fails its own format rule. Fix the request before retrying; retrying it unchanged fails again.

401

The bearer token is missing, malformed, expired, signed by an unknown key, or was not issued by the platform IAM for the Lyriq Connector. Obtain a new token and retry. See the Authentication section.

403

The token is valid but may not perform this request: it lacks the required scope, has no bank membership, needs an x-dan-bank-id header to choose between several memberships, names a bank in x-dan-bank-id it has no membership for, or the caller's bank is suspended or terminated. A new token with the same configuration fails the same way. See the Authentication section.

429

The request was refused because a rate limit was reached (code RATE_LIMITED). No Retry-After header is sent; retry with exponential backoff.

503

The request could not be served right now. Either the network is not fully operational (OUTBOUND_HALTED or READ_ONLY: mutations are refused while read endpoints keep working; OPERATIONAL_STATE_UNKNOWN: the state could not be determined), or a platform dependency is temporarily unavailable. No Retry-After header is sent; retry later with backoff. When retrying a mutation, reuse the same Idempotency-Key and body.