Get an account

GET 
/v1/accounts/:external_account_id

Fetch one of your bank's accounts by its external_account_id and asset_id. Because the same external_account_id can be registered for more than one asset, asset_id is required to select the account.

Returns the account's identity, kind and status only. For amounts use GET /v1/accounts/{external_account_id}/balances.

Required scope: connector:accounts:read.

Returns 404 Not Found (title account not found) if your bank has no such account, including while its registration operation has not yet succeeded, and for accounts owned by other banks.

Request

Responses

200

The requested account.

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.

404

No account with this external_account_id and asset_id exists for your bank.

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.