Custody Services
With the Custody Services API, Service Users are able to receive near-real-time or end-of-day processed position and transaction data for their client's accounts. Custody services include settlement, safekeeping, and reporting of customers' marketable securities and cash and these data can be used for different purposes, such as reconciliation.
The following subsections present the operations available on the Custody Services API.
Retrieve a list of authorized accounts (GET/customerAccounts)
This request can be used to retrieve a list of all authorized customers and their respective accounts. Authorized customers and respective accounts are defined as those accounts of a user for which consent has been granted.
A successful API response for this request will return a list of customers with their corresponding ID and reference currency, as well as details about the account type and linked portfolios.
Retrieve information about a single specific account (GET/customerAccounts/{customerId})
This request can be used to retrieve detailed information about one specific authorized customer and its respective accounts. As a result, the user will receive a list of accounts of the specific customer with details about the account type and linked portfolios.
Retrieve all positions for a single specific customer (GET/customers/{customerId}/positions)
Service Users can use this request to receive detailed information about all positions registered on all accounts of a specific customer. A successful API response will return a statement/snapshot containing all accounts belonging to one particular customer, as well as a detailed list including all positions with name, ID, amount, and additional information depending on the type of position and financial instrument.
Retrieve the positions for a customer's specific account (GET/accounts/{accountId}/positions)
This request can be used to receive detailed information about all positions of a single customer account. A successful API response will return a statement/snapshot containing one specific customer account, as well as a detailed list including all positions with name, ID, amount, and additional information depending on the type of position and financial instrument.
Retrieve all transactions for a specific customer (GET/customers/{customerId}/transactions)
Service Users can use this reques to get a list of all transactions of a specific customer. As a result the user will receive a statement about all position-altering transaction of a specific customer. The statement will contain information about the type of transaction, the respective movements, affected positions and accounts, etc.
Retrieve all transactions for a specific account (accounts/{accountId}/transactions)
This request can be used to retrieve a list of all transactions concerning a specific account. A successful API response will return a statement about all position-altering transactions of a specific account. The statement will contain information about the type of transaction, the respective movements, and affected positions for this account.
Retrieve all transactions for a specific position (GET/positions/{positionId}/transactions)
Service Users can use this request to retrieve a list of all transactions concerning a specific position. As a result, the user will receive a statement about all position-altering transactions of a specific position. The statement will contain information about the type of transaction and the respective movements of a position.
Health check of the Custody Services Module (/healthcheck)
This request can be used to check if a specific module of the selected Service Provider is available. An empty request will be sent over bLink to the corresponding Service Provider and return a timestamp and confirmation about receipt.