Chainify
API docs by Redocly

API Docs (0.1.0-Beta)

Download OpenAPI specification:Download

Introduction

Overview

We offer a robust enterprise-grade multi-tenant digital asset custody solution.

Our solution employs Multi-Party Computation (MPC) to secure your keys. The standard installation consists of three cosigners, each deployed in separate locations, requiring at least two out of the three parties to execute the protocol to access the funds.

We currently support the following blockchain networks, with continuous additions of new chains and tokens:

  • Ethereum
  • Binance Smart Chain (BSC)
  • Tron
  • Polygon
  • ERC-20 tokens on the aforementioned chains

Our system is structured around three primary concepts: vaults, accounts, and wallets. A single vault can house multiple accounts, while an account is limited to containing a wallet for a specific asset. An example setup is as follows:

  • Operations (Vault)
    • Business Section A (Account)
      • ETH (Wallet)
      • USDT_ETH (Wallet)
    • Business Section B (Account)
      • ETH (Wallet)
      • USDT_ETH (Wallet)
  • Billing (Vault)
    • Main Billing (Account)
      • ETH (Wallet)
      • USDT_ETH (Wallet)
      • USDC_ETH (Wallet)
  • Customers (Vault)
    • Customer-1 (Account)
      • ETH (Wallet)
      • USDT_ETH (Wallet)
    • Customer-2 (Account)
      • ETH (Wallet)
      • USDT_ETH (Wallet)
    • Customer-3 (Account) ...

Webhooks can be configured at both the wallet and vault levels to receive notifications regarding incoming and outgoing transactions. Notifications will be sent upon transactions reaching the mempool and upon a configurable number of confirmations.

Automatic fund sweeps can be established at the wallet level for enhanced financial management.

API Specification

This API specification is in Beta and might change during the following weeks. We are working on releasing a stable specification early August 2023.

Authentication

We provide 2 different environments: production and sandbox, you can setup your api key in the console under settings, the endpoints are as follows

Environment Setup Link
Sandbox (testnet) sandbox
Prod (mainnet) prod

Once you setup your API key you will need to include the following headers in your API calls:

X-Cf-Key: The key ID (uuid)

X-Cf-Secret: The key secret (make sure to store it in a safe place on creation since it won't be retrievable after that)

Pagination

Most List operations will generate a paginated response returning at most 50 items, if there are more items you will get in the body a property named last that you will need to include in the next GET request as a path parameter e.g.:

{
  "vaults": [...],
  "last": "eyJjcmVhdGVkQXQiOiIyMDIzLTAzLTA1VDAyOjUwOjE0LjQ4OFoifQ=="
}

In order to get the next page you will have to do the following GET:

https://{endpoint}/vaults?last=eyJjcmVhdGVkQXQiOiIyMDIzLTAzLTA1VDAyOjUwOjE0LjQ4OFoifQ==

Vaults

Vauls are the main entity in the application. In order to create a wallet you will need to create first a vault and an account.

List Vaults

List of vaults in your organization, returns a paginated response

header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}

Responses

Response samples

Content type
application/json
{
  • "vaults": [
    ]
}

Create Vault

Create a vault is an asynchronous operation, you will get a response with the status KEYGEN_IN_PROGRESS and you will need to query the get vault endpoint to check the current status.

Normally you should not need to have more than 10 vaults in your organization.

header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}
Request Body schema: application/json
externalId
string
name
string

Responses

Request samples

Content type
application/json
{
  • "externalId": "your-unique-external-id",
  • "name": "operations"
}

Response samples

Content type
application/json
{
  • "createdAt": "2023-07-01T06:26:19.217Z",
  • "name": "operations",
  • "status": "KEYGEN_IN_PROGRESS",
  • "vaultId": "ecd0d15b-43be-5182-8b57-d974fc49c36c"
}

Get Vault

List of vaults in your organization, returns a paginated response

path Parameters
vaultId
required
string
header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}

Responses

Response samples

Content type
application/json
{
  • "createdAt": "2023-07-01T06:26:19.217Z",
  • "name": "operations",
  • "status": "COMPLETED",
  • "vaultId": "ecd0d15b-43be-5182-8b57-d974fc49c36c"
}

Accounts

Accounts need to belong to a vault, usually you might create in the order of thousands.

List Accounts In Vault

Lists the accounts in a vault, the response is paginated

path Parameters
vaultId
required
string
header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ]
}

Create Account

Create a vault is an asynchronous operation, you will get a response with the status KEYGEN_IN_PROGRESS and you will need to query the get vault endpoint to check the current status.

Normally you should not need to have more than 10 vaults in your organization.

path Parameters
vaultId
required
string
header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}
Request Body schema: application/json
externalId
string
name
string

Responses

Request samples

Content type
application/json
{
  • "externalId": "your-unique-external-id",
  • "name": "customer 007"
}

Response samples

Content type
application/json
{
  • "accountId": "8f479e39-e32f-52ba-9109-505c3dce9a6b",
  • "createdAt": "2023-07-01T06:41:08.893Z",
  • "externalId": "your-unique-external-id",
  • "name": "customer 007",
  • "updatedAt": "2023-07-01T06:41:08.893Z",
  • "vaultId": "ecd0d15b-43be-5182-8b57-d974fc49c36c"
}

Wallets

Wallets have an asset id, address(es) and a balance.

Currently if you want to create an ERC-20 token wallet you will need to create first the native wallet for that, so if I want to create a USDT wallet on the Ethereum network, I will need to create a ETH wallet and then a USDT_ETH wallet.

Miner fees sending tokens will be paid from the native wallet for the chain, sending USDT in the Ethereum network will incur in a miner fee payable by the ETH wallet.

Balances and amounts are expressed natively, meaning that they are whole numbers, e.g.:

Ethereum has 18 decimal places therefore the if a wallet has 1 ETH, the balance will be returned in wei: "1000000000000000000" (1 + 18 zeroes) On the other hand USDT has 6 decimal places so the balance of a wallet containing 1 USDT will show as: "1000000" (1 + 6 zeroes)

List Wallets In Vault

Lists all the wallets in the vault, the response is paginated

path Parameters
vaultId
required
string
header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}

Responses

Response samples

Content type
application/json
{
  • "wallets": [
    ]
}

Create Wallet

Creates a wallet, given the asset id and the account id

path Parameters
vaultId
required
string
header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}
Request Body schema: application/json
accountId
string
assetId
string
name
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "{{accountId}}",
  • "assetId": "ETH_GOERLI",
  • "name": "ETH Goerli"
}

Response samples

Content type
application/json
{
  • "accountId": "8f479e39-e32f-52ba-9109-505c3dce9a6b",
  • "address": "0xc6a08B2Dbd23166FaDa6D6e01a61e94F8AE63825",
  • "assetId": "ETH_GOERLI",
  • "balance": "0",
  • "createdAt": "2023-07-01T07:13:03.441Z",
  • "name": "ETH Goerli",
  • "vaultId": "ecd0d15b-43be-5182-8b57-d974fc49c36c",
  • "walletId": "0a2d3e91-0e2e-5c17-8675-d140ec0b21bb"
}

Get Wallet

Get a wallet by ID

path Parameters
vaultId
required
string
walletId
required
string
header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}

Responses

Response samples

Content type
application/json
{
  • "accountId": "8f479e39-e32f-52ba-9109-505c3dce9a6b",
  • "address": "0xc6a08B2Dbd23166FaDa6D6e01a61e94F8AE63825",
  • "assetId": "ETH_GOERLI",
  • "balance": "5000000000000000",
  • "createdAt": "2023-07-01T07:13:03.441Z",
  • "name": "ETH Goerli",
  • "vaultId": "ecd0d15b-43be-5182-8b57-d974fc49c36c",
  • "walletId": "0a2d3e91-0e2e-5c17-8675-d140ec0b21bb"
}

Send

Send a specific amount from this wallet. The amount must be expressed natively, so if you want to send 1 USDT, since USDT has 6 decimal places you must specify: "amount": "1000000"

path Parameters
vaultId
required
string
walletId
required
string
header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}
Request Body schema: application/json
amount
string
assetId
string
toAddress
string

Responses

Request samples

Content type
application/json
{
  • "amount": "2000000000000000",
  • "assetId": "ETH_GOERLI",
  • "toAddress": "0xe5eE8842A21c712f0033ADA9BA674F714D34C511"
}

Response samples

Content type
application/json
{
  • "amount": "2000000000000000",
  • "assetId": "ETH_GOERLI",
  • "createdAt": "2023-07-01T07:36:40.757Z",
  • "direction": "OUT",
  • "from": "0xc6a08b2dbd23166fada6d6e01a61e94f8ae63825",
  • "orgId": "e1d5928f-2c5d-4961-821d-7fcef8217e51",
  • "status": "NEW",
  • "to": "0xe5eE8842A21c712f0033ADA9BA674F714D34C511",
  • "txId": "07bae4e2-45b2-478b-b365-c6e9775a0544",
  • "type": "USER_SEND",
  • "updatedAt": "2023-07-01T07:36:40.757Z",
  • "vaultId": "ecd0d15b-43be-5182-8b57-d974fc49c36c",
  • "walletId": "0a2d3e91-0e2e-5c17-8675-d140ec0b21bb"
}

List Transactions For Wallet

Lists the transactions of a wallet, the result is paginated

path Parameters
vaultId
required
string
walletId
required
string
header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}

Responses

Response samples

Content type
application/json
{
  • "transactions": [
    ]
}

Get Transaction

Gets a transaction by ID

path Parameters
vaultId
required
string
walletId
required
string
txId
required
string
header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}

Responses

Response samples

Content type
application/json
{
  • "amount": "2000000000000000",
  • "assetId": "ETH_GOERLI",
  • "confirmations": 21,
  • "createdAt": "2023-07-01T07:36:40.757Z",
  • "direction": "OUT",
  • "from": "0xc6a08b2dbd23166fada6d6e01a61e94f8ae63825",
  • "minerFee": "31500000588000",
  • "orgId": "e1d5928f-2c5d-4961-821d-7fcef8217e51",
  • "status": "COMPLETE",
  • "to": "0xe5eE8842A21c712f0033ADA9BA674F714D34C511",
  • "txHash": "0x719042e022f062e00ebf08247a9fc69d4134c6e8742333983b75aae6c7f7b0aa",
  • "txId": "07bae4e2-45b2-478b-b365-c6e9775a0544",
  • "type": "USER_SEND",
  • "updatedAt": "2023-07-01T07:41:57.110Z",
  • "vaultId": "ecd0d15b-43be-5182-8b57-d974fc49c36c",
  • "walletId": "0a2d3e91-0e2e-5c17-8675-d140ec0b21bb"
}

Test

Test API

Test API

header Parameters
X-Cf-Key
string
Example: {{apikey}}
X-Cf-Secret
string
Example: {{apisecret}}

Responses

Response samples

Content type
application/json
{
  • "status": "ok"
}