Skip to content

TL:DR

  • A Company is the key entity of your Qredo integration
  • Use POST /company

Step 1: Create a Company

This page guides you through creating a Company. Nearly all API calls are performed on behalf of a Company, including transactions. You must have at least one Company but you can have several for separate asset flows.

The Company sits on top of the hierarchy. Each Company has a list of custodians (approvers) that approve transactions out of Wallets that belong to a Company.

To create a Company, use the POST /company API endpoint. You must supply a name. A successful response returns the company_id. This company_id is passed in all following API calls.

Your Companies are not visible in Web App

The Company is similar to an organization in the Qredo Wallet Web App. However, just like Organizations are not visible in the API, the companies are not visible in the Web App.

Example request: POST /company

This example creates a Company called "random_inc" to this endpoint:

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

Request body

name is required. All other parameters are optional. You can update any of these later, including the name.

{
  "name": "random_inc",
  "city": "<name of city, e.g. 'Paris'>",
  "country": "<ISO 3166-1 country code, e.g. 'FR'>",
  "domain": "randomincorporated.com",
  "ref": "<a Company reference ID, e.g. '9827feec-4eae-4e80-bda3-daa7c3b97add'>"
}

Example response: POST /company

Upon success, the response returns the company_id hash as a string value.

{
  "company_id": "1va2cJ2pqdLSFAN5t1knBrnuMvw",
  "city": "Paris",
  "country": "FR",
  "domain": "randomincorporated.com",
  "ref": "9827feec-4eae-4e80-bda3-daa7c3b97add"
}

Last update: 2022-12-14