Skip to content

Step 1: Create a company

Before you can do anything, you need to create 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. You will learn this in more detail in the sections that follow.

To complete this step, you must: use the POST /company API resource to create a company. You must supply a name and a successful response returns the company_id. You will be needing this company_id value with API calls in all steps that follow.

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".

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"
}

Pass company_id with most API calls

With the Partner API, you perform a lot of the queries and actions on behalf of a company. Save the company_id value as you will be passing with all API calls in the remaining quick start steps.


Last update: 2022-11-03