Accesses8

Account Verification2

Accounts5

Aggregations6

Artifacts1

Catalog4

Categorization2

Client Authorization2

Contracts7

Customizable Widget8

Financial Timeline3

Income Report4

Insurances3

Loans3

Notifications6

Payments10

Risk Report4

Securities3

Strong Customer Authentication9

Synchronizations2

Transaction Upload2

Transactions4

User Management6

Version1

Accounts

Get account

Changed on Nov 3, 2026

Retrieve detailed information about an account identified by its ID.

get/rest/accounts/{account-id}

Request

Base URL
https://api.nrich.qwist.cloud
Auth
HTTP bearer
TypeScript
https://skmtc.dev/qwist/apis/finx-api/docs/rest/accounts/:account-id/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

account-idstring required

nrich ID of account.

Example:A12345.6

Parameters

#/paths/~1rest~1payments/get/parameters/5 (unresolved $ref)

Response

Account details.

account_idSchema required(unresolved $ref)

account_numberstring required

Domestic account identifier.

bank_codestring required

Domestic bank code.

ibanIban (unresolved $ref)

bicBic (unresolved $ref)

access_idSchema required(unresolved $ref)

bank_namestring required

Name of bank or financial provider.

currencyCurrency required(unresolved $ref)

balance0 required(unresolved $ref)

typeItems required(unresolved $ref)

namestring required

Name of the account.

ownerstring

Name of the account holder.

auto_syncboolean required

Indicates if the account is automatically synchronized.

save_pinboolean required

Indicates if the provider credentials are saved for this account.

is_jointly_managedboolean

Indicates that the account has been opened by two or more individuals or entities.

statusStatus required(unresolved $ref)

Changes

Nov 3, 2026398592d93b1f Revision changes
- breaking
  the response's property type changed from no type to string for status
- breaking
  the response's property type changed from no type to string for status
- breaking
  the response's property type changed from no type to object for status
- breaking
  the response's property type changed from no type to string, and format from no format to ISO 4217:2015 for status
- breaking
  the response's property type changed from no type to object for status
- breaking
  the / response's property type changed from no type to object for status
- info
  added the optional property / to the response with the status
- info
  the response's property default value EUR was added for the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status
- info
  added the required property // to the response with the status

Operation history