Setup Core Client

This section presents the Qredo Core Client and illustrates its intended use for automated custody.

The Core Client is a standalone approver service. Every Core Client has a unique ID and uses a dedicated subset of the API to perform its functions. You can plug in with your client ID to a WebSocket feed that listens for transactions pending approvals. Also, you can create a programmable approver bot that uses a Core Client instance to perform automated custody.

This topic covers the API custody on transfer out transactions. The Core Client must be appointed as an approver of a wallet (or fund). You will learn how to fetch, approve or reject pending transactions out of such a wallet. A Core Client instance can be upgraded to an exchange, as described in the Get started with exchanges section.

To complete this section, you must:

1. Create a Core Client using the POST /coreclient Partner API resource.
2. Add the Core Client as a trusted party of a company. You will use the POST /trustedparty to add the Core Client to the trusted network of your company, similar to Partner API quick start Step 2.
3. Create a wallet (or a fund, as explained in the Partner API quick start walkthrough step 3. Create a fund) with the Core Client as a trusted party.

As you see, the Core Client undergoes a process very similar to that of the human approver.

1. Create a Core Client

This step discusses the addition of a single Core Client but you can use the same API resource to add as many as you want to have.

Example request: POST /coreclient

This example creates a coreclient named "Approver-Bot-01". The response returns the client id and the WebSocket feed. Note that you will need the id as a query parameter with custodial API endpoints.

curl -X POST "https://api.qredo.network/api/v1/p/coreclient"
 Copy

Request body

Specify the name of your Core Client. This name is for human-readable info only: you identify your Core Client in the API using its only ID.

{
  "name": "Approver-Bot-01"
}
 Copy

Example response: POST /coreclient

Upon success, the response notably returns the core id and the unique WebSocket feed.

{
  "id": "9niR8...RW3xu",
  "name": "Approver-Bot-01",
  "feed": "wss://api.qredo.network/api/v1/p/coreclient/9niR8...RW3xu/feed",
  "timestamp": "<Epoch timestamp when Core Client is created, e.g. '1635258443' >"
}
 Copy

The example includes the suggested id and feed.

2. Enlist the Core Client as a trusted party

You must follow a process very similar to Step 2: Add a trusted party of the Partner API quick start walkthrough.

Again, you will use the POST /trustedparty API resource. The difference here is that, this time, you will not submit a person's email address in the API call body, but the core id instead.

Example request: POST /trustedparty

This example submits an enrollment request to add as an approver the Core Client with the id retrieved in the previous step. With this API resource, you pass company_id as a URL parameter.

curl -X POST "https://api.qredo.network/api/v1/p/company/{company_id}/trustedparty"
 Copy

Request body

Unlike when adding a human approver, you obviously don't specify Core Client by an email address but with the Core Client id.

{"address": "9niR8...RW3xu"}
 Copy

Example response: POST /trustedparty

A successful response returns a HTTP 200 OK confirmation. The appointed user will receive a notification on their Qredo Signing app. No JSON payload is passed with the response.

Unlike when adding a human user account, no confirmation is required and this step is already completed.

3. Verify enlisting of your Core Client approver

You can verify that your Core Client can actively participate in the approval process using the familiar GET /trustedparty API resource to return all trusted parties with your company.

{
  "company_id": "1zga...gVBl",
  "total_count": 2,
  "list": [
    {
      "trusted_entity_id": "13DCS...vDiag",
      "name": "John Smith",
      "address": "[email protected]",
      "type": "user",
      "created": 1634727142
    },
    {
      "trusted_entity_id": "9niR8...RW3xu",
      "name": "Demo Core Client",
      "address": "9niR8...RW3xu",
      "type": "core-client",
      "created": 1635427044
    }
  ]
}
 Copy

4. Create a wallet with the Core Client as a trusted party

You can create a new fund (with one or more wallets) and appoint the Core Client as a trusted party member with global custodial policies. This example, however, creates a new wallet, part of an existing fund. The custodial policies of the new wallet appoint the Core Client as member, using its client id.

Example request: POST /wallet

This examples creates a ETH-Testnet wallet with custom custodial policies with the Core Client added as a member. With this API resource, you pass company_id and fund_id as URL parameters.

Request body

Specify the wallet name and asset, as well as the custodial policies. Each custodial policy in this example includes a core id and a trusted_party_id, with a threshold set to 1. In this way a single Core Client can approve transfers and withdrawals with this wallet.

The current example creates a single wallet. You can create more than one wallets with a single API call.

{
  "wallets": [
    {
      "name": "Core Client custody wallet",
      "asset": "ETH-TESTNET",
      "custodygroup_withdraw": {
        "threshold": 1,
        "members": [
          "9niR8...RW3xu",
          "13DCS...vDiag"
        ]
      },
      "custodygroup_tx": {
        "threshold": 1,
        "members": [
          "9niR8...RW3xu",
          "13DCS...vDiag"
        ]
      }
    }
  ]
}
 Copy

Example response: POST /wallet

The response returns a list of IDs of the wallets created.

{
  "wallets": [    
    "GTci7...tPc7i"
  ]
}
 Copy

From this point on, you need to deposit assets to your wallets, as described in step 4. Perform a deposit of the Partner API quick start walkthrough.

Next, you connect the Core Client to a WebSocket feed service and start listening for transaction requests pending custody.