cybrid_api_bank_ruby 0.129.390 → 0.129.391

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (442) hide show
  1. checksums.yaml +4 -4
  2. data/Gemfile.lock +2 -2
  3. data/README.md +7 -5
  4. data/cybrid_api_bank_ruby.gemspec +1 -1
  5. data/docs/LegalEntityNameBankModel.md +24 -0
  6. data/docs/PhysicalAddressBankModel.md +28 -0
  7. data/lib/cybrid_api_bank_ruby/api/accounts_bank_api.rb +1 -1
  8. data/lib/cybrid_api_bank_ruby/api/assets_bank_api.rb +1 -1
  9. data/lib/cybrid_api_bank_ruby/api/banks_bank_api.rb +1 -1
  10. data/lib/cybrid_api_bank_ruby/api/counterparties_bank_api.rb +1 -1
  11. data/lib/cybrid_api_bank_ruby/api/customers_bank_api.rb +1 -1
  12. data/lib/cybrid_api_bank_ruby/api/deposit_addresses_bank_api.rb +1 -1
  13. data/lib/cybrid_api_bank_ruby/api/deposit_bank_accounts_bank_api.rb +1 -1
  14. data/lib/cybrid_api_bank_ruby/api/executions_bank_api.rb +1 -1
  15. data/lib/cybrid_api_bank_ruby/api/external_bank_accounts_bank_api.rb +1 -1
  16. data/lib/cybrid_api_bank_ruby/api/external_wallets_bank_api.rb +1 -1
  17. data/lib/cybrid_api_bank_ruby/api/files_bank_api.rb +1 -1
  18. data/lib/cybrid_api_bank_ruby/api/identity_verifications_bank_api.rb +1 -1
  19. data/lib/cybrid_api_bank_ruby/api/invoices_bank_api.rb +1 -1
  20. data/lib/cybrid_api_bank_ruby/api/payment_instructions_bank_api.rb +1 -1
  21. data/lib/cybrid_api_bank_ruby/api/persona_sessions_bank_api.rb +1 -1
  22. data/lib/cybrid_api_bank_ruby/api/plans_bank_api.rb +1 -1
  23. data/lib/cybrid_api_bank_ruby/api/prices_bank_api.rb +1 -1
  24. data/lib/cybrid_api_bank_ruby/api/quotes_bank_api.rb +1 -1
  25. data/lib/cybrid_api_bank_ruby/api/sardine_sessions_bank_api.rb +1 -1
  26. data/lib/cybrid_api_bank_ruby/api/symbols_bank_api.rb +1 -1
  27. data/lib/cybrid_api_bank_ruby/api/trades_bank_api.rb +1 -1
  28. data/lib/cybrid_api_bank_ruby/api/transfers_bank_api.rb +1 -1
  29. data/lib/cybrid_api_bank_ruby/api/workflows_bank_api.rb +1 -1
  30. data/lib/cybrid_api_bank_ruby/api_client.rb +1 -1
  31. data/lib/cybrid_api_bank_ruby/api_error.rb +1 -1
  32. data/lib/cybrid_api_bank_ruby/configuration.rb +1 -1
  33. data/lib/cybrid_api_bank_ruby/models/account_association_bank_model.rb +1 -1
  34. data/lib/cybrid_api_bank_ruby/models/account_bank_model.rb +1 -1
  35. data/lib/cybrid_api_bank_ruby/models/account_list_bank_model.rb +1 -1
  36. data/lib/cybrid_api_bank_ruby/models/account_state_bank_model.rb +1 -1
  37. data/lib/cybrid_api_bank_ruby/models/account_type_bank_model.rb +1 -1
  38. data/lib/cybrid_api_bank_ruby/models/activity_limit_bank_model.rb +1 -1
  39. data/lib/cybrid_api_bank_ruby/models/activity_side_bank_model.rb +1 -1
  40. data/lib/cybrid_api_bank_ruby/models/activity_type_bank_model.rb +1 -1
  41. data/lib/cybrid_api_bank_ruby/models/asset_bank_model.rb +1 -1
  42. data/lib/cybrid_api_bank_ruby/models/asset_list_bank_model.rb +1 -1
  43. data/lib/cybrid_api_bank_ruby/models/asset_types_bank_model.rb +1 -1
  44. data/lib/cybrid_api_bank_ruby/models/bank_bank_model.rb +1 -1
  45. data/lib/cybrid_api_bank_ruby/models/bank_feature_bank_model.rb +1 -1
  46. data/lib/cybrid_api_bank_ruby/models/bank_list_bank_model.rb +1 -1
  47. data/lib/cybrid_api_bank_ruby/models/bank_supported_payout_symbols_inner_bank_model.rb +1 -1
  48. data/lib/cybrid_api_bank_ruby/models/bank_type_bank_model.rb +1 -1
  49. data/lib/cybrid_api_bank_ruby/models/compliance_check_bank_model.rb +1 -1
  50. data/lib/cybrid_api_bank_ruby/models/compliance_check_outcome_bank_model.rb +1 -1
  51. data/lib/cybrid_api_bank_ruby/models/compliance_check_type_bank_model.rb +1 -1
  52. data/lib/cybrid_api_bank_ruby/models/compliance_decision_bank_model.rb +1 -1
  53. data/lib/cybrid_api_bank_ruby/models/compliance_decision_state_bank_model.rb +1 -1
  54. data/lib/cybrid_api_bank_ruby/models/compliance_decision_type_bank_model.rb +1 -1
  55. data/lib/cybrid_api_bank_ruby/models/counterparty_address_bank_model.rb +1 -1
  56. data/lib/cybrid_api_bank_ruby/models/counterparty_aliases_inner_bank_model.rb +1 -1
  57. data/lib/cybrid_api_bank_ruby/models/counterparty_bank_model.rb +1 -1
  58. data/lib/cybrid_api_bank_ruby/models/counterparty_list_bank_model.rb +1 -1
  59. data/lib/cybrid_api_bank_ruby/models/counterparty_name_bank_model.rb +1 -1
  60. data/lib/cybrid_api_bank_ruby/models/counterparty_state_bank_model.rb +1 -1
  61. data/lib/cybrid_api_bank_ruby/models/counterparty_type_bank_model.rb +1 -1
  62. data/lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb +1 -1
  63. data/lib/cybrid_api_bank_ruby/models/customer_aliases_inner_bank_model.rb +1 -1
  64. data/lib/cybrid_api_bank_ruby/models/customer_bank_model.rb +1 -1
  65. data/lib/cybrid_api_bank_ruby/models/customer_list_bank_model.rb +1 -1
  66. data/lib/cybrid_api_bank_ruby/models/customer_name_bank_model.rb +1 -1
  67. data/lib/cybrid_api_bank_ruby/models/customer_state_bank_model.rb +1 -1
  68. data/lib/cybrid_api_bank_ruby/models/customer_type_bank_model.rb +1 -1
  69. data/lib/cybrid_api_bank_ruby/models/deposit_address_bank_model.rb +1 -1
  70. data/lib/cybrid_api_bank_ruby/models/deposit_address_format_bank_model.rb +1 -1
  71. data/lib/cybrid_api_bank_ruby/models/deposit_address_list_bank_model.rb +1 -1
  72. data/lib/cybrid_api_bank_ruby/models/deposit_address_state_bank_model.rb +1 -1
  73. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_account_details_inner_bank_model.rb +1 -1
  74. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_bank_model.rb +1 -1
  75. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_counterparty_address_bank_model.rb +1 -1
  76. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_list_bank_model.rb +1 -1
  77. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_details_inner_bank_model.rb +1 -1
  78. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_routing_number_type_bank_model.rb +1 -1
  79. data/lib/cybrid_api_bank_ruby/models/deposit_bank_account_state_bank_model.rb +1 -1
  80. data/lib/cybrid_api_bank_ruby/models/error_response_bank_model.rb +1 -1
  81. data/lib/cybrid_api_bank_ruby/models/execution_bank_model.rb +1 -1
  82. data/lib/cybrid_api_bank_ruby/models/execution_list_bank_model.rb +1 -1
  83. data/lib/cybrid_api_bank_ruby/models/execution_travel_rule_info_bank_model.rb +1 -1
  84. data/lib/cybrid_api_bank_ruby/models/external_bank_account_balances_bank_model.rb +1 -1
  85. data/lib/cybrid_api_bank_ruby/models/external_bank_account_bank_model.rb +1 -1
  86. data/lib/cybrid_api_bank_ruby/models/external_bank_account_kind_bank_model.rb +1 -1
  87. data/lib/cybrid_api_bank_ruby/models/external_bank_account_list_bank_model.rb +1 -1
  88. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_addresses_inner_bank_model.rb +1 -1
  89. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_bank_model.rb +1 -1
  90. data/lib/cybrid_api_bank_ruby/models/external_bank_account_pii_inner_routing_details_inner_bank_model.rb +1 -1
  91. data/lib/cybrid_api_bank_ruby/models/external_bank_account_state_bank_model.rb +1 -1
  92. data/lib/cybrid_api_bank_ruby/models/external_wallet_bank_model.rb +1 -1
  93. data/lib/cybrid_api_bank_ruby/models/external_wallet_environment_bank_model.rb +1 -1
  94. data/lib/cybrid_api_bank_ruby/models/external_wallet_list_bank_model.rb +1 -1
  95. data/lib/cybrid_api_bank_ruby/models/external_wallet_state_bank_model.rb +1 -1
  96. data/lib/cybrid_api_bank_ruby/models/fee_association_bank_model.rb +1 -1
  97. data/lib/cybrid_api_bank_ruby/models/fee_detail_bank_model.rb +1 -1
  98. data/lib/cybrid_api_bank_ruby/models/hold_detail_bank_model.rb +1 -1
  99. data/lib/cybrid_api_bank_ruby/models/identification_number_bank_model.rb +1 -1
  100. data/lib/cybrid_api_bank_ruby/models/identity_verification_bank_model.rb +1 -1
  101. data/lib/cybrid_api_bank_ruby/models/identity_verification_business_associate_bank_model.rb +1 -1
  102. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_bank_model.rb +1 -1
  103. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_bank_model.rb +1 -1
  104. data/lib/cybrid_api_bank_ruby/models/identity_verification_document_file_metadata_bank_model.rb +1 -1
  105. data/lib/cybrid_api_bank_ruby/models/identity_verification_list_bank_model.rb +1 -1
  106. data/lib/cybrid_api_bank_ruby/models/identity_verification_method_bank_model.rb +1 -1
  107. data/lib/cybrid_api_bank_ruby/models/identity_verification_options_bank_model.rb +1 -1
  108. data/lib/cybrid_api_bank_ruby/models/identity_verification_outcome_bank_model.rb +1 -1
  109. data/lib/cybrid_api_bank_ruby/models/identity_verification_persona_state_bank_model.rb +1 -1
  110. data/lib/cybrid_api_bank_ruby/models/identity_verification_state_bank_model.rb +1 -1
  111. data/lib/cybrid_api_bank_ruby/models/identity_verification_type_bank_model.rb +1 -1
  112. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_bank_model.rb +1 -1
  113. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_address_bank_model.rb +1 -1
  114. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_aliases_inner_bank_model.rb +1 -1
  115. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_bank_model.rb +1 -1
  116. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_name_bank_model.rb +1 -1
  117. data/lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_registered_address_bank_model.rb +1 -1
  118. data/lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb +1 -1
  119. data/lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb +1 -1
  120. data/lib/cybrid_api_bank_ruby/models/legal_entity_name_bank_model.rb +255 -0
  121. data/lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb +1 -1
  122. data/lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb +1 -1
  123. data/lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb +1 -1
  124. data/lib/cybrid_api_bank_ruby/models/patch_transfer_bank_model.rb +1 -1
  125. data/lib/cybrid_api_bank_ruby/models/patch_transfer_participant_bank_model.rb +1 -1
  126. data/lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb +1 -1
  127. data/lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb +1 -1
  128. data/lib/cybrid_api_bank_ruby/models/persona_session_bank_model.rb +1 -1
  129. data/lib/cybrid_api_bank_ruby/models/physical_address_bank_model.rb +277 -0
  130. data/lib/cybrid_api_bank_ruby/models/plan_bank_model.rb +1 -1
  131. data/lib/cybrid_api_bank_ruby/models/plan_list_bank_model.rb +1 -1
  132. data/lib/cybrid_api_bank_ruby/models/plan_travel_rule_info_bank_model.rb +1 -1
  133. data/lib/cybrid_api_bank_ruby/models/platform_file_bank_model.rb +1 -1
  134. data/lib/cybrid_api_bank_ruby/models/platform_file_list_bank_model.rb +1 -1
  135. data/lib/cybrid_api_bank_ruby/models/post_account_bank_model.rb +1 -1
  136. data/lib/cybrid_api_bank_ruby/models/post_bank_account_details_bank_model.rb +1 -1
  137. data/lib/cybrid_api_bank_ruby/models/post_bank_bank_model.rb +1 -1
  138. data/lib/cybrid_api_bank_ruby/models/post_counterparty_address_bank_model.rb +1 -1
  139. data/lib/cybrid_api_bank_ruby/models/post_counterparty_aliases_inner_bank_model.rb +1 -1
  140. data/lib/cybrid_api_bank_ruby/models/post_counterparty_bank_model.rb +1 -1
  141. data/lib/cybrid_api_bank_ruby/models/post_counterparty_name_bank_model.rb +1 -1
  142. data/lib/cybrid_api_bank_ruby/models/post_customer_address_bank_model.rb +1 -1
  143. data/lib/cybrid_api_bank_ruby/models/post_customer_aliases_inner_bank_model.rb +1 -1
  144. data/lib/cybrid_api_bank_ruby/models/post_customer_bank_model.rb +1 -1
  145. data/lib/cybrid_api_bank_ruby/models/post_customer_name_bank_model.rb +1 -1
  146. data/lib/cybrid_api_bank_ruby/models/post_deposit_address_bank_model.rb +1 -1
  147. data/lib/cybrid_api_bank_ruby/models/post_deposit_bank_account_bank_model.rb +1 -1
  148. data/lib/cybrid_api_bank_ruby/models/post_execution_bank_model.rb +1 -1
  149. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_bank_model.rb +1 -1
  150. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb +1 -1
  151. data/lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_name_bank_model.rb +1 -1
  152. data/lib/cybrid_api_bank_ruby/models/post_external_wallet_bank_model.rb +1 -1
  153. data/lib/cybrid_api_bank_ruby/models/post_fee_bank_model.rb +1 -1
  154. data/lib/cybrid_api_bank_ruby/models/post_file_bank_model.rb +1 -1
  155. data/lib/cybrid_api_bank_ruby/models/post_file_metadata_bank_model.rb +1 -1
  156. data/lib/cybrid_api_bank_ruby/models/post_identification_number_bank_model.rb +1 -1
  157. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_address_bank_model.rb +1 -1
  158. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_aliases_inner_bank_model.rb +1 -1
  159. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_bank_model.rb +1 -1
  160. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_name_bank_model.rb +1 -1
  161. data/lib/cybrid_api_bank_ruby/models/post_identity_verification_registered_address_bank_model.rb +1 -1
  162. data/lib/cybrid_api_bank_ruby/models/post_invoice_bank_model.rb +1 -1
  163. data/lib/cybrid_api_bank_ruby/models/post_payment_instruction_bank_model.rb +1 -1
  164. data/lib/cybrid_api_bank_ruby/models/post_persona_session_bank_model.rb +1 -1
  165. data/lib/cybrid_api_bank_ruby/models/post_plan_bank_model.rb +1 -1
  166. data/lib/cybrid_api_bank_ruby/models/post_plan_destination_account_bank_model.rb +1 -1
  167. data/lib/cybrid_api_bank_ruby/models/post_plan_source_account_bank_model.rb +1 -1
  168. data/lib/cybrid_api_bank_ruby/models/post_plan_travel_rule_info_bank_model.rb +1 -1
  169. data/lib/cybrid_api_bank_ruby/models/post_quote_bank_model.rb +1 -1
  170. data/lib/cybrid_api_bank_ruby/models/post_quote_entry_bank_model.rb +1 -1
  171. data/lib/cybrid_api_bank_ruby/models/post_sardine_session_bank_model.rb +1 -1
  172. data/lib/cybrid_api_bank_ruby/models/post_supported_payout_symbols_bank_model.rb +1 -1
  173. data/lib/cybrid_api_bank_ruby/models/post_supporting_document_bank_model.rb +1 -1
  174. data/lib/cybrid_api_bank_ruby/models/post_trade_bank_model.rb +1 -1
  175. data/lib/cybrid_api_bank_ruby/models/post_transfer_bank_model.rb +1 -1
  176. data/lib/cybrid_api_bank_ruby/models/post_transfer_participant_bank_model.rb +1 -1
  177. data/lib/cybrid_api_bank_ruby/models/post_ultimate_beneficial_owner_bank_model.rb +1 -1
  178. data/lib/cybrid_api_bank_ruby/models/post_workflow_bank_model.rb +1 -1
  179. data/lib/cybrid_api_bank_ruby/models/quote_bank_model.rb +1 -1
  180. data/lib/cybrid_api_bank_ruby/models/quote_entry_bank_model.rb +1 -1
  181. data/lib/cybrid_api_bank_ruby/models/quote_entry_destination_account_bank_model.rb +1 -1
  182. data/lib/cybrid_api_bank_ruby/models/quote_entry_source_account_bank_model.rb +1 -1
  183. data/lib/cybrid_api_bank_ruby/models/quote_list_bank_model.rb +1 -1
  184. data/lib/cybrid_api_bank_ruby/models/quote_side_bank_model.rb +1 -1
  185. data/lib/cybrid_api_bank_ruby/models/quote_type_bank_model.rb +1 -1
  186. data/lib/cybrid_api_bank_ruby/models/sardine_session_bank_model.rb +1 -1
  187. data/lib/cybrid_api_bank_ruby/models/stage_bank_model.rb +1 -1
  188. data/lib/cybrid_api_bank_ruby/models/stage_identifier_bank_model.rb +1 -1
  189. data/lib/cybrid_api_bank_ruby/models/stage_link_bank_model.rb +1 -1
  190. data/lib/cybrid_api_bank_ruby/models/supporting_document_bank_model.rb +1 -1
  191. data/lib/cybrid_api_bank_ruby/models/supporting_document_file_bank_model.rb +1 -1
  192. data/lib/cybrid_api_bank_ruby/models/symbol_price_bank_model.rb +1 -1
  193. data/lib/cybrid_api_bank_ruby/models/trade_bank_model.rb +1 -1
  194. data/lib/cybrid_api_bank_ruby/models/trade_failure_code_bank_model.rb +1 -1
  195. data/lib/cybrid_api_bank_ruby/models/trade_list_bank_model.rb +1 -1
  196. data/lib/cybrid_api_bank_ruby/models/trade_side_bank_model.rb +1 -1
  197. data/lib/cybrid_api_bank_ruby/models/trade_state_bank_model.rb +1 -1
  198. data/lib/cybrid_api_bank_ruby/models/trade_type_bank_model.rb +1 -1
  199. data/lib/cybrid_api_bank_ruby/models/transfer_account_type_bank_model.rb +1 -1
  200. data/lib/cybrid_api_bank_ruby/models/transfer_bank_model.rb +1 -1
  201. data/lib/cybrid_api_bank_ruby/models/transfer_destination_account_bank_model.rb +1 -1
  202. data/lib/cybrid_api_bank_ruby/models/transfer_entry_bank_model.rb +1 -1
  203. data/lib/cybrid_api_bank_ruby/models/transfer_entry_destination_account_bank_model.rb +1 -1
  204. data/lib/cybrid_api_bank_ruby/models/transfer_failure_code_bank_model.rb +1 -1
  205. data/lib/cybrid_api_bank_ruby/models/transfer_hold_details_bank_model.rb +1 -1
  206. data/lib/cybrid_api_bank_ruby/models/transfer_identifiers_inner_bank_model.rb +1 -1
  207. data/lib/cybrid_api_bank_ruby/models/transfer_list_bank_model.rb +1 -1
  208. data/lib/cybrid_api_bank_ruby/models/transfer_participant_bank_model.rb +1 -1
  209. data/lib/cybrid_api_bank_ruby/models/transfer_side_bank_model.rb +1 -1
  210. data/lib/cybrid_api_bank_ruby/models/transfer_source_account_bank_model.rb +1 -1
  211. data/lib/cybrid_api_bank_ruby/models/transfer_state_bank_model.rb +1 -1
  212. data/lib/cybrid_api_bank_ruby/models/transfer_type_bank_model.rb +1 -1
  213. data/lib/cybrid_api_bank_ruby/models/travel_rule_info_party_bank_model.rb +1 -1
  214. data/lib/cybrid_api_bank_ruby/models/workflow_bank_model.rb +1 -1
  215. data/lib/cybrid_api_bank_ruby/models/workflow_state_bank_model.rb +1 -1
  216. data/lib/cybrid_api_bank_ruby/models/workflow_type_bank_model.rb +1 -1
  217. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_all_of_bank_model.rb +1 -1
  218. data/lib/cybrid_api_bank_ruby/models/workflow_with_details_bank_model.rb +1 -1
  219. data/lib/cybrid_api_bank_ruby/models/workflows_list_bank_model.rb +1 -1
  220. data/lib/cybrid_api_bank_ruby/version.rb +2 -2
  221. data/lib/cybrid_api_bank_ruby.rb +3 -1
  222. data/spec/api/accounts_bank_api_spec.rb +1 -1
  223. data/spec/api/assets_bank_api_spec.rb +1 -1
  224. data/spec/api/banks_bank_api_spec.rb +1 -1
  225. data/spec/api/counterparties_bank_api_spec.rb +1 -1
  226. data/spec/api/customers_bank_api_spec.rb +1 -1
  227. data/spec/api/deposit_addresses_bank_api_spec.rb +1 -1
  228. data/spec/api/deposit_bank_accounts_bank_api_spec.rb +1 -1
  229. data/spec/api/executions_bank_api_spec.rb +1 -1
  230. data/spec/api/external_bank_accounts_bank_api_spec.rb +1 -1
  231. data/spec/api/external_wallets_bank_api_spec.rb +1 -1
  232. data/spec/api/files_bank_api_spec.rb +1 -1
  233. data/spec/api/identity_verifications_bank_api_spec.rb +1 -1
  234. data/spec/api/invoices_bank_api_spec.rb +1 -1
  235. data/spec/api/payment_instructions_bank_api_spec.rb +1 -1
  236. data/spec/api/persona_sessions_bank_api_spec.rb +1 -1
  237. data/spec/api/plans_bank_api_spec.rb +1 -1
  238. data/spec/api/prices_bank_api_spec.rb +1 -1
  239. data/spec/api/quotes_bank_api_spec.rb +1 -1
  240. data/spec/api/sardine_sessions_bank_api_spec.rb +1 -1
  241. data/spec/api/symbols_bank_api_spec.rb +1 -1
  242. data/spec/api/trades_bank_api_spec.rb +1 -1
  243. data/spec/api/transfers_bank_api_spec.rb +1 -1
  244. data/spec/api/workflows_bank_api_spec.rb +1 -1
  245. data/spec/api_client_spec.rb +1 -1
  246. data/spec/configuration_spec.rb +1 -1
  247. data/spec/models/account_association_bank_model_spec.rb +1 -1
  248. data/spec/models/account_bank_model_spec.rb +1 -1
  249. data/spec/models/account_list_bank_model_spec.rb +1 -1
  250. data/spec/models/account_state_bank_model_spec.rb +1 -1
  251. data/spec/models/account_type_bank_model_spec.rb +1 -1
  252. data/spec/models/activity_limit_bank_model_spec.rb +1 -1
  253. data/spec/models/activity_side_bank_model_spec.rb +1 -1
  254. data/spec/models/activity_type_bank_model_spec.rb +1 -1
  255. data/spec/models/asset_bank_model_spec.rb +1 -1
  256. data/spec/models/asset_list_bank_model_spec.rb +1 -1
  257. data/spec/models/asset_types_bank_model_spec.rb +1 -1
  258. data/spec/models/bank_bank_model_spec.rb +1 -1
  259. data/spec/models/bank_feature_bank_model_spec.rb +1 -1
  260. data/spec/models/bank_list_bank_model_spec.rb +1 -1
  261. data/spec/models/bank_supported_payout_symbols_inner_bank_model_spec.rb +1 -1
  262. data/spec/models/bank_type_bank_model_spec.rb +1 -1
  263. data/spec/models/compliance_check_bank_model_spec.rb +1 -1
  264. data/spec/models/compliance_check_outcome_bank_model_spec.rb +1 -1
  265. data/spec/models/compliance_check_type_bank_model_spec.rb +1 -1
  266. data/spec/models/compliance_decision_bank_model_spec.rb +1 -1
  267. data/spec/models/compliance_decision_state_bank_model_spec.rb +1 -1
  268. data/spec/models/compliance_decision_type_bank_model_spec.rb +1 -1
  269. data/spec/models/counterparty_address_bank_model_spec.rb +1 -1
  270. data/spec/models/counterparty_aliases_inner_bank_model_spec.rb +1 -1
  271. data/spec/models/counterparty_bank_model_spec.rb +1 -1
  272. data/spec/models/counterparty_list_bank_model_spec.rb +1 -1
  273. data/spec/models/counterparty_name_bank_model_spec.rb +1 -1
  274. data/spec/models/counterparty_state_bank_model_spec.rb +1 -1
  275. data/spec/models/counterparty_type_bank_model_spec.rb +1 -1
  276. data/spec/models/customer_address_bank_model_spec.rb +1 -1
  277. data/spec/models/customer_aliases_inner_bank_model_spec.rb +1 -1
  278. data/spec/models/customer_bank_model_spec.rb +1 -1
  279. data/spec/models/customer_list_bank_model_spec.rb +1 -1
  280. data/spec/models/customer_name_bank_model_spec.rb +1 -1
  281. data/spec/models/customer_state_bank_model_spec.rb +1 -1
  282. data/spec/models/customer_type_bank_model_spec.rb +1 -1
  283. data/spec/models/deposit_address_bank_model_spec.rb +1 -1
  284. data/spec/models/deposit_address_format_bank_model_spec.rb +1 -1
  285. data/spec/models/deposit_address_list_bank_model_spec.rb +1 -1
  286. data/spec/models/deposit_address_state_bank_model_spec.rb +1 -1
  287. data/spec/models/deposit_bank_account_account_details_inner_bank_model_spec.rb +1 -1
  288. data/spec/models/deposit_bank_account_bank_model_spec.rb +1 -1
  289. data/spec/models/deposit_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  290. data/spec/models/deposit_bank_account_list_bank_model_spec.rb +1 -1
  291. data/spec/models/deposit_bank_account_routing_details_inner_bank_model_spec.rb +1 -1
  292. data/spec/models/deposit_bank_account_routing_number_type_bank_model_spec.rb +1 -1
  293. data/spec/models/deposit_bank_account_state_bank_model_spec.rb +1 -1
  294. data/spec/models/error_response_bank_model_spec.rb +1 -1
  295. data/spec/models/execution_bank_model_spec.rb +1 -1
  296. data/spec/models/execution_list_bank_model_spec.rb +1 -1
  297. data/spec/models/execution_travel_rule_info_bank_model_spec.rb +1 -1
  298. data/spec/models/external_bank_account_balances_bank_model_spec.rb +1 -1
  299. data/spec/models/external_bank_account_bank_model_spec.rb +1 -1
  300. data/spec/models/external_bank_account_kind_bank_model_spec.rb +1 -1
  301. data/spec/models/external_bank_account_list_bank_model_spec.rb +1 -1
  302. data/spec/models/external_bank_account_pii_inner_addresses_inner_bank_model_spec.rb +1 -1
  303. data/spec/models/external_bank_account_pii_inner_bank_model_spec.rb +1 -1
  304. data/spec/models/external_bank_account_pii_inner_routing_details_inner_bank_model_spec.rb +1 -1
  305. data/spec/models/external_bank_account_state_bank_model_spec.rb +1 -1
  306. data/spec/models/external_wallet_bank_model_spec.rb +1 -1
  307. data/spec/models/external_wallet_environment_bank_model_spec.rb +1 -1
  308. data/spec/models/external_wallet_list_bank_model_spec.rb +1 -1
  309. data/spec/models/external_wallet_state_bank_model_spec.rb +1 -1
  310. data/spec/models/fee_association_bank_model_spec.rb +1 -1
  311. data/spec/models/fee_detail_bank_model_spec.rb +1 -1
  312. data/spec/models/hold_detail_bank_model_spec.rb +1 -1
  313. data/spec/models/identification_number_bank_model_spec.rb +1 -1
  314. data/spec/models/identity_verification_bank_model_spec.rb +1 -1
  315. data/spec/models/identity_verification_business_associate_bank_model_spec.rb +1 -1
  316. data/spec/models/identity_verification_document_bank_model_spec.rb +1 -1
  317. data/spec/models/identity_verification_document_file_bank_model_spec.rb +1 -1
  318. data/spec/models/identity_verification_document_file_metadata_bank_model_spec.rb +1 -1
  319. data/spec/models/identity_verification_list_bank_model_spec.rb +1 -1
  320. data/spec/models/identity_verification_method_bank_model_spec.rb +1 -1
  321. data/spec/models/identity_verification_options_bank_model_spec.rb +1 -1
  322. data/spec/models/identity_verification_outcome_bank_model_spec.rb +1 -1
  323. data/spec/models/identity_verification_persona_state_bank_model_spec.rb +1 -1
  324. data/spec/models/identity_verification_state_bank_model_spec.rb +1 -1
  325. data/spec/models/identity_verification_type_bank_model_spec.rb +1 -1
  326. data/spec/models/identity_verification_with_details_bank_model_spec.rb +1 -1
  327. data/spec/models/identity_verification_with_details_pii_address_bank_model_spec.rb +1 -1
  328. data/spec/models/identity_verification_with_details_pii_aliases_inner_bank_model_spec.rb +1 -1
  329. data/spec/models/identity_verification_with_details_pii_bank_model_spec.rb +1 -1
  330. data/spec/models/identity_verification_with_details_pii_name_bank_model_spec.rb +1 -1
  331. data/spec/models/identity_verification_with_details_pii_registered_address_bank_model_spec.rb +1 -1
  332. data/spec/models/invoice_bank_model_spec.rb +1 -1
  333. data/spec/models/invoice_list_bank_model_spec.rb +1 -1
  334. data/spec/models/legal_entity_name_bank_model_spec.rb +52 -0
  335. data/spec/models/patch_bank_bank_model_spec.rb +1 -1
  336. data/spec/models/patch_customer_bank_model_spec.rb +1 -1
  337. data/spec/models/patch_external_bank_account_bank_model_spec.rb +1 -1
  338. data/spec/models/patch_transfer_bank_model_spec.rb +1 -1
  339. data/spec/models/patch_transfer_participant_bank_model_spec.rb +1 -1
  340. data/spec/models/payment_instruction_bank_model_spec.rb +1 -1
  341. data/spec/models/payment_instruction_list_bank_model_spec.rb +1 -1
  342. data/spec/models/persona_session_bank_model_spec.rb +1 -1
  343. data/spec/models/physical_address_bank_model_spec.rb +64 -0
  344. data/spec/models/plan_bank_model_spec.rb +1 -1
  345. data/spec/models/plan_list_bank_model_spec.rb +1 -1
  346. data/spec/models/plan_travel_rule_info_bank_model_spec.rb +1 -1
  347. data/spec/models/platform_file_bank_model_spec.rb +1 -1
  348. data/spec/models/platform_file_list_bank_model_spec.rb +1 -1
  349. data/spec/models/post_account_bank_model_spec.rb +1 -1
  350. data/spec/models/post_bank_account_details_bank_model_spec.rb +1 -1
  351. data/spec/models/post_bank_bank_model_spec.rb +1 -1
  352. data/spec/models/post_counterparty_address_bank_model_spec.rb +1 -1
  353. data/spec/models/post_counterparty_aliases_inner_bank_model_spec.rb +1 -1
  354. data/spec/models/post_counterparty_bank_model_spec.rb +1 -1
  355. data/spec/models/post_counterparty_name_bank_model_spec.rb +1 -1
  356. data/spec/models/post_customer_address_bank_model_spec.rb +1 -1
  357. data/spec/models/post_customer_aliases_inner_bank_model_spec.rb +1 -1
  358. data/spec/models/post_customer_bank_model_spec.rb +1 -1
  359. data/spec/models/post_customer_name_bank_model_spec.rb +1 -1
  360. data/spec/models/post_deposit_address_bank_model_spec.rb +1 -1
  361. data/spec/models/post_deposit_bank_account_bank_model_spec.rb +1 -1
  362. data/spec/models/post_execution_bank_model_spec.rb +1 -1
  363. data/spec/models/post_external_bank_account_bank_model_spec.rb +1 -1
  364. data/spec/models/post_external_bank_account_counterparty_address_bank_model_spec.rb +1 -1
  365. data/spec/models/post_external_bank_account_counterparty_name_bank_model_spec.rb +1 -1
  366. data/spec/models/post_external_wallet_bank_model_spec.rb +1 -1
  367. data/spec/models/post_fee_bank_model_spec.rb +1 -1
  368. data/spec/models/post_file_bank_model_spec.rb +1 -1
  369. data/spec/models/post_file_metadata_bank_model_spec.rb +1 -1
  370. data/spec/models/post_identification_number_bank_model_spec.rb +1 -1
  371. data/spec/models/post_identity_verification_address_bank_model_spec.rb +1 -1
  372. data/spec/models/post_identity_verification_aliases_inner_bank_model_spec.rb +1 -1
  373. data/spec/models/post_identity_verification_bank_model_spec.rb +1 -1
  374. data/spec/models/post_identity_verification_name_bank_model_spec.rb +1 -1
  375. data/spec/models/post_identity_verification_registered_address_bank_model_spec.rb +1 -1
  376. data/spec/models/post_invoice_bank_model_spec.rb +1 -1
  377. data/spec/models/post_payment_instruction_bank_model_spec.rb +1 -1
  378. data/spec/models/post_persona_session_bank_model_spec.rb +1 -1
  379. data/spec/models/post_plan_bank_model_spec.rb +1 -1
  380. data/spec/models/post_plan_destination_account_bank_model_spec.rb +1 -1
  381. data/spec/models/post_plan_source_account_bank_model_spec.rb +1 -1
  382. data/spec/models/post_plan_travel_rule_info_bank_model_spec.rb +1 -1
  383. data/spec/models/post_quote_bank_model_spec.rb +1 -1
  384. data/spec/models/post_quote_entry_bank_model_spec.rb +1 -1
  385. data/spec/models/post_sardine_session_bank_model_spec.rb +1 -1
  386. data/spec/models/post_supported_payout_symbols_bank_model_spec.rb +1 -1
  387. data/spec/models/post_supporting_document_bank_model_spec.rb +1 -1
  388. data/spec/models/post_trade_bank_model_spec.rb +1 -1
  389. data/spec/models/post_transfer_bank_model_spec.rb +1 -1
  390. data/spec/models/post_transfer_participant_bank_model_spec.rb +1 -1
  391. data/spec/models/post_ultimate_beneficial_owner_bank_model_spec.rb +1 -1
  392. data/spec/models/post_workflow_bank_model_spec.rb +1 -1
  393. data/spec/models/quote_bank_model_spec.rb +1 -1
  394. data/spec/models/quote_entry_bank_model_spec.rb +1 -1
  395. data/spec/models/quote_entry_destination_account_bank_model_spec.rb +1 -1
  396. data/spec/models/quote_entry_source_account_bank_model_spec.rb +1 -1
  397. data/spec/models/quote_list_bank_model_spec.rb +1 -1
  398. data/spec/models/quote_side_bank_model_spec.rb +1 -1
  399. data/spec/models/quote_type_bank_model_spec.rb +1 -1
  400. data/spec/models/sardine_session_bank_model_spec.rb +1 -1
  401. data/spec/models/stage_bank_model_spec.rb +1 -1
  402. data/spec/models/stage_identifier_bank_model_spec.rb +1 -1
  403. data/spec/models/stage_link_bank_model_spec.rb +1 -1
  404. data/spec/models/supporting_document_bank_model_spec.rb +1 -1
  405. data/spec/models/supporting_document_file_bank_model_spec.rb +1 -1
  406. data/spec/models/symbol_price_bank_model_spec.rb +1 -1
  407. data/spec/models/trade_bank_model_spec.rb +1 -1
  408. data/spec/models/trade_failure_code_bank_model_spec.rb +1 -1
  409. data/spec/models/trade_list_bank_model_spec.rb +1 -1
  410. data/spec/models/trade_side_bank_model_spec.rb +1 -1
  411. data/spec/models/trade_state_bank_model_spec.rb +1 -1
  412. data/spec/models/trade_type_bank_model_spec.rb +1 -1
  413. data/spec/models/transfer_account_type_bank_model_spec.rb +1 -1
  414. data/spec/models/transfer_bank_model_spec.rb +1 -1
  415. data/spec/models/transfer_destination_account_bank_model_spec.rb +1 -1
  416. data/spec/models/transfer_entry_bank_model_spec.rb +1 -1
  417. data/spec/models/transfer_entry_destination_account_bank_model_spec.rb +1 -1
  418. data/spec/models/transfer_failure_code_bank_model_spec.rb +1 -1
  419. data/spec/models/transfer_hold_details_bank_model_spec.rb +1 -1
  420. data/spec/models/transfer_identifiers_inner_bank_model_spec.rb +1 -1
  421. data/spec/models/transfer_list_bank_model_spec.rb +1 -1
  422. data/spec/models/transfer_participant_bank_model_spec.rb +1 -1
  423. data/spec/models/transfer_side_bank_model_spec.rb +1 -1
  424. data/spec/models/transfer_source_account_bank_model_spec.rb +1 -1
  425. data/spec/models/transfer_state_bank_model_spec.rb +1 -1
  426. data/spec/models/transfer_type_bank_model_spec.rb +1 -1
  427. data/spec/models/travel_rule_info_party_bank_model_spec.rb +1 -1
  428. data/spec/models/workflow_bank_model_spec.rb +1 -1
  429. data/spec/models/workflow_state_bank_model_spec.rb +1 -1
  430. data/spec/models/workflow_type_bank_model_spec.rb +1 -1
  431. data/spec/models/workflow_with_details_all_of_bank_model_spec.rb +1 -1
  432. data/spec/models/workflow_with_details_bank_model_spec.rb +1 -1
  433. data/spec/models/workflows_list_bank_model_spec.rb +1 -1
  434. data/spec/spec_helper.rb +1 -1
  435. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/byebug-13.0.0/gem_make.out +5 -5
  436. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/date-3.5.1/gem_make.out +5 -5
  437. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/io-console-0.8.2/gem_make.out +5 -5
  438. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/jaro_winkler-1.5.6/gem_make.out +5 -5
  439. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/psych-5.4.0/gem_make.out +5 -5
  440. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/racc-1.8.1/gem_make.out +5 -5
  441. data/vendor/bundle/ruby/4.0.0/extensions/x86_64-linux/4.0.0/stringio-3.2.0/gem_make.out +5 -5
  442. metadata +9 -1
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## 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](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) 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](https://bank.production.cybrid.app/api/schema/v1/swagger.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-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](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) 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](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) 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](https://id.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:read bank_applications:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <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.**</font> ## 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) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically 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 a passing `Identity Verification`. See the Identity Verifications 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.
5
5
 
6
- The version of the OpenAPI document: v0.129.390
6
+ The version of the OpenAPI document: v0.129.391
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## 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](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) 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](https://bank.production.cybrid.app/api/schema/v1/swagger.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-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](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) 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](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) 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](https://id.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:read bank_applications:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <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.**</font> ## 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) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically 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 a passing `Identity Verification`. See the Identity Verifications 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.
5
5
 
6
- The version of the OpenAPI document: v0.129.390
6
+ The version of the OpenAPI document: v0.129.391
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## 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](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) 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](https://bank.production.cybrid.app/api/schema/v1/swagger.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-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](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) 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](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) 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](https://id.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:read bank_applications:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <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.**</font> ## 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) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically 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 a passing `Identity Verification`. See the Identity Verifications 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.
5
5
 
6
- The version of the OpenAPI document: v0.129.390
6
+ The version of the OpenAPI document: v0.129.391
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## 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](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) 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](https://bank.production.cybrid.app/api/schema/v1/swagger.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-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](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) 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](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) 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](https://id.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:read bank_applications:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <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.**</font> ## 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) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically 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 a passing `Identity Verification`. See the Identity Verifications 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.
5
5
 
6
- The version of the OpenAPI document: v0.129.390
6
+ The version of the OpenAPI document: v0.129.391
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
data/spec/spec_helper.rb CHANGED
@@ -3,7 +3,7 @@
3
3
 
4
4
  ## 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](https://github.com/Cybrid-app). 💡 We recommend bookmarking the [Cybrid LinkTree](https://linktr.ee/cybridtechnologies) 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](https://bank.production.cybrid.app/api/schema/v1/swagger.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. [Introduction](https://docs.cybrid.xyz/docs/introduction) 2. [Platform Overview](https://docs.cybrid.xyz/docs/platform-overview) 3. [Testing with Hosted Web Demo App](https://docs.cybrid.xyz/docs/hosted-demo-app) In [Getting Started in the Cybrid Sandbox](https://docs.cybrid.xyz/docs/cybrid-sandbox), we walk you through how to use the [Cybrid Sandbox](https://id.sandbox.cybrid.app/) to create a test bank and generate API keys. In [Getting Ready for Trading](https://docs.cybrid.xyz/docs/trade-process), we walk through creating customers, customer identities, accounts, as well as executing quotes and trades. ## 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](https://github.com/Cybrid-app/cybrid-api-bank-angular), [Java](https://github.com/Cybrid-app/cybrid-api-bank-java), [Kotlin](https://github.com/Cybrid-app/cybrid-api-bank-kotlin), [Python](https://github.com/Cybrid-app/cybrid-api-bank-python), [Ruby](https://github.com/Cybrid-app/cybrid-api-bank-ruby), [Swift](https://github.com/Cybrid-app/cybrid-api-bank-swift) or [Typescript](https://github.com/Cybrid-app/cybrid-api-bank-typescript)) 3. Integrating a platform specific SDK ([Web](https://github.com/Cybrid-app/cybrid-sdk-web), [Android](https://github.com/Cybrid-app/cybrid-sdk-android), [iOS](https://github.com/Cybrid-app/cybrid-sdk-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](https://organization.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organizations | | [Bank API](https://bank.production.cybrid.app/api/schema/swagger-ui) | APIs to manage banks (and all downstream customer activity) | | [Identities API](https://id.production.cybrid.app/api/schema/swagger-ui) | APIs to manage organization and bank identities | For questions please contact [Support](mailto:support@cybrid.xyz) at any time for assistance, or contact the [Product Team](mailto:product@cybrid.xyz) 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](https://id.production.cybrid.app). Access tokens can be generated for a `Customer` as well via the [Cybrid IdP](https://id.production.cybrid.app) 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](https://id.production.cybrid.app/api/schema/swagger-ui). <font color=\"orange\">**⚠️ Never share your Client ID or Secret publicly or in your source code repository.**</font> 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. ``` # Example request when using Bank credentials curl -X POST https://id.production.cybrid.app/oauth/token -d '{ \"grant_type\": \"client_credentials\", \"client_id\": \"<Your Client ID>\", \"client_secret\": \"<Your Secret>\", \"scope\": \"banks:read banks:write bank_applications:read bank_applications:write bank_applications:execute accounts:read accounts:execute counterparties:read counterparties:pii:read counterparties:write counterparties:execute customers:read customers:pii:read customers:write customers:execute prices:read quotes:execute quotes:read trades:execute trades:read transfers:execute transfers:read transfers:write external_bank_accounts:read external_bank_accounts:pii:read external_bank_accounts:write external_bank_accounts:execute external_wallets:read external_wallets:execute workflows:read workflows:execute deposit_addresses:read deposit_addresses:execute deposit_bank_accounts:read deposit_bank_accounts:execute invoices:read invoices:write invoices:execute identity_verifications:read identity_verifications:pii:read identity_verifications:write identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute\" }' -H \"Content-Type: application/json\" # When using Organization credentials set `scope` to 'organizations:read organizations:write organization_applications:read organization_applications:write organization_applications:execute banks:read banks:write banks:execute bank_applications:read bank_applications:write bank_applications:execute users:read users:write users:execute counterparties:read counterparties:pii:read customers:read customers:pii:read accounts:read prices:read quotes:execute quotes:read trades:execute trades:read transfers:read transfers:write transfers:execute external_bank_accounts:read external_bank_accounts:pii:read external_wallets:read workflows:read deposit_addresses:read deposit_bank_accounts:read invoices:read subscriptions:read subscriptions:write subscriptions:execute subscription_events:read subscription_events:execute identity_verifications:read identity_verifications:pii:read identity_verifications:execute persona_sessions:execute sardine_sessions:execute plans:execute plans:read executions:execute executions:read files:read files:pii:read files:execute' ``` <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.**</font> ## 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) | |-----------------------|------------------------------------------------------------|-----------------------------------------------|--------------------------------------------------| | Account | accounts:read (Organization, Bank, Customer) | | accounts:execute (Bank, Customer) | | Bank | banks:read (Organization, Bank) | banks:write (Organization, Bank) | banks:execute (Organization) | | Customer | customers:read (Organization, Bank, Customer) | customers:write (Bank, Customer) | customers:execute (Bank) | | Counterparty | counterparties:read (Organization, Bank, Customer) | counterparties:write (Bank, Customer) | counterparties:execute (Bank) | | Deposit Address | deposit_addresses:read (Organization, Bank, Customer) | deposit_addresses:write (Bank, Customer) | deposit_addresses:execute (Bank, Customer) | | External Bank Account | external_bank_accounts:read (Organization, Bank, Customer) | external_bank_accounts:write (Bank, Customer) | external_bank_accounts:execute (Bank, Customer) | | External Wallet | external_wallet:read (Organization, Bank, Customer) | | external_wallet:execute (Bank, Customer) | | Organization | organizations:read (Organization) | organizations:write (Organization) | | | User | users:read (Organization) | | users:execute (Organization) | | Price | prices:read (Bank, Customer) | | | | Quote | quotes:read (Organization, Bank, Customer) | | quotes:execute (Organization, Bank, Customer) | | Trade | trades:read (Organization, Bank, Customer) | | trades:execute (Organization, Bank, Customer) | | Transfer | transfers:read (Organization, Bank, Customer) | | transfers:execute (Organization, Bank, Customer) | | Workflow | workflows:read (Organization, Bank, Customer) | | workflows:execute (Bank, Customer) | | Invoice | invoices:read (Organization, Bank, Customer) | invoices:write (Bank, Customer) | invoices:execute (Bank, Customer) | ## Available Endpoints The available APIs for the [Identity](https://id.production.cybrid.app/api/schema/swagger-ui), [Organization](https://organization.production.cybrid.app/api/schema/swagger-ui) and [Bank](https://bank.production.cybrid.app/api/schema/swagger-ui) API services are listed below: | API Service | Model | API Endpoint Path | Description | |--------------|----------------------|--------------------------------|---------------------------------------------------------------------------------------------------| | Identity | Bank | /api/bank_applications | Create and list banks | | Identity | CustomerToken | /api/customer_tokens | Create customer JWT access tokens | | Identity | Organization | /api/organization_applications | Create and list organizations | | Identity | Organization | /api/users | Create and list organization users | | Organization | Organization | /api/organizations | APIs to retrieve and update organization name | | Bank | Account | /api/accounts | Create and list accounts, which hold a specific asset for a customers | | Bank | Asset | /api/assets | Get a list of assets supported by the platform (ex: BTC, ETH) | | Bank | Bank | /api/banks | Create, update and list banks, the parent to customers, accounts, etc | | Bank | Customer | /api/customers | Create and list customers | | Bank | Counterparty | /api/counterparties | Create and list counterparties | | Bank | DepositAddress | /api/deposit_addresses | Create, get and list deposit addresses | | Bank | ExternalBankAccount | /api/external_bank_accounts | Create, get and list external bank accounts, which connect customer bank accounts to the platform | | Bank | ExternalWallet | /api/external_wallets | Create, get, list and delete external wallets, which connect customer wallets to the platform | | Bank | IdentityVerification | /api/identity_verifications | Create and list identity verifications, which are performed on customers for KYC | | Bank | Invoice | /api/invoices | Create, get, cancel and list invoices | | Bank | PaymentInstruction | /api/payment_instructions | Create, get and list payment instructions for invoices | | Bank | Price | /api/prices | Get the current prices for assets on the platform | | Bank | Quote | /api/quotes | Create and list quotes, which are required to execute trades | | Bank | Symbol | /api/symbols | Get a list of symbols supported for trade (ex: BTC-USD) | | Bank | Trade | /api/trades | Create and list trades, which buy or sell cryptocurrency | | Bank | Transfer | /api/transfers | Create, get and list transfers (e.g., funding, book) | | Bank | Workflow | /api/workflows | Create, get and list workflows | ## Understanding Object Models & Endpoints **Organizations** An `Organization` is meant to represent the organization partnering with Cybrid to use our platform. An `Organization` typically 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 a passing `Identity Verification`. See the Identity Verifications 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.
5
5
 
6
- The version of the OpenAPI document: v0.129.390
6
+ The version of the OpenAPI document: v0.129.391
7
7
  Contact: support@cybrid.app
8
8
  Generated by: https://openapi-generator.tech
9
9
  OpenAPI Generator version: 6.0.0
@@ -3,12 +3,12 @@ current directory: /home/circleci/project/build/public-clients/api-platform-bank
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug
6
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-pcw6dc sitelibdir\=./.gem.20260615-3232-pcw6dc clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-qu79zt sitelibdir\=./.gem.20260615-3231-qu79zt clean
7
7
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
8
8
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
9
9
 
10
10
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug
11
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-pcw6dc sitelibdir\=./.gem.20260615-3232-pcw6dc
11
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-qu79zt sitelibdir\=./.gem.20260615-3231-qu79zt
12
12
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
13
13
  compiling breakpoint.c
14
14
  compiling byebug.c
@@ -39,12 +39,12 @@ linking shared-object byebug/byebug.so
39
39
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
40
40
 
41
41
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug
42
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-pcw6dc sitelibdir\=./.gem.20260615-3232-pcw6dc install
42
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-qu79zt sitelibdir\=./.gem.20260615-3231-qu79zt install
43
43
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
44
- /usr/bin/install -c -m 0755 byebug.so ./.gem.20260615-3232-pcw6dc/byebug
44
+ /usr/bin/install -c -m 0755 byebug.so ./.gem.20260615-3231-qu79zt/byebug
45
45
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
46
46
 
47
47
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug
48
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-pcw6dc sitelibdir\=./.gem.20260615-3232-pcw6dc clean
48
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-qu79zt sitelibdir\=./.gem.20260615-3231-qu79zt clean
49
49
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
50
50
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/byebug-13.0.0/ext/byebug'
@@ -6,12 +6,12 @@ checking for altzone in time.h with -Werror... no
6
6
  creating Makefile
7
7
 
8
8
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date
9
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-3tmsvi sitelibdir\=./.gem.20260615-3232-3tmsvi clean
9
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-upuah1 sitelibdir\=./.gem.20260615-3231-upuah1 clean
10
10
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
11
11
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
12
12
 
13
13
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date
14
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-3tmsvi sitelibdir\=./.gem.20260615-3232-3tmsvi
14
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-upuah1 sitelibdir\=./.gem.20260615-3231-upuah1
15
15
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
16
16
  compiling date_core.c
17
17
  compiling date_parse.c
@@ -21,12 +21,12 @@ linking shared-object date_core.so
21
21
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
22
22
 
23
23
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date
24
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-3tmsvi sitelibdir\=./.gem.20260615-3232-3tmsvi install
24
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-upuah1 sitelibdir\=./.gem.20260615-3231-upuah1 install
25
25
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
26
- /usr/bin/install -c -m 0755 date_core.so ./.gem.20260615-3232-3tmsvi
26
+ /usr/bin/install -c -m 0755 date_core.so ./.gem.20260615-3231-upuah1
27
27
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
28
28
 
29
29
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date
30
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-3tmsvi sitelibdir\=./.gem.20260615-3232-3tmsvi clean
30
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-upuah1 sitelibdir\=./.gem.20260615-3231-upuah1 clean
31
31
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
32
32
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/date-3.5.1/ext/date'
@@ -16,24 +16,24 @@ checking for ttyname_r()... yes
16
16
  creating Makefile
17
17
 
18
18
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console
19
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-mig02d sitelibdir\=./.gem.20260615-3232-mig02d clean
19
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-igdu15 sitelibdir\=./.gem.20260615-3231-igdu15 clean
20
20
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console'
21
21
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console'
22
22
 
23
23
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console
24
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-mig02d sitelibdir\=./.gem.20260615-3232-mig02d
24
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-igdu15 sitelibdir\=./.gem.20260615-3231-igdu15
25
25
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console'
26
26
  compiling console.c
27
27
  linking shared-object io/console.so
28
28
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console'
29
29
 
30
30
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console
31
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-mig02d sitelibdir\=./.gem.20260615-3232-mig02d install
31
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-igdu15 sitelibdir\=./.gem.20260615-3231-igdu15 install
32
32
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console'
33
- /usr/bin/install -c -m 0755 console.so ./.gem.20260615-3232-mig02d/io
33
+ /usr/bin/install -c -m 0755 console.so ./.gem.20260615-3231-igdu15/io
34
34
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console'
35
35
 
36
36
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console
37
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-mig02d sitelibdir\=./.gem.20260615-3232-mig02d clean
37
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-igdu15 sitelibdir\=./.gem.20260615-3231-igdu15 clean
38
38
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console'
39
39
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/io-console-0.8.2/ext/io/console'
@@ -3,12 +3,12 @@ current directory: /home/circleci/project/build/public-clients/api-platform-bank
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
6
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-2m81aj sitelibdir\=./.gem.20260615-3232-2m81aj clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-d1dty6 sitelibdir\=./.gem.20260615-3231-d1dty6 clean
7
7
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
8
8
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
9
9
 
10
10
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
11
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-2m81aj sitelibdir\=./.gem.20260615-3232-2m81aj
11
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-d1dty6 sitelibdir\=./.gem.20260615-3231-d1dty6
12
12
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
13
13
  compiling adj_matrix.c
14
14
  adj_matrix.c: In function ‘adj_matrix_default’:
@@ -26,12 +26,12 @@ linking shared-object jaro_winkler/jaro_winkler_ext.so
26
26
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
27
27
 
28
28
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
29
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-2m81aj sitelibdir\=./.gem.20260615-3232-2m81aj install
29
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-d1dty6 sitelibdir\=./.gem.20260615-3231-d1dty6 install
30
30
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
31
- /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20260615-3232-2m81aj/jaro_winkler
31
+ /usr/bin/install -c -m 0755 jaro_winkler_ext.so ./.gem.20260615-3231-d1dty6/jaro_winkler
32
32
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
33
33
 
34
34
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler
35
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-2m81aj sitelibdir\=./.gem.20260615-3232-2m81aj clean
35
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-d1dty6 sitelibdir\=./.gem.20260615-3231-d1dty6 clean
36
36
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
37
37
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/jaro_winkler-1.5.6/ext/jaro_winkler'
@@ -4,7 +4,7 @@ checking for pkg-config for yaml-0.1... [" ", "", "-lyaml"]
4
4
  creating Makefile
5
5
 
6
6
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych
7
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-xv9a5g sitelibdir\=./.gem.20260615-3232-xv9a5g clean
7
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-ez8yae sitelibdir\=./.gem.20260615-3231-ez8yae clean
8
8
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
9
9
  cd libyaml && make clean
10
10
  /bin/sh: 1: cd: can't cd to libyaml
@@ -12,7 +12,7 @@ make[1]: [Makefile:287: clean-so] Error 2 (ignored)
12
12
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
13
13
 
14
14
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych
15
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-xv9a5g sitelibdir\=./.gem.20260615-3232-xv9a5g
15
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-ez8yae sitelibdir\=./.gem.20260615-3231-ez8yae
16
16
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
17
17
  compiling psych.c
18
18
  compiling psych_emitter.c
@@ -23,13 +23,13 @@ linking shared-object psych.so
23
23
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
24
24
 
25
25
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych
26
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-xv9a5g sitelibdir\=./.gem.20260615-3232-xv9a5g install
26
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-ez8yae sitelibdir\=./.gem.20260615-3231-ez8yae install
27
27
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
28
- /usr/bin/install -c -m 0755 psych.so ./.gem.20260615-3232-xv9a5g
28
+ /usr/bin/install -c -m 0755 psych.so ./.gem.20260615-3231-ez8yae
29
29
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
30
30
 
31
31
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych
32
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-xv9a5g sitelibdir\=./.gem.20260615-3232-xv9a5g clean
32
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-ez8yae sitelibdir\=./.gem.20260615-3231-ez8yae clean
33
33
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/psych-5.4.0/ext/psych'
34
34
  cd libyaml && make clean
35
35
  /bin/sh: 1: cd: can't cd to libyaml
@@ -3,24 +3,24 @@ current directory: /home/circleci/project/build/public-clients/api-platform-bank
3
3
  creating Makefile
4
4
 
5
5
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse
6
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-nvb1ib sitelibdir\=./.gem.20260615-3232-nvb1ib clean
6
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-m6jbbq sitelibdir\=./.gem.20260615-3231-m6jbbq clean
7
7
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
8
8
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
9
9
 
10
10
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse
11
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-nvb1ib sitelibdir\=./.gem.20260615-3232-nvb1ib
11
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-m6jbbq sitelibdir\=./.gem.20260615-3231-m6jbbq
12
12
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
13
13
  compiling cparse.c
14
14
  linking shared-object racc/cparse.so
15
15
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
16
16
 
17
17
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse
18
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-nvb1ib sitelibdir\=./.gem.20260615-3232-nvb1ib install
18
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-m6jbbq sitelibdir\=./.gem.20260615-3231-m6jbbq install
19
19
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
20
- /usr/bin/install -c -m 0755 cparse.so ./.gem.20260615-3232-nvb1ib/racc
20
+ /usr/bin/install -c -m 0755 cparse.so ./.gem.20260615-3231-m6jbbq/racc
21
21
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
22
22
 
23
23
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse
24
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-nvb1ib sitelibdir\=./.gem.20260615-3232-nvb1ib clean
24
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-m6jbbq sitelibdir\=./.gem.20260615-3231-m6jbbq clean
25
25
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
26
26
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/racc-1.8.1/ext/racc/cparse'
@@ -4,24 +4,24 @@ checking for rb_io_mode_t in ruby/io.h... yes
4
4
  creating Makefile
5
5
 
6
6
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio
7
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-rhhz7e sitelibdir\=./.gem.20260615-3232-rhhz7e clean
7
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-tn48ih sitelibdir\=./.gem.20260615-3231-tn48ih clean
8
8
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
9
9
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
10
10
 
11
11
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio
12
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-rhhz7e sitelibdir\=./.gem.20260615-3232-rhhz7e
12
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-tn48ih sitelibdir\=./.gem.20260615-3231-tn48ih
13
13
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
14
14
  compiling stringio.c
15
15
  linking shared-object stringio.so
16
16
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
17
17
 
18
18
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio
19
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-rhhz7e sitelibdir\=./.gem.20260615-3232-rhhz7e install
19
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-tn48ih sitelibdir\=./.gem.20260615-3231-tn48ih install
20
20
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
21
- /usr/bin/install -c -m 0755 stringio.so ./.gem.20260615-3232-rhhz7e
21
+ /usr/bin/install -c -m 0755 stringio.so ./.gem.20260615-3231-tn48ih
22
22
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
23
23
 
24
24
  current directory: /home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio
25
- make DESTDIR\= sitearchdir\=./.gem.20260615-3232-rhhz7e sitelibdir\=./.gem.20260615-3232-rhhz7e clean
25
+ make DESTDIR\= sitearchdir\=./.gem.20260615-3231-tn48ih sitelibdir\=./.gem.20260615-3231-tn48ih clean
26
26
  make[1]: Entering directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
27
27
  make[1]: Leaving directory '/home/circleci/project/build/public-clients/api-platform-bank/ruby/vendor/bundle/ruby/4.0.0/gems/stringio-3.2.0/ext/stringio'
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: cybrid_api_bank_ruby
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.129.390
4
+ version: 0.129.391
5
5
  platform: ruby
6
6
  authors:
7
7
  - Cybrid
@@ -161,6 +161,7 @@ files:
161
161
  - docs/InvoiceBankModel.md
162
162
  - docs/InvoiceListBankModel.md
163
163
  - docs/InvoicesBankApi.md
164
+ - docs/LegalEntityNameBankModel.md
164
165
  - docs/PatchBankBankModel.md
165
166
  - docs/PatchCustomerBankModel.md
166
167
  - docs/PatchExternalBankAccountBankModel.md
@@ -171,6 +172,7 @@ files:
171
172
  - docs/PaymentInstructionsBankApi.md
172
173
  - docs/PersonaSessionBankModel.md
173
174
  - docs/PersonaSessionsBankApi.md
175
+ - docs/PhysicalAddressBankModel.md
174
176
  - docs/PlanBankModel.md
175
177
  - docs/PlanListBankModel.md
176
178
  - docs/PlanTravelRuleInfoBankModel.md
@@ -384,6 +386,7 @@ files:
384
386
  - lib/cybrid_api_bank_ruby/models/identity_verification_with_details_pii_registered_address_bank_model.rb
385
387
  - lib/cybrid_api_bank_ruby/models/invoice_bank_model.rb
386
388
  - lib/cybrid_api_bank_ruby/models/invoice_list_bank_model.rb
389
+ - lib/cybrid_api_bank_ruby/models/legal_entity_name_bank_model.rb
387
390
  - lib/cybrid_api_bank_ruby/models/patch_bank_bank_model.rb
388
391
  - lib/cybrid_api_bank_ruby/models/patch_customer_bank_model.rb
389
392
  - lib/cybrid_api_bank_ruby/models/patch_external_bank_account_bank_model.rb
@@ -392,6 +395,7 @@ files:
392
395
  - lib/cybrid_api_bank_ruby/models/payment_instruction_bank_model.rb
393
396
  - lib/cybrid_api_bank_ruby/models/payment_instruction_list_bank_model.rb
394
397
  - lib/cybrid_api_bank_ruby/models/persona_session_bank_model.rb
398
+ - lib/cybrid_api_bank_ruby/models/physical_address_bank_model.rb
395
399
  - lib/cybrid_api_bank_ruby/models/plan_bank_model.rb
396
400
  - lib/cybrid_api_bank_ruby/models/plan_list_bank_model.rb
397
401
  - lib/cybrid_api_bank_ruby/models/plan_travel_rule_info_bank_model.rb
@@ -595,6 +599,7 @@ files:
595
599
  - spec/models/identity_verification_with_details_pii_registered_address_bank_model_spec.rb
596
600
  - spec/models/invoice_bank_model_spec.rb
597
601
  - spec/models/invoice_list_bank_model_spec.rb
602
+ - spec/models/legal_entity_name_bank_model_spec.rb
598
603
  - spec/models/patch_bank_bank_model_spec.rb
599
604
  - spec/models/patch_customer_bank_model_spec.rb
600
605
  - spec/models/patch_external_bank_account_bank_model_spec.rb
@@ -603,6 +608,7 @@ files:
603
608
  - spec/models/payment_instruction_bank_model_spec.rb
604
609
  - spec/models/payment_instruction_list_bank_model_spec.rb
605
610
  - spec/models/persona_session_bank_model_spec.rb
611
+ - spec/models/physical_address_bank_model_spec.rb
606
612
  - spec/models/plan_bank_model_spec.rb
607
613
  - spec/models/plan_list_bank_model_spec.rb
608
614
  - spec/models/plan_travel_rule_info_bank_model_spec.rb
@@ -2913,6 +2919,7 @@ test_files:
2913
2919
  - spec/models/identity_verification_with_details_pii_registered_address_bank_model_spec.rb
2914
2920
  - spec/models/invoice_bank_model_spec.rb
2915
2921
  - spec/models/invoice_list_bank_model_spec.rb
2922
+ - spec/models/legal_entity_name_bank_model_spec.rb
2916
2923
  - spec/models/patch_bank_bank_model_spec.rb
2917
2924
  - spec/models/patch_customer_bank_model_spec.rb
2918
2925
  - spec/models/patch_external_bank_account_bank_model_spec.rb
@@ -2921,6 +2928,7 @@ test_files:
2921
2928
  - spec/models/payment_instruction_bank_model_spec.rb
2922
2929
  - spec/models/payment_instruction_list_bank_model_spec.rb
2923
2930
  - spec/models/persona_session_bank_model_spec.rb
2931
+ - spec/models/physical_address_bank_model_spec.rb
2924
2932
  - spec/models/plan_bank_model_spec.rb
2925
2933
  - spec/models/plan_list_bank_model_spec.rb
2926
2934
  - spec/models/plan_travel_rule_info_bank_model_spec.rb