Partner API quick start¶
The step-by-step walkthrough is designed to help you get started with the Qredo Partner API. The steps are organized in a basic flow to have your account set up for all basic asset transfer scenarios. This section does not discuss the Core Client.
Overview of steps¶
This section presents a sequence of suggested steps to help you get started with the Partner API.
Step 1. Create a company and get your company ID. You'll be completing all remaining steps on behalf of your company.
Step 2. Create your trusted network of approvers: start off by adding a trusted party. Your newly-enlisted approver must accept an enrollment request before they can be eligible for performing custodial actions.
Step 3. Create a fund and appoint approvers as created in the previous step. Your company requires a fund that holds wallets you can deposit assets to. In this step you create fund custodial policies: one for transactions and one for withdrawals. At this step, you also appoint trusted parties with the respective policy.
Step 4. Perform a deposit transfer assets from a Level 1 wallet to your fund wallet address.
Step 5. Perform a transfer transaction within the Qredo Network: move assets from one Qredo wallet to another. Completion of this step requires a custodial action.
Step 6. Perform a withdrawal and finalize the walkthough by transferring assets to a whitelisted Level 1 wallet: one that resides outside the Qredochain, such as BTC, ETH, etc. Completion of this step requires a custodial action.
Each of these steps is detailed in a dedicated subsection.
Whatever you do in the API is not visible in the Qredo Web app
You will use the same account to access the Qredo Web app and the API. However, what happens in the Web app will not be visible or accessible in the API, and vice-versa. For example, funds, wallets and assets contained in these wallets will remain where created: either in Web App or the API.
High-level overview of API-specific terms¶
Before you continue, you should understand the underlying concepts for operations on the Qredo Network:
All transactions across and out the Qredochain undergo custody! In other words: all transactions out a Qredo wallet require approvals (or rejections) by approvers that you appoint. These include transfers and withdrawals.
You will be dealing with one or more of the following terms in most most API use cases:
A short glossary with Qredo-specific terms
This is the entity on behalf of which you perform most API call actions. Think of it as an office that manages one or more funds and employs all approvers for asset transfers.
This is the Qredo approver: a dedicated Qredo account who approves or rejects transactions. The collection of trusted parties in a company is called a trusted network. Every trusted party user performs custody via their Qredo mobile Signing app. The API offers a dedicated user type for "API custody": the Core Client. You will learn about it in the next chapter.
The fund is the actual sub-entity to a company that contains Qredo wallets and the approval rules for transactions with these wallets: the so-called custodial policies. These policies also include the trusted parties that perform custody over transactions within that fund.
A custodial policy defines the number of approvals (also called the threshold) necessary for a transfer or withdrawal transaction to be completed; plus it also includes the approvers eligible to perform these approvals. Every fund has a "global" policy for transfers and withdrawals. A wallet can have custom policies as well but this is not required. If a given wallet lacks policies, the global ones apply. Note that each policy definition includes a selection (a subset or all) of the company trusted parties for custodial actions.
Do not worry if these concepts are not entirely clear yet. You will learn more about each when you complete all steps.
API specifics in this walkthrough¶
All steps are designed to follow a natural flow to build up comfort with Qredo specifics.
- API resources in titles and explanation paragraphs are shown simplified with base URLs excluded: e.g.
- Not all API calls are covered: just the ones to get you started, so visit the Swagger UI documentation on Sandbox for more info.
- Headers are not included in request examples. See request headers for more info.
- Descriptions of body parameters are added in their respective request and response examples in the stead of actual values.
- Some steps require the use of a trusted party. For testing, custodial actions can be performed by either a Qredo account that you own or a Core Client set for custody. However, this walkthrough will not go into detail with Core Client use.
Use testnet assets when testing
Qredo strongly recommends that you use testnet assets for test transactions until you get familiar with the Partner API.