The project is in a healthy, maintained state
View our documentation at https://github.com/Cybrid-app/cybrid-api-id-ruby/
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

~> 3.6, >= 3.6.0

Runtime

~> 1.0, >= 1.0.1
 Project Readme

cybrid_api_id_ruby

CybridApiId - the Ruby gem for the Cybrid Identity API

Cybrid API documentation

Welcome to Cybrid, an all-in-one crypto platform that enables you to easily build and launch white-label crypto products or services.

In these documents, you'll find details on how our REST API operates and generally how our platform functions.

If you're looking for our UI SDK Widgets for Web or Mobile (iOS/Android), generated API clients, or demo applications, head over to our Github repo.

💡 We recommend bookmarking the Cybrid LinkTree which contains many helpful links to platform resources.

Getting Started

This is Cybrid's public interactive API documentation, which allows you to fully test our APIs. If you'd like to use a different tool to exercise our APIs, you can download the Open API 3.0 yaml for import.

If you're new to our APIs and the Cybrid Platform, follow the below guides to get set up and familiar with the platform:

  1. Getting Started in the Cybrid Sandbox
  2. Getting Ready for Trading
  3. Running the Web Demo App (or, alternatively, Testing with Hosted Web Demo App)

In Getting Started in the Cybrid Sandbox, we walk you through how to use the Cybrid Sandbox to create a test bank, generate API keys, and set banks fees. In Getting Ready for Trading, we walk through creating customers, customer identities, accounts, as well as executing quotes and trades.

If you've already run through the first two guides, you can follow the Running the Web Demo App guide to test our web SDK with your sandbox bank and customer.

Working with the Cybrid Platform

There are three primary ways you can interact with the Cybrid platform:

  1. Directly via our RESTful API (this documentation)
  2. Using our API clients available in a variety of languages (Angular, Java, Kotlin, Python, Ruby, Swift or Typescript)
  3. Integrating a platform specific SDK (Web, Android, iOS)

Our complete set of APIs allows you to manage resources across three distinct areas: your Organization, your Banks and your Identities. For most of your testing and interaction you'll be using the Bank API, which is where the majority of APIs reside.

The complete set of APIs can be found on the following pages:

API Description
Organization API APIs to manage organizations
Bank API APIs to manage banks (and all downstream customer activity)
Identities API APIs to manage organization and bank identities

For questions please contact Support at any time for assistance, or contact the Product Team for product suggestions.

Authenticating with the API

The Cybrid Platform uses OAuth 2.0 Bearer Tokens to authenticate requests to the platform. Credentials to create Organization and Bank tokens can be generated via the Cybrid Sandbox. Access tokens can be generated for a Customer as well via the Cybrid IdP as well.

An Organization access token applies broadly to the whole Organization and all of its Banks, whereas, a Bank access token is specific to an individual Bank. Customer tokens, similarly, are scoped to a specific customer in a bank.

Both Organization and Bank tokens can be created using the OAuth Client Credential Grant flow. Each Organization and Bank has its own unique Client ID and Secret that allows for machine-to-machine authentication.

A Bank can then generate Customer access tokens via API using our Identities API.

<font color="orange">⚠️ Never share your Client ID or Secret publicly or in your source code repository.

Your Client ID and Secret can be exchanged for a time-limited Bearer Token by interacting with the Cybrid Identity Provider or through interacting with the Authorize button in this document.

The following curl command can be used to quickly generate a Bearer Token for use in testing the API or demo applications.

curl -X POST https://id.demo.cybrid.app/oauth/token -d '{
    \"grant_type\": \"client_credentials\",
    \"client_id\": \"<Your Client ID>\",
    \"client_secret\": \"<Your Secret>\",
    \"scope\": \"banks:read banks:write accounts:read accounts:execute customers:read customers:write customers:execute prices:read quotes:execute trades:execute trades:read\"
  }' -H \"Content-Type: application/json\"

<font color="orange">⚠️ Note: The above curl will create a bearer token with full scope access. Delete scopes if you'd like to restrict access.

Authentication Scopes

The Cybrid platform supports the use of scopes to control the level of access a token is limited to. Scopes do not grant access to resources; instead, they provide limits, in support of the least privilege principal.

The following scopes are available on the platform and can be requested when generating either an Organization, Bank or Customer token. Generally speaking, the Read scope is required to read and list resources, the Write scope is required to update a resource and the Execute scope is required to create a resource.

Resource Read scope (Token Type) Write scope (Token Type) Execute scope (Token Type)
Organizations organizations:read (Organization) organizations:write (Organization)
Banks banks:read (Organization, Bank) banks:write (Organization, Bank) banks:execute (Organization)
Customers customers:read (Organization, Bank, Customer) customers:write (Bank, Customer) customers:execute (Bank)
Accounts accounts:read (Organization, Bank, Customer) accounts:execute (Bank, Customer)
Prices prices:read (Bank, Customer)
Quotes quotes:read (Organization, Bank, Customer) quotes:execute (Bank, Customer)
Trades trades:read (Organization, Bank, Customer) trades:execute (Bank, Customer)
Rewards rewards:read (Bank, Customer) rewards:execute (Bank)
External bank accounts external_bank_accounts:read (Organization, Bank, Customer) external_bank_accounts:execute (Bank, Customer)
Workflows workflows:read (Organization, Bank, Customer) workflows:execute (Bank, Customer)
Transfers workflows:read (Organization, Bank, Customer) workflows:execute (Bank, Customer)

Available Endpoints

The available APIs for the Identity, Organization and Bank API services are listed below:

API Service Model API Endpoint Path Description
Identity Bank /api/bank_applications Create and list banks
Identity Organization /api/organization_applications Create and list organizations
Identity CustomerToken /api/customer_tokens Create customer JWT access tokens
Organization Organization /api/organizations APIs to retrieve and update organization name
Bank Asset /api/assets Get a list of assets supported by the platform (ex: BTC, ETH)
Bank VerificationKey /api/bank_verification_keys Create, list and retrive verification keys, used for signing identities
Bank Banks /api/banks Create, update and list banks, the parent to customers, accounts, etc
Bank FeeConfiguration /api/fee_configurations Create and list bank fees (spread or fixed)
Bank Customers /api/customers Create and list customers
Bank IdentityRecord /api/identity_records Create and list identity records, which are attached to customers for KYC
Bank Accounts /api/accounts Create and list accounts, which hold a specific asset for a customers
Bank Symbols /api/symbols Get a list of symbols supported for trade (ex: BTC-USD)
Bank Prices /api/prices Get the current prices for assets on the platform
Bank Quotes /api/quotes Create and list quotes, which are required to execute trades
Bank Trades /api/trades Create and list trades, which buy or sell cryptocurrency
Bank Rewards /api/rewards Create a new reward (automates quote/trade for simplicity)
Bank ExternalBankAccounts /api/external_bank_accounts Create, get and list external bank accounts, which connect customer bank accounts to the platform
Bank Workflows /api/workflows Create, get and list workflows
Bank Transfers /api/transfers Create, get and list transfers (e.g., funding, book)

Understanding Object Models & Endpoints

Organizations

An Organization is meant to represent the organization partnering with Cybrid to use our platform.

An Organization does not directly interact with customers. Instead, an Organization has one or more banks, which encompass the financial service offerings of the platform.

Banks

A Bank is owned by an Organization and can be thought of as an environment or container for customers and product offerings. Banks are created in either Sandbox or Production mode, where Sandbox is the environment that you would test, prototype and build in prior to moving to Production.

An Organization can have multiple banks, in either Sandbox or Production environments. A Sandbox Bank will be backed by stubbed data and process flows. For instance, funding source transfer processes as well as trades will be simulated rather than performed, however asset prices are representative of real-world values. You have an unlimited amount of simulated fiat currency for testing purposes.

Customers

Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers.

Customers must be verified (i.e., KYC'd) in our system before they can play any part on the platform, which means they must have an associated and valid Identity Record. See the Identity Records section for more details on how a customer can be verified.

Customers must also have an Account to be able to transact, in the desired asset class. See the Accounts APIs for more details on setting up accounts for the customer.

This SDK is automatically generated by the OpenAPI Generator project:

  • API version: v0.56.5
  • Package version: 0.56.5
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen

Installation

Build a gem

To build the Ruby code into a gem:

gem build cybrid_api_id_ruby.gemspec

Then either install the gem locally:

gem install ./cybrid_api_id_ruby-0.56.5.gem

(for development, run gem install --dev ./cybrid_api_id_ruby-0.56.5.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'cybrid_api_id_ruby', '~> 0.56.5'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'cybrid_api_id_ruby', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'cybrid_api_id_ruby'

# Setup authorization
CybridApiId.configure do |config|
  # Configure Bearer authorization (JWT): BearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'

  # Configure OAuth2 access token for authorization: oauth2
  config.access_token = 'YOUR ACCESS TOKEN'
end

api_instance = CybridApiId::BankApplicationsIdpApi.new
post_bank_application_idp_model = CybridApiId::PostBankApplicationIdpModel.new({name: 'name_example'}) # PostBankApplicationIdpModel | 

begin
  #Create bank application
  result = api_instance.create_bank_application(post_bank_application_idp_model)
  p result
rescue CybridApiId::ApiError => e
  puts "Exception when calling BankApplicationsIdpApi->create_bank_application: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://id.demo.cybrid.app

Class Method HTTP request Description
CybridApiId::BankApplicationsIdpApi create_bank_application POST /api/bank_applications Create bank application
CybridApiId::BankApplicationsIdpApi list_bank_applications GET /api/bank_applications List bank applications
CybridApiId::CustomerTokensIdpApi create_customer_token POST /api/customer_tokens Create customer access token
CybridApiId::OrganizationApplicationsIdpApi create_organization_application POST /api/organization_applications Create organization application
CybridApiId::OrganizationApplicationsIdpApi list_organization_applications GET /api/organization_applications List organization applications

Documentation for Models

Documentation for Authorization

BearerAuth

  • Type: Bearer authentication (JWT)

oauth2

  • Type: OAuth
  • Flow: application
  • Authorization URL:
  • Scopes:
    • banks:write: banks write
    • banks:read: banks read
    • organizations:write: organizations write
    • organizations:read: organizations read