Skip to content

Latest commit

 

History

History
139 lines (107 loc) · 8.23 KB

README.md

File metadata and controls

139 lines (107 loc) · 8.23 KB
Raw
Alt Text
Ballerine's website

Open-Source Risk Management Infrastructure


Documentation · Slack · Website · Contact · Issues

PRs Welcome GitHub release GitHub Workflow Status GitHub Workflow Status

Ballerine is an Open-Source Risk Management Infrastructure that helps global payment companies, marketplaces and Fintechs to automate their decisions for merchant, sellers and users throughout the customer lifecycle. From account-opening (KYC, KYB), underwriting, and transaction monitoring, using a flexible rules & workflow engine, 3rd party plugin system, manual review back office, and document & information collection frontend flows.


Modules

  • Back Office - Case management dashboard for manual decision-making.
  • Workflow Engine - Orchestrates and automates the different system's parts.
  • KYB Collection Flow - Real-time modification of KYC/KYB frontend user journeys.
  • Rule Engine - Leverage various rule types to ensure user compliance with your risk policy.
  • Plugin System - Integrates with 3rd-party vendors, APIs, and databases. see plugins.
  • No-Code Builder - Leverage various rule types to ensure user compliance with your risk policy - 🚧 WIP.

Why Open Source?

We believe in enabling companies to manage user identity and risk according to their unique and evolving requirements. Ballerine empowers you to create decisioning processes that are right for you. It is flexible, future-proof, easy to implement, secure, and supported by a robust community.

Explore What You Can Do With Ballerine

  • Dynamic Experience: Adaptive user journeys that modify in real-time based on the user's risk.
  • Data Ownership: Self-host on-premise to keep sensitive data within your infrastructure.
  • Global Orchestration: Add/change vendors and data sources to cater to users from multiple countries.
  • Cost Reduction: Retain control over vendor relationships, costs, and communication.
  • And More.

Try Ballerine Now

In the following example you can test a simple form of the following infrastructure capabilities

  1. Document collection flow.
  2. A manual review case management Back Office.
  3. Live communication between the parts using a Workflow Engine, that also defines the process steps.
  4. A simple JSON containing Risk Rules that are checked during the flow.

Parts of the system you might look for but are not in THIS demo:

  • Our Rule Engine is still under construction and will soon be released.

Getting started

To set up a local environment, follow these steps:

  1. Install prerequisites:

    1.1. Node.js (Install NVM)

    1.2. Latest PNPM version (Install PNPM)

    1.3. Docker and docker compose (Docker, Docker Compose)

  2. Clone and install the project:

    2.1. Clone the project:

    git clone https://github.com/ballerine-io/ballerine.git

    2.2. Install npm dependencies:

    pnpm install

    2.3. Initialize monorepo:

    pnpm monorepo:init

  3. Run an example

    3.1. KYB

    pnpm kyb-manual-review-example

    3.2. KYC

    pnpm kyc-manual-review-example

Once the process is complete, 2 tabs will open in your browser:

  • http://localhost:5173/ - for the KYB document collection flow OR http://localhost:5202 - for the KYC document collection flow

  • http://localhost:5137/ - for the backoffice (It's recommended to have them positioned side-by-side).

    If the required tabs have not opened automatically, please use the links we have provided above.

    Steps to go over the flow:

  1. On the collection flow, fill the required fields on each step
  2. Go through and complete the flow
  3. Go to the backoffice tab to review the new user that was created
  4. Sign-in with the following credentials:
  5. Approve / Reject / Ask to resubmit
  6. For ask to resubmit, go back to the collection flow to re-upload, then go back to the backoffice to see the updated information
  • Note: some components are currently in beta, if you run into an issue please ping us on Slack

Contributing

We appreciate all types of contributions and believe that an active community is the secret to a rich and stable product. Here are some of the ways you can contribute:

Contact Ballerine

To start using the paid version or if you need any assistance, reach out to us at [email protected]. Join our Discord Channel and Slack Channel to stay updated and engage with our community.