=begin #Cybrid Bank API ## Welcome Welcome to the Cybrid platform; enabling turnkey crypto banking services! In these documents, you will find information on the operations provided by our platform, as well as details on how our REST API operates more generally. Our complete set of APIs allows you to manage all your resources: your Organization, your banks and your identities. The complete set of APIs can be found on the following pages: | API | Description | |----------------------------------------------------------------|------------------------------| | [Organization API](https://organization.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage banks | | [Identities API](https://id.demo.cybrid.app/api/schema/swagger-ui) | APIs to manage identities | When you're ready, [request access](https://www.cybrid.xyz/access) to your Dashboard to view and administer your Organization. Once you've logged in, you can begin creating Banks, either for sandbox or production usage, and start enabling your customers to leverage DeFi and web3 with confidence. If you have any questions, please contact [Support](mailto:support@cybrid.app) at any time so that we can help. ## Authentication 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 your Dashboard ([request access](https://www.cybrid.xyz/access)). An Organization Token applies broadly to the whole Organization and all of its Banks, whereas, a Bank Token is specific to an individual 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. **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: ``` curl -X POST https://id.demo.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"\", \"client_secret\": \"\", \"scope\": \"\" }' -H \"Content-Type: application/json\" ``` ## 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 or a Bank 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 | Write scope | Execute scope | Token Type | |---------------|--------------------|----------------------|-------------------|--------------------| | Organizations | organizations:read | organizations:write | | Organization/ Bank | | Banks | banks:read | banks:write | banks:execute | Organization/ Bank | | Customers | customers:read | customers:write | customers:execute | Bank | | Assets | prices:read | | | Bank | | Accounts | accounts:read | | accounts:execute | Bank | | Prices | prices:read | | | Bank | | Symbols | prices:read | | | Bank | | Quotes | quotes:read | | quotes:execute | Bank | | Trades | trades:read | | trades:execute | Bank | ## Organizations An Organization is meant to model 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. An example of a Bank would be your customer facing banking website, or an internal staging environment for testing and integration. An Organization can have multiple banks, in sandbox or production environments. A sandbox Bank will be backed by stubbed data and process flows. For instance, identity record and funding source processes will be simulated rather than performed. ## Customers Customers represent your banking users on the platform. At present, we offer support for Individuals as Customers. Customers must be verified in our system before they can play any part on the platform. 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. See the Accounts APIs for more details on setting up accounts for the customer. The version of the OpenAPI document: v0.25.1 Contact: support@cybrid.app Generated by: https://openapi-generator.tech OpenAPI Generator version: 5.4.0 =end require 'cgi' module CybridApiBank class VerificationKeysBankApi attr_accessor :api_client def initialize(api_client = ApiClient.default) @api_client = api_client end # Create VerificationKey # Creates a verification key. Example code (python) for generating a Verification Key ```python import base64 from cryptography.hazmat.primitives import hashes from cryptography.hazmat.primitives import serialization from cryptography.hazmat.primitives.asymmetric import padding from cryptography.hazmat.primitives.asymmetric import rsa nonce = \"wen moon\" private_key = rsa.generate_private_key(public_exponent=65537, key_size=2048) signature = base64.b64encode(private_key.sign( data=nonce.encode('ascii'), padding=padding.PKCS1v15(), algorithm=hashes.SHA512())).decode('ascii') public_key = base64.b64encode(private_key.public_key().public_bytes( encoding=serialization.Encoding.DER, format=serialization.PublicFormat.SubjectPublicKeyInfo)).decode('ascii') ### DISCLAIMER:- Since NO ENCRYPTION is used in the key storage/formatting. Please DO NOT use this code in production environment. private_pem = private_key.private_bytes(encoding=serialization.Encoding.PEM, format=serialization.PrivateFormat.TraditionalOpenSSL, encryption_algorithm=serialization.NoEncryption()) ## Store the private_key in a file verification_key.pem with open (\"verification_key.pem\", 'wb') as pem_out: pem_out.write(private_pem) pem_out.close() print(\"Public Key: \", public_key) print(\"Signature: \", signature) ```` ## State | State | Description | |-------|-------------| | storing | The Platform is storing the verification in our private key store | | pending | The Platform is verifying the verification key's signature | | verified | The Platform has verified the verification key's signature and the key can be used | | failed | The Platform was not able to verify the verification key's signature and the key cannot be used | Required scope: **banks:write** # @param post_verification_key_bank_model [PostVerificationKeyBankModel] # @param [Hash] opts the optional parameters # @return [VerificationKeyBankModel] def create_verification_key(post_verification_key_bank_model, opts = {}) data, _status_code, _headers = create_verification_key_with_http_info(post_verification_key_bank_model, opts) data end # Create VerificationKey # Creates a verification key. Example code (python) for generating a Verification Key ```python import base64 from cryptography.hazmat.primitives import hashes from cryptography.hazmat.primitives import serialization from cryptography.hazmat.primitives.asymmetric import padding from cryptography.hazmat.primitives.asymmetric import rsa nonce = \"wen moon\" private_key = rsa.generate_private_key(public_exponent=65537, key_size=2048) signature = base64.b64encode(private_key.sign( data=nonce.encode('ascii'), padding=padding.PKCS1v15(), algorithm=hashes.SHA512())).decode('ascii') public_key = base64.b64encode(private_key.public_key().public_bytes( encoding=serialization.Encoding.DER, format=serialization.PublicFormat.SubjectPublicKeyInfo)).decode('ascii') ### DISCLAIMER:- Since NO ENCRYPTION is used in the key storage/formatting. Please DO NOT use this code in production environment. private_pem = private_key.private_bytes(encoding=serialization.Encoding.PEM, format=serialization.PrivateFormat.TraditionalOpenSSL, encryption_algorithm=serialization.NoEncryption()) ## Store the private_key in a file verification_key.pem with open (\"verification_key.pem\", 'wb') as pem_out: pem_out.write(private_pem) pem_out.close() print(\"Public Key: \", public_key) print(\"Signature: \", signature) ```` ## State | State | Description | |-------|-------------| | storing | The Platform is storing the verification in our private key store | | pending | The Platform is verifying the verification key's signature | | verified | The Platform has verified the verification key's signature and the key can be used | | failed | The Platform was not able to verify the verification key's signature and the key cannot be used | Required scope: **banks:write** # @param post_verification_key_bank_model [PostVerificationKeyBankModel] # @param [Hash] opts the optional parameters # @return [Array<(VerificationKeyBankModel, Integer, Hash)>] VerificationKeyBankModel data, response status code and response headers def create_verification_key_with_http_info(post_verification_key_bank_model, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VerificationKeysBankApi.create_verification_key ...' end # verify the required parameter 'post_verification_key_bank_model' is set if @api_client.config.client_side_validation && post_verification_key_bank_model.nil? fail ArgumentError, "Missing the required parameter 'post_verification_key_bank_model' when calling VerificationKeysBankApi.create_verification_key" end # resource path local_var_path = '/api/bank_verification_keys' # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # HTTP header 'Content-Type' content_type = @api_client.select_header_content_type(['application/json']) if !content_type.nil? header_params['Content-Type'] = content_type end # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] || @api_client.object_to_http_body(post_verification_key_bank_model) # return_type return_type = opts[:debug_return_type] || 'VerificationKeyBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"VerificationKeysBankApi.create_verification_key", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: VerificationKeysBankApi#create_verification_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get VerificationKey # Retrieves a verification key. Required scope: **banks:read** # @param verification_key_guid [String] Identifier for the verification key. # @param [Hash] opts the optional parameters # @return [VerificationKeyBankModel] def get_verification_key(verification_key_guid, opts = {}) data, _status_code, _headers = get_verification_key_with_http_info(verification_key_guid, opts) data end # Get VerificationKey # Retrieves a verification key. Required scope: **banks:read** # @param verification_key_guid [String] Identifier for the verification key. # @param [Hash] opts the optional parameters # @return [Array<(VerificationKeyBankModel, Integer, Hash)>] VerificationKeyBankModel data, response status code and response headers def get_verification_key_with_http_info(verification_key_guid, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VerificationKeysBankApi.get_verification_key ...' end # verify the required parameter 'verification_key_guid' is set if @api_client.config.client_side_validation && verification_key_guid.nil? fail ArgumentError, "Missing the required parameter 'verification_key_guid' when calling VerificationKeysBankApi.get_verification_key" end # resource path local_var_path = '/api/bank_verification_keys/{verification_key_guid}'.sub('{' + 'verification_key_guid' + '}', CGI.escape(verification_key_guid.to_s)) # query parameters query_params = opts[:query_params] || {} # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'VerificationKeyBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"VerificationKeysBankApi.get_verification_key", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: VerificationKeysBankApi#get_verification_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end # Get Verification Keys list # Retrieves a listing of verification keys of a bank. Required scope: **banks:read** # @param [Hash] opts the optional parameters # @option opts [Integer] :page (default to 0) # @option opts [Integer] :per_page (default to 10) # @return [VerificationKeyListBankModel] def list_verification_keys(opts = {}) data, _status_code, _headers = list_verification_keys_with_http_info(opts) data end # Get Verification Keys list # Retrieves a listing of verification keys of a bank. Required scope: **banks:read** # @param [Hash] opts the optional parameters # @option opts [Integer] :page # @option opts [Integer] :per_page # @return [Array<(VerificationKeyListBankModel, Integer, Hash)>] VerificationKeyListBankModel data, response status code and response headers def list_verification_keys_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug 'Calling API: VerificationKeysBankApi.list_verification_keys ...' end if @api_client.config.client_side_validation && !opts[:'page'].nil? && opts[:'page'] < 0 fail ArgumentError, 'invalid value for "opts[:"page"]" when calling VerificationKeysBankApi.list_verification_keys, must be greater than or equal to 0.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] > 100 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling VerificationKeysBankApi.list_verification_keys, must be smaller than or equal to 100.' end if @api_client.config.client_side_validation && !opts[:'per_page'].nil? && opts[:'per_page'] < 1 fail ArgumentError, 'invalid value for "opts[:"per_page"]" when calling VerificationKeysBankApi.list_verification_keys, must be greater than or equal to 1.' end # resource path local_var_path = '/api/bank_verification_keys' # query parameters query_params = opts[:query_params] || {} query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil? query_params[:'per_page'] = opts[:'per_page'] if !opts[:'per_page'].nil? # header parameters header_params = opts[:header_params] || {} # HTTP header 'Accept' (if needed) header_params['Accept'] = @api_client.select_header_accept(['application/json']) # form parameters form_params = opts[:form_params] || {} # http body (model) post_body = opts[:debug_body] # return_type return_type = opts[:debug_return_type] || 'VerificationKeyListBankModel' # auth_names auth_names = opts[:debug_auth_names] || ['BearerAuth', 'oauth2'] new_options = opts.merge( :operation => :"VerificationKeysBankApi.list_verification_keys", :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => return_type ) data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options) if @api_client.config.debugging @api_client.config.logger.debug "API called: VerificationKeysBankApi#list_verification_keys\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end end end