V1::Compliance Suite: REST API Reference

This document describes the REST API and resources provided by the Compliance Suite. The REST APIs are for developers who want to integrate the Compliance Suite into other applications.

Compliance Suite’s REST API provide access to all suite resources via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The response format is JSON. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE.

Because the REST API is based on open standards, you can use any web development language to access the API.

Authentication 1

The Compliance Suite API uses a Jason Web Token to secure all data requests. Each one of the request needs to contain the JWT which has an expiration of 30 minutes and needs to be refreshed after that period of time.
To request a JWT it is necessary to make a POST request to /auth/token with the credentials previously facilitated by ZenLedger.
This same resource will be used to refresh the token after expiration.

Here is an example in javascript of how to request a JWT:

const clientId = 'provided_client_id';
const clientSecret = 'provided_secret';
const tokenEndpoint = 'https://zenledger.io/auth/token';
const requestOptions = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    client_id: clientId,
    client_secret: clientSecret,
    grant_type: 'client_credentials',
  }),
};
fetch(tokenEndpoint, requestOptions)
  .then((response) => {
    if (!response.ok) {
      throw new Error('Failed to obtain JWT token');
    }
    return response.json();
  })
  .then((data) => {
    const token = data.access_token;
    console.log('JWT Token:', token);
    // You can now use the token for further requests or store it for future use.
  })
  .catch((error) => {
    console.error('Error:', error);
  });

Once the JWT is created you can use it for every other request to the API:

const jwtToken = 'your-jwt-token';
const apiUrl = 'https://zenledger.io/compliance/api/v1/companies';
fetch(apiUrl, {
  method: 'GET',
  headers: {
    'Content-Type': 'application/json'
    'Authorization': 'Bearer ${jwtToken}''
  }
})
  .then(response => response.json())
  .then(response_data => {
    // Handle the response data (list of companies)
    console.log('companies list:', response_data.data);
  })
  .catch(error => {
    // Handle any errors
    console.error('Error:', error);
  });

raw

JWT request | POST {{base_url}}/oauth/token

Description

The server response can vary based on the validity of the provided POST body:

Success (HTTP status 200):
- Headers: The response includes various headers such as Content-Type, Cache-Control, Expires, and more.
- Body: The response body is a JSON object containing the access_token, token_type, expires_in, and scope fields. The access_token is the JWT that should be included in the Authorization header for subsequent API requests.
Unauthorized (HTTP status 401):
- Headers: The response includes various headers such as Content-Type, Cache-Control, Expires, and more.
- Body: The response body is a JSON object containing the error and error_description fields, indicating an invalid client or failed authentication.
Bad Request (HTTP status 400):
- Headers: The response includes various headers such as Content-Type, Cache-Control, Expires, and more.
- Body: The response body is a JSON object containing the error and error_description fields, indicating an invalid request.

Headers

Key	Value	Description
Content-Type	application/json

Body

{ "client_id": "{{oauth_client_id}}", "client_secret": "{{oauth_client_secret}}", "grant_type": "client_credentials" }

Key	Value	Description
client_secret	{{oauth_client_secret}}
grant_type	client_credentials

Key	Value	Description
client_id	{{oauth_client_id}}
client_secret	{{oauth_client_secret}}

Companies 5

The Companies API resource enable management of company data within the application, including the creation, retrieval, updating and deletion of company details.

Create Company Endpoint: This POST endpoint allows for the creation of new companies, requiring authentication via a bearer token.
Get Companies Endpoint: This GET endpoint retrieves a list of all companies in the system, with optional filtering by company reference. Authentication is required.
Update Company Details Endpoint: This PUT endpoint facilitates the updating of a specific company details. It requires the company’s unique identifier in the URL and authentication details in the request.
Delete Company Endpoint: This DELETE endpoint facilitates the deletion of a specific company. It requires the company’s unique identifier in the URL and authentication details in the request.

These endpoints form the basis of company data management in the application, adhering to standard HTTP protocols and returning appropriate status codes based on the request’s success or failure.

GET companies | GET {{base_url}}/compliance/api/v1/companies

Description

GET /companies

Returns a list of all active companies that exist in the system by making a GET request to the path /compliance/api/v1/companies on the base URL.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

QUERY PARAMETERS

NONE

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

raw

GET company | GET {{base_url}}/compliance/api/v1/companies/{{company_reference}}

Description

GET /companies/{companyReference}

Returns the details of the requested company by making a GET request to the path /compliance/api/v1/companies/{company_reference} on the base URL

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

QUERY PARAMETERS

NONE

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

raw

CREATE company | POST {{base_url}}/compliance/api/v1/companies/

Description

POST /companies

Creates a new company which is linked to the enterprise by making a POST request to the /compliance/api/v1/companies/ endpoint is used to create a new company in the system.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

QUERY PARAMETERS

NONE

BODY

*In JSON format

name (optional) string Legal name of the company
reference string Own company reference
import_notification_url (optional) string if set, Webhook notifications will be sent here after each import completed

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Body

{ "name": "Company Name", "reference": "{{company_reference}}" }

raw

DELETE company | DELETE {{base_url}}/compliance/api/v1/companies/{{company_reference}}

Description

DELETE /companies/{companyReference}

Deletes a company which is linked to the enterprise by making a DELETE request to the /compliance/api/v1/companies/{company_reference} endpoint.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

QUERY PARAMETERS

NONE

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

raw

UPDATE company details | PUT {{base_url}}/compliance/api/v1/companies/{{company_reference}}

Description

PUT /companies

Updates the details of a company by making a PUT request to the path /compliance/api/v1/companies/{company_reference} on the base URL

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

QUERY PARAMETERS

NONE

BODY

*In JSON format

name (optional) string Legal name of the company
import_notification_url (optional) string if set, Webhook notifications will be sent here after each import completed

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Body

{ "name": "New Company Name" }

Users 5

This folder is dedicated to managing user-related operations within the Compliance API. It contains endpoints that enable retrieving, updating and deleting user information within specific companies.

Please note that for all the endpoints, the {{jwt_token}}, {{base_url}}, {{company_reference}}, and {{user_id}} placeholders should be replaced with the actual values based on the context and environment in which the requests are made.

raw

GET company users | GET {{base_url}}/compliance/api/v1/companies/{{company_reference}}/users

Description

GET /companies/{companyReference}/users

Returns a list of all active users that exist in the system for a specific company by making a GET request to the path /companies/{company_reference}/users on the base URL.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

URi PARAMETERS

companyReference string The ID of a specific company

QUERY PARAMETERS

NONE

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

raw

GET company user | GET {{base_url}}/compliance/api/v1/companies/{{company_reference}}/users/{{user_id}}

Description

GET /companies/{companyReference}/users/{userId}

Returns the details of a specific user by making a GET request to the path /companies/{company_reference}/users/{user_id} on the base URL.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

URi PARAMETERS

companyReference string The ID of a specific company
userId string The ID of a specific user

QUERY PARAMETERS

NONE

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

raw

CREATE company user | POST {{base_url}}/compliance/api/v1/companies/{{company_reference}}/users

Description

POST /companies/{companyReference}/users

Creates a new company user which is linked to the company by making a POST request to the /compliance/api/v1/companies/{company_reference}/users endpoint is used to create a new user in the system.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

URi PARAMETERS

companyReference string The ID of a specific company

QUERY PARAMETERS

NONE

BODY

*In JSON format

email string Email address of the user
first_name (optional) string First name of the user
last_name (optional) string Last name of the user

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Body

{ "email": "[email protected]", "first_name": "John", "last_name": "Doe" }

raw

UPDATE user details | PUT {{base_url}}/compliance/api/v1/companies/{{company_reference}}/users/{{user_id}}

Description

UPDATE /companies/{companyId}/users/{userId}

Updates the details of a user by making a PUT request to the path /compliance/api/v1/companies/{company_reference}/users/{user_id} on the base URL

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

URi PARAMETERS

companyReference string The ID of a specific company
userId string The ID of a specific user

QUERY PARAMETERS

NONE

BODY

*In JSON format

email (optional) string Email address of the user
first_name (optional) string First name of the user
last_name (optional) string Last name of the user

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Body

{ "first_name": "user 1 of referenced company", "last_name": "user 1 of referenced company", "email": "[email protected]" }

raw

DELETE company user | DELETE {{base_url}}/compliance/api/v1/companies/{{company_reference}}/users/{{user_id}}

Description

DELETE /companies/{companyReference}/users/{userId}

Deletes a user which is linked to the company by making a DELETE request to the /compliance/api/v1/companies/{company_reference}/users/{user_id} endpoint.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

URi PARAMETERS

companyReference string The ID of a specific company
userId string The ID of a specific user

QUERY PARAMETERS

NONE

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Transactions 2

This folder contains endpoints related to retrieving transaction information for a user within the Compliance API. These endpoints allow you to fetch transactions for a user based on various criteria, such as user ID, date range, and currency.

raw

GET transactions for user | GET {{base_url}}/compliance/api/v1/companies/{{company_reference}}/users/{{user_id}}/transactions

Description

GET /companies/{companyReference}/users/{userId}/transactions

Returns a list of the user’s transactions by making a GET request to the path /companies/{company_reference}/users/{user_id}/transactions on the base URL.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

*Results paginated with 100 elements per page

Request

URi PARAMETERS

companyReference string The ID of a specific company
userId string The ID of a specific user

QUERY PARAMETERS

currency_code string Filter transactions by currency code
date_from string Specific cut-off date for the transactions list (beginning of the list)
date_to string Specific cut-off date for the transactions list (end of the list)
page number Specific page requested for the paginated results

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Example Request

URL: https://api.zenledger.io/compliance/api/v1/companies/{{company_reference}}/users/{{user_id}}/transactions?page=1

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Query

Key	Value	Description
page	1

Example Response

Body

{ "api_version": "1.0", "data": { "transactions": [ { "reference": "NTM3NTI4Nzcy", "transaction_timestamp": "2021-01-24T00:00:00Z", "transaction_type": "buy", "amount_incoming": 10, "currency_incoming": "ETH", "amount_outgoing": 13916.09, "currency_outgoing": "USD", "fee_amount": 0, "fee_currency": "USD", "source": "Manual", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "manual", "transaction_id": "transaction_id" }, { "reference": "NTM3NTI4Nzc2", "transaction_timestamp": "2021-01-31T00:00:00Z", "transaction_type": "sell", "amount_incoming": 2629.97, "currency_incoming": "USD", "amount_outgoing": 2, "currency_outgoing": "ETH", "fee_amount": 0.02, "fee_currency": "ETH", "source": "Manual", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "manual", "transaction_id": "transaction_id" }, { "reference": "NTM3NTI4Nzcz", "transaction_timestamp": "2021-02-11T00:00:00Z", "transaction_type": "buy", "amount_incoming": 5, "currency_incoming": "ETH", "amount_outgoing": 8918.99, "currency_outgoing": "USD", "fee_amount": 0, "fee_currency": "USD", "source": "Manual", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "manual", "transaction_id": "transaction_id" }, { "reference": "NTM3NTI4Nzc3", "transaction_timestamp": "2021-02-28T00:00:00Z", "transaction_type": "sell", "amount_incoming": 6938.64, "currency_incoming": "USD", "amount_outgoing": 4.9, "currency_outgoing": "ETH", "fee_amount": 0.23, "fee_currency": "ETH", "source": "Manual", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "manual", "transaction_id": "transaction_id" }, { "reference": "NTM3NTI4Nzc0", "transaction_timestamp": "2021-03-03T00:00:00Z", "transaction_type": "buy", "amount_incoming": 5, "currency_incoming": "ETH", "amount_outgoing": 7879.27, "currency_outgoing": "USD", "fee_amount": 0.12, "fee_currency": "ETH", "source": "Manual", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "manual", "transaction_id": "transaction_id" }, { "reference": "NTM3NTI4Nzc1", "transaction_timestamp": "2021-04-04T00:00:00Z", "transaction_type": "buy", "amount_incoming": 3450, "currency_incoming": "ADA", "amount_outgoing": 4110.4, "currency_outgoing": "USD", "fee_amount": 12, "fee_currency": "ADA", "source": "Manual", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "manual", "transaction_id": "transaction_id" }, { "reference": "NTM3NTI4Nzc4", "transaction_timestamp": "2021-04-05T00:00:00Z", "transaction_type": "sell", "amount_incoming": 16652.31, "currency_incoming": "USD", "amount_outgoing": 7.9, "currency_outgoing": "ETH", "fee_amount": 0.28, "fee_currency": "ETH", "source": "Manual", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "manual", "transaction_id": "transaction_id" }, { "reference": "NTM5NTExOTQ4", "transaction_timestamp": "2021-05-29T13:15:00Z", "transaction_type": "buy", "amount_incoming": 0.5, "currency_incoming": "BTC", "amount_outgoing": 17293.1, "currency_outgoing": "USD", "fee_amount": 20, "fee_currency": "USD", "source": "Binance", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "binance", "transaction_id": "transaction_id" } ] }, "meta": { "current_page": 1, "total_entries": 8, "total_pages": 1 } }

Code:

200

raw

GET transactions for all user of a company | GET {{base_url}}/compliance/api/v1/companies/{{company_reference}}/transactions

Description

GET /companies/{companyReference}/transactions

Returns a list of all the users of a company with all their transactions by making a GET request to the path /companies/{company_reference}/transactions on the base URL.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

*Results paginated with 100 elements per page

Request

URi PARAMETERS

companyReference string The ID of a specific company

QUERY PARAMETERS

currency_code string Filter transactions by currency code
date_from string Specific cut-off date for the transactions list (beginning of the list)
date_to string Specific cut-off date for the transactions list (end of the list)
page number Specific page requested for the paginated results

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Example Request

URL: https://api.zenledger.io/compliance/api/v1/companies/{{company_reference}}/transactions?page=4003

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Query

Key	Value	Description
page	4003

Example Response

Body

{ "api_version": "1.0", "data": { "transactions": [ { "reference": "NDgwNjAxMzIx", "transaction_timestamp": "2021-08-01T10:55:12Z", "transaction_type": "trade", "amount_incoming": 0.01334009, "currency_incoming": "BCH", "amount_outgoing": 6.1496480891, "currency_outgoing": "EUR", "fee_amount": 0.00491971847128, "fee_currency": "EUR", "source": "Coinbase Pro", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "coinbase-pro", "transaction_id": "transaction_id", "user_id": "02f5014b-a9e9-4d28-bb13-f3e15ae2dbd0" }, { "reference": "NDgwMzY5MDQw", "transaction_timestamp": "2021-08-01T10:55:13Z", "transaction_type": "buy", "amount_incoming": 28.59, "currency_incoming": "RLC", "amount_outgoing": 99.2073, "currency_outgoing": "USD", "fee_amount": 0.07936584, "fee_currency": "USD", "source": "Coinbase Pro", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "coinbase-pro", "transaction_id": "transaction_id", "user_id": "02f5014b-a9e9-4d28-bb13-f3e15ae2dbd0" }, { "reference": "NDgwMjkyODMz", "transaction_timestamp": "2021-08-01T10:55:15Z", "transaction_type": "trade", "amount_incoming": 0.38364659, "currency_incoming": "LTC", "amount_outgoing": 47.4072091263, "currency_outgoing": "EUR", "fee_amount": 0.03792576730104, "fee_currency": "EUR", "source": "Coinbase Pro", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "coinbase-pro", "transaction_id": "transaction_id", "user_id": "02f5014b-a9e9-4d28-bb13-f3e15ae2dbd0" }, { "reference": "NDgwODUzMTky", "transaction_timestamp": "2021-08-01T10:55:17Z", "transaction_type": "trade", "amount_incoming": 10.29, "currency_incoming": "SUSHI", "amount_outgoing": 0.03521238, "currency_outgoing": "ETH", "fee_amount": 0.000028169904, "fee_currency": "ETH", "source": "Coinbase Pro", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "coinbase-pro", "transaction_id": "transaction_id", "user_id": "02f5014b-a9e9-4d28-bb13-f3e15ae2dbd0" }, { "reference": "NDgwODc1MTU2", "transaction_timestamp": "2021-08-01T10:55:19Z", "transaction_type": "trade", "amount_incoming": 70, "currency_incoming": "XLM", "amount_outgoing": 17.1367, "currency_outgoing": "EUR", "fee_amount": 0.01370936, "fee_currency": "EUR", "source": "Coinbase Pro", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "coinbase-pro", "transaction_id": "transaction_id", "user_id": "02f5014b-a9e9-4d28-bb13-f3e15ae2dbd0" }, { "reference": "NDgwNjE2OTM4", "transaction_timestamp": "2021-08-01T10:55:19Z", "transaction_type": "trade", "amount_incoming": 15.4, "currency_incoming": "OMG", "amount_outgoing": 50.02536, "currency_outgoing": "GBP", "fee_amount": 0.040020288, "fee_currency": "GBP", "source": "Coinbase Pro", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "coinbase-pro", "transaction_id": "transaction_id", "user_id": "02f5014b-a9e9-4d28-bb13-f3e15ae2dbd0" }, { "reference": "NDgwNTE3OTI4", "transaction_timestamp": "2021-08-01T10:55:19Z", "transaction_type": "trade", "amount_incoming": 0.009, "currency_incoming": "NMR", "amount_outgoing": 0.2490471, "currency_outgoing": "GBP", "fee_amount": 0.00019923768, "fee_currency": "GBP", "source": "Coinbase Pro", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "coinbase-pro", "transaction_id": "transaction_id", "user_id": "02f5014b-a9e9-4d28-bb13-f3e15ae2dbd0" }, { "reference": "NDgwNTE3OTY4", "transaction_timestamp": "2021-08-01T10:55:19Z", "transaction_type": "trade", "amount_incoming": 1.56, "currency_incoming": "NMR", "amount_outgoing": 43.168164, "currency_outgoing": "GBP", "fee_amount": 0.0345345312, "fee_currency": "GBP", "source": "Coinbase Pro", "source_id": "36b00248-d2c8-419b-973f-63815a7a6b5d", "source_reference": "coinbase-pro", "transaction_id": "transaction_id", "user_id": "02f5014b-a9e9-4d28-bb13-f3e15ae2dbd0" } ] }, "meta": { "current_page": 4003, "total_entries": 800485, "total_pages": 8005 } }

Code:

200

Transaction Types Glossary 3

This folder all different types of transactions that can be found in both transactions and holdings resources.

The property that contains this values is called transaction_type.

There are three different short of transactions and each one of them have different types which are described below:

formdata

Deposits | VALUES

Description

A deposit transaction is any transaction where a crypto asset enters your account that is not paired as a trade with another crypto asset. For example, if a friend sent you 50 USDC that would be a Deposit transaction (subtype Incoming). Also, if you purchased 50 USDC for 50 USD this would also be a Deposit transaction (subtype Buy).

Here are all of the Deposit transaction subtypes:

Body

Key	Value	Description
Airdrop		Crypto assets freely given to an account through Airdrop.
Buy		Purchasing a crypto asset with fiat (USD). Example, buying 1 BTC with 20,000 USD.
Dividend Received		This is a type of reward associated with receiving dividends, reported as income and receives cost basis at the time of acquisition.
Forks		Forks are essentially another type of reward, reported as income and receives cost basis at the time of acquisition. This occurs when a blockchain forks, and effectively the user now has assets duplicated on another chain (the fork and the original).
Gifts Received		Cost basis is determined when the asset is received, but it is not reported as income.
Incoming		This type is used if crypto assets are received from an external source that is not one of the added accounts. For example, if an unknown third party sent the account 50 USDC it would be an incoming transaction.
Interest Received		Another type of reward associated with earning interest, reported as income and receives cost basis at the time of acquisition.
Masternode		A type of income/reward associated with setting up a master node, reported as income and receives cost basis at the time of acquisition.
Mined		Another type of income/reward associated with mining cryptocurrency, reported as income and receives cost basis at the time of acquisition.
Misc Reward		Another type of reward if other categories don’t properly describe it, reported as income and receives cost basis at the time of acquisition.
NFT Mint		The process of minting (creating) an NFT. If there were assets spent to form the mint, the cost basis will be the value of those assets (in the case of multiple mints simultaneously, the basis is evenly distributed to all of the NFTs minted). If nothing was used to mint the NFT, the cost basis will generally be 0. Not reported as income.
Payments		Crypto assets received as income. Basis is determined at the time of acquisition.
Staking Return		Staked assets returning to the user’s account. The assets will keep their original basis and holding periods, and are not reported as income. Effectively not a taxable event.
Staking Reward		Any rewards associated with staking an asset. This is reported as income, with basis determined at the time of acquisition.

formdata

Trades | VALUES

Description

Trades are transactions that involve the trading crypto assets for other crypto assets. For example, trading 1 BTC for 10 ETH is reported as a trade.

These are not to be confused as Deposits/Withdrawal transactions, where a user may buy or sell crypto assets for fiat (ex: USD) currency.

Here are all of the Trade transaction subtypes:

Body

Key	Value	Description
Liquidity Pool		Liquidity Pools that return LP tokens are effectively treated as trades, with the cost basis of the received asset determined by the proceeds of the assets leaving the account in the trade.
Margin Trading		Trading with borrowed assets. Effectively handled identically to normal trading.
NFT Mint		Trading crypto assets to create/mint NFTs. The resulting NFT(s) will receive basis according to the proceeds of the assets traded. In the case of multiple mints simultaneously, the basis will be evenly distributed among all NFT’s minted.
NFT Trade		Any trade that involves an NFT will also be labeled as an NFT trade. This is handled identically to normal trading.

formdata

Withdrawals | VALUES

Description

Withdrawal transactions include any transaction where a crypto asset leaves the user’s account without receiving a crypto asset in return. For example, if the user send 500 USDC to an unknown address, this would be a Withdrawal transaction (subtype Outgoing). Additionally, if a user sells 500 USDC for 500 USD, this would also be a Withdrawal transaction (subtype Sell). If a user trades 500 USDC for 1 ETH, that is not a Withdrawal transaction: that is a trade.

Here are all of the Withdraw transaction subtypes:

Body

Key	Value	Description
Donation 501c3		Assets leaving the account. Gains are set to 0, regardless of basis/proceeds.
Fee		Sometimes fees are reported separately from transactions.
Gifts Sent		Assets leaving the account. Gains are set to 0, regardless of basis/proceeds.
Outgoing		Sending assets to unknown parties or accounts that don’t belong to the user.
Purchases		Using cryptocurrency to purchase something else.
Sell		Selling cryptocurrency for fiat (ex: USD).
Staking Lockup		Assets leaving a user’s account going into a staking system.

Holdings 5

This folder contains endpoints related to retrieving holdings information for users of a company. Holdings represent the assets held by users in their uploaded accounts. The endpoints in this folder allow retrieving holdings based on different criteria such as source ID and user ID.

raw

GET holdings for user | GET {{base_url}}/compliance/api/v1/companies/{{company_reference}}/users/{{user_id}}/holdings

Description

GET /companies/{companyReference}/users/{userId}/holdings

Returns a list of the user holdings by making a GET request to the path /companies/{company_reference}/users/{user_id}/holdings on the base URL.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

*Results paginated with 20 elements per page

Request

URi PARAMETERS

companyReference string The ID of a specific company
userId string The ID of a specific user

QUERY PARAMETERS

currency_code string Filter transactions by currency code
date_from string Specific cut-off date for the transactions list (beginning of the list)
date_to string Specific cut-off date for the transactions list (end of the list)
page number Specific page requested for the paginated results

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Example Request

URL: {{base_url}}/compliance/api/v1/companies/{{company_reference}}/users/{{user_id}}/holdings

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Example Response

Body

{ "api_version": "1.0", "data": [ { "holdings": [ { "source_id": "036bf030-eb8e-49f4-a418-b5eeaebaf287", "source_type": "wallet", "source_name": "BTC Wallet", "source_reference": "btc-wallet", "last_updated": "2023-10-03T16:07:31.569Z", "import_status": "complete", "last_imported_transaction": { "reference": "2ad80d9ef19b0e954e5406b645cb977f", "timestamp": "2023-10-03T16:06:39Z", "imported_at": "2023-10-03T16:07:31.158Z" }, "assets": [ { "currency_reference": "bitcoin", "currency_name": "Bitcoin", "currency_symbol": "BTC", "currency_price": 29118.0, "balance": "1.05328886", "staked_balance": "0", "total_balance": "1.05328886", "total_fiat": "30669.665025480004" }, { "currency_reference": "binance-peg-cardano", "currency_name": "Binance-Peg Cardano", "currency_symbol": "ADA", "currency_price": 0.244828, "balance": "1.02", "staked_balance": "1", "total_balance": "2.02", "total_fiat": "30669.665025480004" } ] }, { "source_id": "159757fb-a754-42f7-9678-fafdeeda2daf", "source_type": "wallet", "source_name": "Metamask", "source_reference": "metamask", "last_updated": "2023-10-04T12:16:10.680Z", "import_status": "complete", "last_imported_transaction": { "reference": "01a443f847d58de62e656f4c969893aa", "timestamp": "2023-09-26T00:52:59Z", "imported_at": "2023-10-03T16:42:56.273Z" }, "assets": [ { "currency_reference": "binance-peg-cardano", "currency_name": "Binance-Peg Cardano", "currency_symbol": "ADA", "currency_price": 0.244828, "balance": "369.953785", "staked_balance": "0", "total_balance": "369.953785", "total_fiat": "90.57504527398" }, { "currency_reference": "binance-peg-xrp", "currency_name": "Binance-Peg XRP", "currency_symbol": "XRP", "currency_price": 0.479696, "balance": "16.017202", "staked_balance": "0", "total_balance": "16.017202", "total_fiat": "7.683387730592001" }, { "currency_reference": "bitcoin", "currency_name": "Bitcoin", "currency_symbol": "BTC", "currency_price": 25735.0, "balance": "0.0319015248335586", "staked_balance": "0", "total_balance": "0.0319015248335586", "total_fiat": "820.9857415916305" } ] } ], "base_currency": "USD" } ] }

Code:

200

raw

GET holdings for user by source | GET {{base_url}}/compliance/api/v1/companies/{{company_reference}}/users/{{user_id}}/holdings/{{source_id}}

Description

GET /companies/{companyReference}/users/{userId}/holdings/{sourceId}

Returns the holdings of a specific source of a user by making a GET request to the path /companies/{company_reference}/users/{user_id}/holdings/{source_id} on the base URL.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

URi PARAMETERS

companyReference string The ID of a specific company
userId string The ID of a specific user
sourceId string The ID of a specific source

QUERY PARAMETERS

NONE

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

raw

DELETE user source | DELETE {{base_url}}/compliance/api/v1/companies/{{company_reference}}/users/{{user_id}}/holdings/{{source_id}}

Description

DELETE /companies/{companyReference}/users/{userId}/holdings/{sourceId}

Deletes a user’s source along with its transactions by making a DELETE request to the /compliance/api/v1/companies/{company_reference}/users/{user_id}/holdings/{source_id} endpoint.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

Request

URi PARAMETERS

companyReference string The ID of a specific company
userId string The ID of a specific user
sourceId string The ID of a specific source

QUERY PARAMETERS

NONE

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

raw

GET holdings for all users of a company | GET {{base_url}}/compliance/api/v1/companies/{{company_reference}}/holdings

Description

GET /companies/{companyReference}/holdings

Returns a list of all the users of a company with all their holdings by making a GET request to the path /companies/{company_reference}/holdings on the base URL.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

*Results paginated with 20 elements per page

Request

URi PARAMETERS

companyReference string The ID of a specific company

QUERY PARAMETERS

page number Specific page requested for the paginated results

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Example Request

URL: {{base_url}}/compliance/api/v1/companies/{{company_reference}}/holdings

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Example Response

Body

{ "api_version": "1.0", "data": [ { "users": [ { "id": "b1538a4f-1f3c-420c-b19e-e16c43a01e12", "holdings": [], "base_currency": "USD" }, { "id": "44e5888f-13ab-4b57-b357-d2615f45af9c", "holdings": [], "base_currency": "USD" }, { "id": "b3d2e23b-f9b0-4311-99c8-fe737ec63acd", "holdings": [ { "source_id": "036bf030-eb8e-49f4-a418-b5eeaebaf287", "source_type": "wallet", "source_name": "BTC Wallet", "source_reference": "btc-wallet", "last_updated": "2023-10-03T16:07:31.569Z", "import_status": "complete", "last_imported_transaction": { "reference": "2ad80d9ef19b0e954e5406b645cb977f", "timestamp": "2023-10-03T16:06:39Z", "imported_at": "2023-10-03T16:07:31.158Z" }, "assets": [ { "currency_reference": "bitcoin", "currency_name": "Bitcoin", "currency_symbol": "BTC", "currency_price": 29118.0, "balance": "1.05328886", "staked_balance": "0", "total_balance": "1.05328886", "total_fiat": "30669.665025480004" } ] }, { "source_id": "159757fb-a754-42f7-9678-fafdeeda2daf", "source_type": "wallet", "source_name": "Metamask", "source_reference": "metamask", "last_updated": "2023-10-04T12:16:10.680Z", "import_status": "complete", "last_imported_transaction": { "reference": "01a443f847d58de62e656f4c969893aa", "timestamp": "2023-09-26T00:52:59Z", "imported_at": "2023-10-03T16:42:56.273Z" }, "assets": [ { "currency_reference": "binance-peg-cardano", "currency_name": "Binance-Peg Cardano", "currency_symbol": "ADA", "currency_price": 0.244828, "balance": "369.953785", "staked_balance": "0", "total_balance": "369.953785", "total_fiat": "90.57504527398" }, { "currency_reference": "binance-peg-xrp", "currency_name": "Binance-Peg XRP", "currency_symbol": "XRP", "currency_price": 0.479696, "balance": "16.017202", "staked_balance": "0", "total_balance": "16.017202", "total_fiat": "7.683387730592001" }, { "currency_reference": "bitcoin", "currency_name": "Bitcoin", "currency_symbol": "BTC", "currency_price": 25735.0, "balance": "0.0319015248335586", "staked_balance": "0", "total_balance": "0.0319015248335586", "total_fiat": "820.9857415916305" } ] } ], "base_currency": "USD" } ] } ], "meta": { "current_page": 1, "total_entries": 4, "total_pages": 1 } }

Code:

200

formdata

Import Status Glossary | VALUES

Description

This are all different status that can be set to a source depending of the import process outcome.

The property that contains this values is called status and it is present for each of the sources listed in the holdings response payload.

There are three different issues that could make an new import or the refresh of an existing one fail:

Body

Key	Value	Description
COMPLETE		The user data was successfully updated in the last connection
SOURCE_NOT_FOUND		The selected exchange or wallet does no longer exist
INVALID_API_KEY		The API credentials provided by the user are no longer valid
BAD_ADDRESS		The wallet address provided by the user is not valid
INVALID_COIN		The currency provided by the user does not exist
INVALID_EXCHANGE		The exchange is wrong
UNEXPECTED_ERROR		Due to continuous changes made by each one of the supported exchanges without a notice, we try to be up to date. This error will be shown as we can not identify the real cause.

Supported Currencies 1

The currencies resource in the Compliance API provides information about retrieving the list of supported currencies. By making a GET request to the /compliance/api/v1/currencies endpoint, you can retrieve the details of available currencies. The request requires authentication using a bearer token.

Please note that the response example for this endpoint will contain the API version and a data object containing an array of currencies. Each currency object includes a reference, code, and name.

Use this information to integrate and work with the supported currencies of the Compliance API.

GET currencies | GET {{base_url}}/compliance/api/v1/currencies

Description

GET /currencies

Returns a paginated list of supported cryptocurrencies by making a GET request to the path /compliance/api/v1/currencies on the base URL.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

*Results paginated with 100 elements per page

Request

QUERY PARAMETERS

page number Specific page requested for the paginated results

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Query

Key	Value	Description
page	42

Example Request

URL: {{base_url}}/compliance/api/v1/currencies?page=42

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Query

Key	Value	Description
page	42

Example Response

Body

{ "api_version": "1.0", "data": { "currencies": [ { "reference": "council-of-apes", "name": "Council of Apes", "symbol": "COAPE", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x55006895f398d7713d69081144b19d8c9022b582" } ] }, { "reference": "counosx", "name": "CounosX", "symbol": "CCXX", "blockchains": [] }, { "reference": "counterparty", "name": "Counterparty", "symbol": "XCP", "blockchains": [] }, { "reference": "county-metaverse", "name": "County Metaverse", "symbol": "COUNTY", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x1967cabd079fcdd363a044f1444bf00a94558a2f" } ] }, { "reference": "couponbay", "name": "CouponBay", "symbol": "CUP", "blockchains": [ { "platform": "ethereum", "contract": "0x3209d14ff61766359e64aceff91877cec2ad968e" } ] }, { "reference": "cousin-doge", "name": "Cousin Doge", "symbol": "COUSINDOGE", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xda8df4506de8e110cc216937945963bab380a615" } ] }, { "reference": "coution-live", "name": "COUTION LIVE", "symbol": "CTL", "blockchains": [ { "platform": "tron", "contract": "tdaogsywy3wwuyktk8z1fxsa8nxnmdfk9a" } ] }, { "reference": "covalent", "name": "Covalent", "symbol": "CQT", "blockchains": [ { "platform": "ethereum", "contract": "0xd417144312dbf50465b1c641d016962017ef6240" } ] }, { "reference": "covalent-cova", "name": "Cova Unity", "symbol": "COVA", "blockchains": [ { "platform": "ethereum", "contract": "0xb37a769b37224449d92aac57de379e1267cd3b00" } ] }, { "reference": "covenant-child", "name": "Covenant", "symbol": "COVN", "blockchains": [ { "platform": "ethereum", "contract": "0x19ac2659599fd01c853de846919544276ad26f50" } ] }, { "reference": "covercompared", "name": "CoverCompared", "symbol": "CVR", "blockchains": [ { "platform": "ethereum", "contract": "0x3c03b4ec9477809072ff9cc9292c9b25d4a8e6c6" } ] }, { "reference": "cover-protocol", "name": "Cover Protocol", "symbol": "COVER", "blockchains": [ { "platform": "ethereum", "contract": "0x4688a8b1f292fdab17e9a90c8bc379dc1dbd8713" }, { "platform": "fantom", "contract": "0xb01e8419d842beebf1b70a7b5f7142abbaf7159d" } ] }, { "reference": "covesting", "name": "Covesting", "symbol": "COV", "blockchains": [ { "platform": "ethereum", "contract": "0xada86b1b313d1d5267e3fc0bb303f0a2b66d0ea7" }, { "platform": "binance-smart-chain", "contract": "0x0f237db17aa4e6de062e6f052bd9c805789b01c3" } ] }, { "reference": "covey", "name": "Covey", "symbol": "$CVY", "blockchains": [] }, { "reference": "covicoin", "name": "CoviCoin", "symbol": "CVC", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xc6f0a9b75fa529dcc0f90459e30684e7ed9a9ea6" } ] }, { "reference": "covid-19-recovery-token", "name": "COVID-19 Recovery Token", "symbol": "COVDR", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xdb8afb917a2d4848ee5b3bed7f6c0bab0555427d" } ] }, { "reference": "covid-doge", "name": "Covid Doge", "symbol": "COVID DOGE", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xae1f20ca661ec552c0664a73ad5e5963824f92e1" } ] }, { "reference": "covid-slice", "name": "Covid Slice", "symbol": "COVID19", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x8d5eb659959c68bd78a4f6f2ecccbbcb8c2cfb79" } ] }, { "reference": "covid-token", "name": "Covid Token", "symbol": "COVIDTOKEN", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x23c28e9346c82228fb2b62b20b6fe5d75989f5b2" } ] }, { "reference": "cow--4", "name": "COWRY", "symbol": "COW", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xb149dd64ea4b173e5fc9ecf77bd380418695185d" } ] }, { "reference": "cowboy-snake", "name": "Cowboy Snake", "symbol": "COWS", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x33b48893b8f119fb45f431b36f830a9584804201" } ] }, { "reference": "cow-inu", "name": "Cow Inu", "symbol": "CI", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xceafc372af7fddccbfd28f10329710e58bb2f970" } ] }, { "reference": "cow-protocol", "name": "CoW Protocol", "symbol": "COW", "blockchains": [ { "platform": "ethereum", "contract": "0xdef1ca1fb7fbcdc777520aa7f396b4e015f497ab" }, { "platform": "xdai", "contract": "0x177127622c4a00f3d409b75571e12cb3c8973d3c" } ] }, { "reference": "cowrie", "name": "Cowrie", "symbol": "COWRIE", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xde51d1599339809cafb8194189ce67d5bdca9e9e" } ] }, { "reference": "cowry", "name": "COWRY", "symbol": "COW", "blockchains": [] }, { "reference": "coxswap", "name": "Coxswap", "symbol": "COX", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x17fea92ca2e7570d07b63ecd6b698e01386555a4" } ] }, { "reference": "coxswap-2", "name": "Coxswap", "symbol": "COX", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x2266cfa689da2186f307f2dd8beafa12a4ad9709" } ] }, { "reference": "cpc--4", "name": "CryptoPerformance Coin", "symbol": "CPC", "blockchains": [] }, { "reference": "cpchain", "name": "CPChain", "symbol": "CPC", "blockchains": [ { "platform": "ethereum", "contract": "0xfae4ee59cdd86e3be9e8b90b53aa866327d7c090" }, { "platform": "binance-smart-chain", "contract": "cpc-fed" } ] }, { "reference": "cplay-network", "name": "CPLAY Network", "symbol": "CPLAY", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x740e08e52542df19d7f2f9cbf3924ac0bfe53071" } ] }, { "reference": "cpos-cloud-payment", "name": "CPOS Cloud Payment", "symbol": "CPOS", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xc0dc5adfae1dada9111f376810d772cabd9b6f13" } ] }, { "reference": "cprop", "name": "CPROP", "symbol": "CPROP", "blockchains": [ { "platform": "ethereum", "contract": "0x0fb843d37aa2a99db8d81af9fe2f0a6485c7c002" } ] }, { "reference": "cpuchain", "name": "CPUchain", "symbol": "CPU", "blockchains": [] }, { "reference": "cpucoin", "name": "CPUcoin", "symbol": "CPU", "blockchains": [ { "platform": "ethereum", "contract": "0x6d52dfefb16bb9cdc78bfca09061e44574886626" } ] }, { "reference": "crabada", "name": "Crabada", "symbol": "CRA", "blockchains": [ { "platform": "avalanche", "contract": "0xa32608e873f9ddef944b24798db69d80bbb4d1ed" } ] }, { "reference": "crabada-amulet", "name": "Crabada Amulet", "symbol": "CRAM", "blockchains": [ { "platform": "avalanche", "contract": "0xd2cd7a59aa8f8fdc68d01b1e8a95747730b927d3" } ] }, { "reference": "crab-market", "name": "Crab Market", "symbol": "CRAB", "blockchains": [ { "platform": "ethereum", "contract": "0x24bcec1afda63e622a97f17cff9a61ffcfd9b735" } ] }, { "reference": "crab-rave-token", "name": "Crab Rave Token", "symbol": "CRABS", "blockchains": [ { "platform": "ethereum", "contract": "0x2c9715d6d95443c3bdf29e473ad168ff6fa6627d" } ] }, { "reference": "crabstrike", "name": "CrabStrike", "symbol": "CST", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x3993453b9587e06a0e925727fd844d2d2babd39f" } ] }, { "reference": "cracle", "name": "Cracle", "symbol": "CRA", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x0fc0b3f6f5c769c138088266ac21760ab33f76ca" } ] }, { "reference": "cradle-of-sins", "name": "Cradle of Sins", "symbol": "COS", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x4d9f39f7cb7c7444335077223ceef33dbb58096f" }, { "platform": "binance-smart-chain", "contract": "0x4d9f39f7cb7c7444335077223ceef33dbb58096f" } ] }, { "reference": "crafting-finance", "name": "Crafting Finance", "symbol": "CRF", "blockchains": [ { "platform": "ethereum", "contract": "0x508df5aa4746be37b5b6a69684dfd8bdc322219d" } ] }, { "reference": "craft-network", "name": "Craft network", "symbol": "CFT", "blockchains": [ { "platform": "icon", "contract": "cx2e6d0fc0eca04965d06038c8406093337f085fcf" } ] }, { "reference": "cramer-coin", "name": "Cramer Coin", "symbol": "CRAMER", "blockchains": [ { "platform": "ethereum", "contract": "0x64df3aab3b21cc275bb76c4a581cf8b726478ee0" }, { "platform": "ethereum", "contract": "0x64df3aab3b21cc275bb76c4a581cf8b726478ee0" } ] }, { "reference": "crane-miners", "name": "TheCraneMiners", "symbol": "CRANE", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x8c85a0e86f37ca231463ead62a40350d7bf7cef0" }, { "platform": "binance-smart-chain", "contract": "0x8c85a0e86f37ca231463ead62a40350d7bf7cef0" } ] }, { "reference": "cranx-chain", "name": "GranX Chain", "symbol": "GRANX", "blockchains": [ { "platform": "ethereum", "contract": "0xbd668ec47e10d3bf23b1d68139e545162a0dfcfa" } ] }, { "reference": "cratos", "name": "Cratos", "symbol": "CRTS", "blockchains": [ { "platform": "ethereum", "contract": "0x678e840c640f619e17848045d23072844224dd37" }, { "platform": "binance-smart-chain", "contract": "0x678e840c640f619e17848045d23072844224dd37" } ] }, { "reference": "crave", "name": "Crave", "symbol": "CRAVE", "blockchains": [] }, { "reference": "crazy-bunny", "name": "Crazy Bunny", "symbol": "CRAZYBUNNY", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x48ed9372169ef0bf2b901bbe45e52b6a6b8f1ecc" } ] }, { "reference": "crazy-bunny-equity-token", "name": "Crazy Bunny Equity Token", "symbol": "CBUNNY", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xaec23008b1098e39c0f8de90bf7431d185efe8b3" } ] }, { "reference": "crazy-internet-coin", "name": "Crazy Internet Coin", "symbol": "CIC", "blockchains": [ { "platform": "ethereum", "contract": "0xad640689e6950b7453729a4686edb3fdfd754616" } ] }, { "reference": "crazyminer", "name": "CrazyMiner", "symbol": "PWR", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xd52efe1039d706722b3d696e74ad4095dc3d3860" } ] }, { "reference": "crazy-rich-coin", "name": "Crazy Rich Coin", "symbol": "CRC", "blockchains": [ { "platform": "ethereum", "contract": "0xc23fa49b581fff9a3ea7e49d0504b06d07c6ff2a" } ] }, { "reference": "crazysharo", "name": "CrazySharo", "symbol": "SHARO", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x7f3daf301c629bfa243cbba6654370d929379657" } ] }, { "reference": "crazy-tiger", "name": "Crazy Tiger", "symbol": "CRAZYTIGER", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xedd52d44de950ccc3b2e6abdf0da8e99bb0ec480" } ] }, { "reference": "crazytime", "name": "CrazyTime", "symbol": "CRAZYTIME", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x94241428e0e36df628e0c2485bc0e158a5da3362" } ] }, { "reference": "crazy-treasure-token", "name": "Crazy Treasure Token", "symbol": "CTT", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xf56783b3a4fa5f09efca962bd4bab1f5fadd9ab9" } ] }, { "reference": "crb-coin", "name": "CRB Coin", "symbol": "CRB", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x518afa06aeca8dd0946b89a565e51f5a91d81176" }, { "platform": "ethereum", "contract": "0x2fd8bc03d9e827f77fac20b5130ee98b7f80149d" } ] }, { "reference": "crd-network", "name": "CRD Network", "symbol": "CRD", "blockchains": [ { "platform": "ethereum", "contract": "0xcaaa93712bdac37f736c323c93d4d5fdefcc31cc" } ] }, { "reference": "crdt", "name": "CRDT", "symbol": "CRDT", "blockchains": [ { "platform": "ethereum", "contract": "0xdaab5e695bb0e8ce8384ee56ba38fa8290618e52" } ] }, { "reference": "cre8r-dao", "name": "CRE8R DAO", "symbol": "CRE8R", "blockchains": [ { "platform": "ethereum", "contract": "0xaa61d5dec73971cd4a026ef2820bb87b4a4ed8d6" }, { "platform": "fantom", "contract": "0x2ad402655243203fcfa7dcb62f8a08cc2ba88ae0" } ] }, { "reference": "cream", "name": "Creamcoin", "symbol": "CRM", "blockchains": [] }, { "reference": "cream-2", "name": "Cream", "symbol": "CREAM", "blockchains": [ { "platform": "ethereum", "contract": "0x2ba592f78db6436527729929aaf6c908497cb200" }, { "platform": "sora", "contract": "0x00521ad5caeadc2e3e04be4d4ebb0b7c8c9b71ba657c2362a3953490ebc81410" }, { "platform": "arbitrum-one", "contract": "0xf4d48ce3ee1ac3651998971541badbb9a14d7234" }, { "platform": "fantom", "contract": "0x657a1861c15a3ded9af0b6799a195a249ebdcbc6" }, { "platform": "energi", "contract": "0x1cca61099dcebe517f8cac58f27218e7aff2d3bf" }, { "platform": "solana", "contract": "9iwfhhe7bjkno4eb1wx3p4uyjjen9roglt4bvmdzzoin" }, { "platform": "solana", "contract": "5fu5uugbjpuvdbveb3a1jtnirl8rxtiyesmwvkjtunqv" }, { "platform": "near-protocol", "contract": "2ba592f78db6436527729929aaf6c908497cb200.factory.bridge.near" } ] }, { "reference": "creama", "name": "Creama", "symbol": "CREAMA", "blockchains": [ { "platform": "avalanche", "contract": "0x3947146f331b9ef6448064c6311cdd24d9467a1a" } ] }, { "reference": "cream-eth2", "name": "Cream ETH 2", "symbol": "CRETH2", "blockchains": [ { "platform": "ethereum", "contract": "0xcbc1065255cbc3ab41a6868c22d1f1c573ab89fd" }, { "platform": "ethereum", "contract": "0x49d72e3973900a195a155a46441f0c08179fdb64" } ] }, { "reference": "creamlands", "name": "Creamlands", "symbol": "CREAM", "blockchains": [ { "platform": "hedera-hashgraph", "contract": "0.0.926385" } ] }, { "reference": "creampye", "name": "Creampye [OLD]", "symbol": "PYE", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xaad87f47cdea777faf87e7602e91e3a6afbe4d57" } ] }, { "reference": "cream-shares", "name": "IceCream Shares", "symbol": "CSHARE", "blockchains": [ { "platform": "avalanche", "contract": "0x155f794b56353533e0afbf76e1b1fc57dfad5bd7" }, { "platform": "avalanche", "contract": "0x155f794b56353533e0afbf76e1b1fc57dfad5bd7" } ] }, { "reference": "cream-wormhole", "name": "Cream (Wormhole)", "symbol": "CREAM", "blockchains": [ { "platform": "solana", "contract": "hihxl2im6l6p1oqoseiixdj3phpynxvskh9a2ddqlvdh" } ] }, { "reference": "creamy", "name": "Creamy", "symbol": "CREAMY", "blockchains": [ { "platform": "solana", "contract": "creampddimxxj2ztcwp5wmetba4nyakcrtbeqtsktqhe" } ] }, { "reference": "create", "name": "Create", "symbol": "CT", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xa85c461c66038ffc8433e2a961339b7f36656e16" }, { "platform": "binance-smart-chain", "contract": "0xa85c461c66038ffc8433e2a961339b7f36656e16" } ] }, { "reference": "creaticles", "name": "Creaticles", "symbol": "CRE8", "blockchains": [ { "platform": "ethereum", "contract": "0xc36b4311b21fc0c2ead46f1ea6ce97c9c4d98d3d" } ] }, { "reference": "creativecoin", "name": "CREA", "symbol": "CREA", "blockchains": [] }, { "reference": "creator-platform", "name": "Creator Platform", "symbol": "CTR", "blockchains": [ { "platform": "ethereum", "contract": "0x923b83c26b3809d960ff80332ed00aa46d7ed375" }, { "platform": "binance-smart-chain", "contract": "0xd6cce248263ea1e2b8cb765178c944fc16ed0727" } ] }, { "reference": "creator-protocol", "name": "Creator Protocol", "symbol": "CRE", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xc2c14affaddee38d7375c400d144251a87d2c34a" } ] }, { "reference": "creature_hunters", "name": "Creature Hunters", "symbol": "CHTS", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x1cdb9b4465f4e65b93d0ad802122c7c9279975c9" } ] }, { "reference": "creda", "name": "CreDA", "symbol": "CREDA", "blockchains": [ { "platform": "arbitrum-one", "contract": "0xc136e6b376a9946b156db1ed3a34b08afdaed76d" } ] }, { "reference": "cred-coin-pay", "name": "CRED COIN PAY", "symbol": "CRED", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xfc76ba9157ee5d079de8c1e969ee54096aaa6c9c" } ] }, { "reference": "credefi", "name": "Credefi", "symbol": "CREDI", "blockchains": [ { "platform": "ethereum", "contract": "0xae6e307c3fe9e922e5674dbd7f830ed49c014c6b" }, { "platform": "binance-smart-chain", "contract": "0x2235e79086dd23135119366da45851c741874e5b" } ] }, { "reference": "credefi-wormhole", "name": "Credefi (Wormhole)", "symbol": "CREDI", "blockchains": [ { "platform": "terra", "contract": "terra18xyl0ees6ueyhkhn0mjdtrm82e393ult2dazl3" } ] }, { "reference": "credi--1", "name": "CREDI", "symbol": "CREDI", "blockchains": [ { "platform": "ethereum", "contract": "0xae6e307c3fe9e922e5674dbd7f830ed49c014c6b" }, { "platform": "ethereum", "contract": "0xae6e307c3fe9e922e5674dbd7f830ed49c014c6b" } ] }, { "reference": "credit", "name": "TerraCredit", "symbol": "CREDIT", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x9d440a8dc5ae7dd4f6b406b78340856838c3e5da" }, { "platform": "binance-smart-chain", "contract": "0xc9308bcf5fa46d728422753d2d5afbc5cdb66b03" } ] }, { "reference": "credit-2", "name": "PROXI DeFi", "symbol": "CREDIT", "blockchains": [ { "platform": "ethereum", "contract": "0xc4cb5793bd58bad06bf51fb37717b86b02cbe8a4" } ] }, { "reference": "creditcoin-2", "name": "Creditcoin", "symbol": "CTC", "blockchains": [ { "platform": "ethereum", "contract": "0xa3ee21c306a700e682abcdfe9baa6a08f3820419" } ] }, { "reference": "credit-printer", "name": "Credit Printer", "symbol": "CREDITP", "blockchains": [ { "platform": "fantom", "contract": "0x5e5aabc95380b38c014fdc5e602c5183177fcca4" } ] }, { "reference": "credits", "name": "CREDITS", "symbol": "CS", "blockchains": [] }, { "reference": "credit-suisse-inu", "name": "Credit Suisse Inu", "symbol": "CSI", "blockchains": [ { "platform": "ethereum", "contract": "0x74bff2018687b8a1ff7132e13cd4fdc763725bcf" }, { "platform": "ethereum", "contract": "0x74bff2018687b8a1ff7132e13cd4fdc763725bcf" } ] }, { "reference": "creditum", "name": "Creditum", "symbol": "CREDIT", "blockchains": [ { "platform": "fantom", "contract": "0x77128dfdd0ac859b33f44050c6fa272f34872b5e" } ] }, { "reference": "credmark", "name": "Credmark", "symbol": "CMK", "blockchains": [ { "platform": "ethereum", "contract": "0x68cfb82eacb9f198d508b514d898a403c449533e" } ] }, { "reference": "creds", "name": "Creds", "symbol": "CREDS", "blockchains": [ { "platform": "ethereum", "contract": "0xc13f4f0f865bac08f62654b57e38669ebc4747a3" } ] }, { "reference": "crema-finance", "name": "Crema Finance", "symbol": "CRM", "blockchains": [] }, { "reference": "cremation-coin", "name": "Cremation Coin", "symbol": "CREMAT", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0xb8501a9a9aaae239a2490f44e00b284baa0b131a" }, { "platform": "ethereum", "contract": "0x8b9f7e9586633ca4abffb1f746da8daed7849cb2" } ] }, { "reference": "creo-engine", "name": "Creo Engine", "symbol": "CREO", "blockchains": [ { "platform": "binance-smart-chain", "contract": "0x9521728bf66a867bc65a93ece4a543d817871eb7" } ] }, { "reference": "crescent-network", "name": "Crescent Network", "symbol": "CRE", "blockchains": [ { "platform": "cosmos", "contract": "ucre" } ] }, { "reference": "crescentswap-moonlight", "name": "Crescentswap Moonlight", "symbol": "MNLT", "blockchains": [ { "platform": "arbitrum-one", "contract": "0x0a1694716de67c98f61942b2cab7df7fe659c87a" } ] }, { "reference": "crespo", "name": "Crespo", "symbol": "CSO", "blockchains": [ { "platform": "ethereum", "contract": "0x5ecb025e51415dba9fd272c551076357cf4069f5" } ] }, { "reference": "creta-world", "name": "Creta World", "symbol": "CRETA", "blockchains": [ { "platform": "polygon-pos", "contract": "0x202655af326de310491cb54f120e02ee0da92b55" } ] }, { "reference": "creth2--1", "name": "Cream ETH Token", "symbol": "CRETH2", "blockchains": [ { "platform": "ethereum", "contract": "0x49d72e3973900a195a155a46441f0c08179fdb64" }, { "platform": "ethereum", "contract": "0x49d72e3973900a195a155a46441f0c08179fdb64" } ] }, { "reference": "crevacoin", "name": "Crevacoin", "symbol": "CREVA", "blockchains": [] }, { "reference": "crex-token", "name": "Crex Token", "symbol": "CREX", "blockchains": [] } ] }, "meta": { "current_page": 42, "total_entries": 20048, "total_pages": 201 } }

Code:

200

Supported Exchanges and Wallets 1

The sources resource in the Compliance API provides information about retrieving the list of supported exchanges and wallet providers. By making a GET request to the /compliance/api/v1/sources endpoint, you can retrieve the details of available sources. The request requires authentication using a bearer token.

Please note that the response example for this endpoint will contain the API version and a data object containing an array of sources. Each currency object includes a reference, name, type and other useful attributes.

Use this information to integrate and work with the supported sources of the Compliance API.

GET sources | GET {{base_url}}/compliance/api/v1/sources

Description

GET /sources

Returns a paginated list of supported exchanges and wallets by making a GET request to the path /compliance/api/v1/sources on the base URL.

This endpoint requires authentication via a bearer token, provided in the Authorisation header of the request.

*Results paginated with 100 elements per page

Request

QUERY PARAMETERS

page number Specific page requested for the paginated results

RESPONSE `200`

RESPONSE DATA

api_version string Version of the targeted API
data string Wrapper for response data (See response example)

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Query

Key	Value	Description
page	1

Example Request

URL: {{base_url}}/compliance/api/v1/sources?page=1

Headers

Key	Value	Description
Authorization	Bearer {{jwt_token}}
Content-Type	application/json

Query

Key	Value	Description
page	1

Example Response

Body

{ "api_version": "1.0", "data": { "sources": [ { "reference": "coinbase", "name": "Coinbase", "type": "exchange", "api": true, "csv": false, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "bittrex", "name": "Bittrex", "type": "exchange", "api": true, "csv": true, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "gemini", "name": "Gemini", "type": "exchange", "api": true, "csv": false, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "bitstamp", "name": "Bitstamp", "type": "exchange", "api": true, "csv": false, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "btc-wallet", "name": "BTC Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "ltc-wallet", "name": "LTC Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "keep-key", "name": "Keep Key", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "bitlox-digital", "name": "Bitlox Digital", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "mycelium", "name": "Mycelium", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "bibox", "name": "Bibox", "type": "exchange", "api": true, "csv": true, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "electrum", "name": "Electrum", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "brd", "name": "BRD", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "coinomi", "name": "Coinomi", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "binance-dex", "name": "Binance DEX", "type": "exchange", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "coinspot", "name": "Coinspot", "type": "exchange", "api": true, "csv": false, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "binance-us", "name": "Binance US", "type": "exchange", "api": true, "csv": false, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "zec-wallet", "name": "ZEC Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "dcr-wallet", "name": "DCR Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "compound", "name": "Compound", "type": "exchange", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "vtc-wallet", "name": "VTC Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "zil-wallet", "name": "ZIL Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "ZIL" }, { "reference": "aion-wallet", "name": "AION Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "aave", "name": "Aave", "type": "exchange", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "ledger-hw", "name": "Ledger HW", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "polygon", "name": "Polygon", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "MATIC" }, { "reference": "pancake-swap", "name": "PancakeSwap", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "BSC" }, { "reference": "atomic", "name": "Atomic", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "bit-keep", "name": "BitKeep", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "math-wallet", "name": "MathWallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "torus", "name": "Torus", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "SOL" }, { "reference": "safepal", "name": "Safepal", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "SOL" }, { "reference": "token-pocket", "name": "Token Pocket", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "SOL" }, { "reference": "glow", "name": "Glow", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "SOL" }, { "reference": "optimism", "name": "Optimism", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "OP" }, { "reference": "hitbtc", "name": "Hitbtc", "type": "exchange", "api": true, "csv": false, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "huobi", "name": "Huobi", "type": "exchange", "api": true, "csv": false, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "exodus", "name": "Exodus", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "trust-wallet", "name": "Trust Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "zerion", "name": "Zerion", "type": "exchange", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "synthetix", "name": "Synthetix", "type": "exchange", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "1inch-exchange", "name": "1inch.exchange", "type": "exchange", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "balancer", "name": "Balancer", "type": "exchange", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "zapper-fi", "name": "Zapper.fi", "type": "exchange", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "sushiswap", "name": "Sushiswap", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "coinbase-wallet", "name": "Coinbase Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "curve", "name": "Curve", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "ascendex", "name": "Ascendex", "type": "exchange", "api": true, "csv": true, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "paraswap", "name": "Paraswap", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "arbitrum", "name": "Arbitrum", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "ARB" }, { "reference": "eth-wallet", "name": "ETH Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "jaxx", "name": "Jaxx", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "ledger-nano", "name": "Ledger Nano", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "bitlox", "name": "Bitlox", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "copay", "name": "Copay", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "my-ether-wallet", "name": "MyEtherWallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "airbitz", "name": "Airbitz", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "ada-wallet", "name": "ADA Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "bancor-network", "name": "Bancor Network", "type": "exchange", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "binance-chain", "name": "Binance Chain", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "BSC" }, { "reference": "matic-wallet", "name": "MATIC Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "avalanche", "name": "Avalanche", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "AVAX" }, { "reference": "ftm-wallet", "name": "FTM Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "FTM" }, { "reference": "game-stop-wallet", "name": "GameStop Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "qredo", "name": "Qredo", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "coin98", "name": "Coin98", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "solana", "name": "Solana", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "SOL" }, { "reference": "ledger-blue", "name": "Ledger Blue", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "idex", "name": "Idex", "type": "exchange", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "liquid", "name": "Liquid", "type": "exchange", "api": true, "csv": false, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "mycrypto", "name": "Mycrypto", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "ETH" }, { "reference": "dgb-wallet", "name": "DGB Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "algo-wallet", "name": "ALGO Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "ALGO" }, { "reference": "phantom", "name": "Phantom", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "SOL" }, { "reference": "solflare", "name": "Solflare", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "SOL" }, { "reference": "sollet", "name": "Sollet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "SOL" }, { "reference": "slope", "name": "Slope", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "SOL" }, { "reference": "clover", "name": "Clover", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "SOL" }, { "reference": "bit-pay", "name": "BitPay", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "daedalus", "name": "Daedalus", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "gate", "name": "Gate", "type": "exchange", "api": true, "csv": true, "oauth": false, "address": false, "pass_phrase": false, "default_coin": null }, { "reference": "xtz-wallet", "name": "XTZ Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "ark-wallet", "name": "ARK Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "sys-wallet", "name": "SYS Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "coinbase-pro", "name": "Coinbase Pro", "type": "exchange", "api": true, "csv": true, "oauth": false, "address": false, "pass_phrase": true, "default_coin": null }, { "reference": "vet-wallet", "name": "VET Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "ont-wallet", "name": "ONT Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "rdd-wallet", "name": "RDD Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "atom-wallet", "name": "ATOM Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "coinswitch", "name": "Coinswitch", "type": "exchange", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "uniswap", "name": "Uniswap", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "waves-wallet", "name": "WAVES Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "unisat", "name": "Unisat", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "btc_od-wallet", "name": "BTC_OD Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "freewallet", "name": "Freewallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "infinito-wallet", "name": "Infinito Wallet", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": null }, { "reference": "metamask", "name": "Metamask", "type": "wallet", "api": false, "csv": false, "oauth": false, "address": true, "pass_phrase": false, "default_coin": "ETH" } ] }, "meta": { "current_page": 1, "total_entries": 96, "total_pages": 1 } }

Code:

200

Error Codes 1

The Compliance API includes specific error codes to indicate and describe various issues and errors that may occur during API interactions. To help you quickly identify and understand these error codes, we have provided a glossary below. This table contains commonly encountered error codes along with their corresponding meanings. Refer to this table for efficient troubleshooting when working with our Compliance API.

formdata

Glossary | ERROR CODE

Body

Key	Value	Description
ZENCS-AUTHGET-AA1		Forbidden
ZENCS-AUTHGET-AA2		Unauthorised
ZENCS-AUTHGET-AA3		Invalid Api key
ZENCS-AUTHGET-AA4		Invalid OAuth token
ZENCS-RSRCGET-AA1		Resource not found
ZENCS-CMPGET-AA1		Could not retrieve companies
ZENCS-CMPGET-AA2		Could not retrieve company
ZENCS-CMPGET-AA3		Could not find company
ZENCS-CMPGET-AA4		Company has no users
ZENCS-CMPPST-AA1		Could not add company
ZENCS-CMPPST-AA2		Duplicated External ID for company
ZENCS-CMPUPD-AA1		Could not update company details
ZENCS-CMPDEL-AA1		Could not delete company
ZENCS-PARAMGET-AA1		Provided currency not found
ZENCS-PARAMGET-AA2		Wrong date format provided, please provide a valid UTC date in ISO-8601 format
ZENCS-PARAMGET-AA3		Provided source not found
ZENCS-USRGET-AA1		Could not retrieve users
ZENCS-USRGET-AA2		Could not find user
ZENCS-USRPST-AA1		Could not add user
ZENCS-USRPST-AA2		Duplicated email for user
ZENCS-USRUPD-AA1		Could not update user details

Webhooks and notifications 1

After a user imports a new account, ZenLedger will process it and send a webhook notification to the

defined endpoint one the new import is completed.

This webhook will expect a HTTP 200 response from the Client side, if a different response or none is given, the webhook service will continue to send notification until a valid response is received or the retry cycle is over.

The retry cycle will retry after 1 minute, 3 minutes, 10 minutes, 30 minutes, 1 hour and a final retry after 24 hours.

Webhook endpoint setup

To set the endpoint in order to receive webhook notifications one of the following should occur:

The attribute import_notification_url should be set when creating a new company
Update the company details by passing this attribute.

Webhook notification format

{
  "notification_type": "IMPORT_STATUS_UPDATE",
  "company_reference": "company_reference",
  "user_id": "7be47a6d-a1b7-43bf-a1b7f5b6-2973cd5e0859",
  "source_id": "2973cd5e0859-a1b7-43bf-7be47a6d-97359cd5e082",
  "source_reference": "coinbase",    
  "import_status": "complete",
}