This guide will introduce you with the Qredo Partner & Core Client API. The Partner API allows you to carry on all necessary operations to move assets on the Qredo network in a way similar to the user on the Qredo web app, while the Core Client extends the API with all custody functionality that is available to a custodian user on the Qredo Signing app.
The Partner API¶
The allows you to perform actions available to the Qredo Web application user on the Qredo Network, such as:
- create and manage a company
- create and manage a trusted network
- create and manage one or more funds
- add or remove one or more wallets in fund
- perform transactions (transfers and withdrawals)
- perform atomic swaps
API actions are not visible in the Qredo Web app!
All actions you perform in the Partner & Core Client API will not be visible in the Qredo Web app, and vice-versa, regardless that you use the same Qredo account for both. So funds and wallets (and assets they hold!) created using the API will not be visible nor accessible in the web app. The opposite applies as well: organizations, funds or wallets created using the Qredo web app are not visible nor accessible via the API.
Note that for API custodial actions, you need to additionally set up a Core Client. Only a Core Client can perform custody using the API. The API does not provide any other way to perform custody: it is either an actual user with the Mobile Signing app; or the Core Client.
In the Qredo web application, currently only Qredo users with their Qredo mobile application can be assigned as custodians over a wallet. However, in the API, it is also possible to use a “Core Client”. This is a standalone custodian service that represents a user on the network and can (amongst other uses) be assigned as a custodian over wallets created using the API. Note that custodians over wallets created with the API can be a mix of Core Client “bots” and human users.
The Core Client¶
The Core Client is a standalone custodian service. On the Qredo Network, it is identified as an API custodian user entity type, identified by a core client ID. It uses a dedicated subset of the API for fetching, approving and rejecting transactions pending custody. Additionally, you can connect your core client to a websocket feed for newly submitted transactions pending custody. You can use its capabilities to set up a client-side bot and connect it to the Qredo Network with the purpose of performing two core functions:
- act as an automated custodian: approve or reject transaction requests. In this aspect the Core Client performs actions similar to the Qredo Signing app.
- act as an exchange:
- approve or reject requests to connect Qredo wallets the exchange.
- approve or reject sweep transactions initiated by exchanges from any connected wallets.
- act as a master custodian for dedicated connected wallets.
To perform these actions, the Core Client is identified as a specific user type on the Qredo Network that uses a dedicated subset of the API.
Topics in this guide¶
Currently, this guide covers the following topics:
- Overview (current section): contains introduction and prerequisite subsections to get started with the Partner API:
- Partner API quick start: start using the API by creating a company, add a fund with trusted network and custody policies, and then proceed with transferring assets.
- Core client: create, set up and connect a client listener to a websocket feed with transactions pending custody.
- Exchanges quick start: set up the core client and a network of wallets per user for exchange-monitored and approved transactions.
- Atomic swaps: create atomic swap quote, publish to liquidity hub and retrieve pending quotes.
- API reference: a comprehensive reference with API call details, including JSON payloads and HTTP(S) error codes.