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

Contracts

Get contract

Changed on Nov 3, 2026

Get contract by ID

get/rest/contracts/{contract-id}

Request

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

Path parameters

contract-idstring required

ID of the contract.

Example:C12345.6

Parameters

#/paths/~1catalog/get/parameters/0 (unresolved $ref)

Response

(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 string 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
- warning
  added the new half-yearly enum value to the response property for the response status
- warning
  added the new monthly enum value to the response property for the response status
- warning
  added the new quarterly enum value to the response property for the response status
- warning
  added the new yearly enum value to the response property for the response status
- info
  the response's property default value EUR was added for the status

Operation history