Skip to content

TL:DR

  • use POST /trustedparty
  • For a Signing App approver, pass email address of registered user
  • For a Signing Agent approver, pass agentID
  • You can add yourself as a trusted party to your Company

Introduction

This page guides you through adding approvers to your Company. Approvers may be (human) trusted parties i.e. Signing App approvers or automated Signing Agents.

Trusted parties approve transfer out transactions

Trusted parties perform custody on all transactions that move assets out of a Qredo Wallet.

Your trusted parties are not visible in the Qredo Web App

As with Companies instantiated via the API, the trusted parties you enlist with your Company will not be visible in the Web App.

Step 2: Add a trusted party

Policies are editable

You can always add or remove trusted parties at a later stage.

1. Enlist a trusted party

To enlist a trusted party, use POST /trustedparty:

  • Identify the Company by company_id in the path.

  • Pass the trusted party user's registered email address in the body of the request.

    This must be the email address used with their Qredo account.

#    Request:

curl -X 'POST' \
  'https://play-api.qredo.network/api/v1/p/company/{company_id}/trustedparty' \
  -H 'accept: application/json' \
  -H 'x-timestamp: 1668069089' \
  -H 'x-sign: r76j7xH....QpUxEw' \
  -H 'X-API-KEY: eyJrZXl...6dHJ1ZX0' \
  -H 'Content-Type: application/json' \
  -d '{"address":"[email protected]"}'

#  Response:

        {"code":200,"msg":"OK"}

You can add several trusted parties at once

You can supply several entries in the JSON body, for example:

{ 
 "address": "[email protected]",
 "address": "[email protected]",
 "address": "[email protected]"
}

A successful response returns a HTTP 200 OK confirmation via the API, and the appointed user will receive a notification on their mobile device with the Qredo Signing App installed.

Enlisted trusted parties cannot perform custody yet

This step add users to your trusted network. They will not be able to approve transactions until appointed to do so, as described in the next guide Step 3. Create a fund.

2. Wait for trusted party approval

Your appointed user must approve (authorize) their addition to your trusted network via the Mobile Signing App.

3. Verify trusted party addition

Either communicate with your nominated trusted parties to verify their acceptance, or check GET /trustedparty to retrieve a list of all trusted parties in a Company.

A Signing Agent may be added as a trusted party to your Company.

1. Enlist a Signing Agent as an approver

To enlist a trusted party, use POST /trustedparty:

Identify the Company by company_id in the path. Pass the Signing Agent's identifier, agentID as the address in the body of the request.

You can add several Signing Agents at once

You can supply several entries in the JSON body, for example:

{ 
 "address": "HNRosks34HS0ILtlRtEzNlITDlPEoirgXTxzY52qPG7w",
 "address": "CBApocs97bS7SgE21Ht5xRHFWRbcrH9AMZHgsoUd2gpp",
 "address": "JSOwasg92vW1eJNRGz3qb20K7GUxy7f5jtEBZrX4bTsa"
}
3. Verify trusted party addition

Verify the addition of your Signing Agent with GET /trustedparty to retrieve a list of all trusted parties in a Company.

Verify trusted party is enlisted

Example request: GET /trustedparty

Retrieve a list of all trusted parties in a Company. Again, you need to pass the company_id as a URL parameter.

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

No body parameters are sent with this request.

Example response: GET /trustedparty

A successful response returns a list with trusted network members.

{
  "company_id": "<company ID>",
  "total_count": "<total number of trusted parties>",
  "list": [
     {       
        "list": {
          "trusted_entity_id": "<user's approver ID>",
          "name": "<first and last name>",        
          "address": "<email address>",
          "type": "<user type>", 
          "created": "<Epoch timestamp when user was added as a trusted entity>" 
      }
    }
  ]
}

Obviously, your selcted trusted party must accept the enrollment request before you can expect this response to include them.

Add approvers to a Fund

Even after becoming part of your trusted network, trusted parties cannot perform custodial actions. Before you can add them to a custody policy, you must create a Fund with Wallet/s.

Last update: 2022-12-14