## Open-Source Risk Management Infrastructure
Documentation · Slack · Website · Contact · Issues

[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](https://makeapullrequest.com) [![GitHub release](https://img.shields.io/github/v/release/ballerine-io/ballerine?label=last-release&style=flat-square)](https://github.com/ballerine-io/ballerine/releases) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ballerine-io/ballerine/ci.yml?label=CI&style=flat-square)](https://github.com/ballerine-io/ballerine/actions/workflows/ci.yml) [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/ballerine-io/ballerine/release.yml?label=Release&style=flat-square)](https://github.com/ballerine-io/ballerine/actions/workflows/release.yml)

--- > ## ⚠️ Important Notice > > **The open source repository is currently undergoing a major rebuild and is not actively supported at this time.** > > **Stay tuned for updates!** > > **Interested in our SaaS version?** > - Join our [Slack workspace](https://join.slack.com/t/ballerine-oss/shared_invite/zt-1il7txerq-K0YrXtlzMttGgD3XXYxlfw) and ping anyone from the team > - Email us at **sales@ballerine.com** > > **Have questions about the OSS version?** > - Reach out to **oss@ballerine.com** > - Connect with us on our [Slack workspace](https://join.slack.com/t/ballerine-oss/shared_invite/zt-1il7txerq-K0YrXtlzMttGgD3XXYxlfw) --- 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**](https://docs.ballerine.com/en/learn/case_management_overview) - Case management dashboard for manual decision-making. - **Workflow Engine** - Orchestrates and automates the different system's parts. - [**KYB Collection Flow**](#modules) - Real-time modification of KYC/KYB frontend user journeys. - [**Rule Engine**](#modules) - Leverage various rule types to ensure user compliance with your risk policy. - [**Plugin System**](#modules) - Integrates with 3rd-party vendors, APIs, and databases. [see plugins](#modules). - **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: - Node.js ([Install NVM](https://github.com/nvm-sh/nvm), then install node "nvm install 21") - Latest PNPM version ([Install PNPM](https://pnpm.io/installation)) - Docker and docker compose ([Docker](https://docs.docker.com/desktop), [Docker Compose](https://docs.docker.com/compose/install)) 2. #### Clone and install the project: 1. Clone the project: ```sh git clone https://github.com/ballerine-io/ballerine.git ``` 2. Install npm dependencies: ```sh pnpm install ``` 3. Initialize monorepo: ```sh pnpm monorepo:init ``` 3. #### Run an example * KYB ```sh pnpm kyb-manual-review-example ``` * KYC ```sh pnpm kyc-manual-review-example ``` Once the process is complete, _2 tabs_ will open in your browser: 1. Document Collection Flow: - KYB: [http://localhost:5201/](http://localhost:5201/) - KYC: [http://localhost:5202](http://localhost:5202) 2. Back Office: [http://localhost:5137/](http://localhost:5137/) _(It's recommended to position both tabs side-by-side)_ > **Note:** If the tabs don't open automatically, use the links above. ### Flow Instructions 1. **Access the Back Office** - Sign in using: ``` Email: admin@admin.com Password: admin ``` - Navigate to "KYB with UBOs" under the business menu to view ongoing cases 2. **Complete the Collection Flow** - Fill out all required fields in each step - The Back Office case will update as you progress 3. **Review & Process** - Once complete, the case status changes to "manual review" - Assign the case to yourself - Choose to: Approve, Reject, or Request Resubmission 4. **Document Resubmission** - Request a document resubmission - Return to collection flow to upload new document - Check Back Office for 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: - Give us feedback in our [Slack community](https://join.slack.com/t/ballerine-oss/shared_invite/zt-1il7txerq-K0YrXtlzMttGgD3XXYxlfw) - Help with bugs and features on [our Issues page](https://github.com/ballerine-io/ballerine/issues) - Submit a [feature request](https://github.com/ballerine-io/ballerine/issues/new?assignees=&labels=enhancement%2C+feature&template=feature_request.md) or [bug report](https://github.com/ballerine-io/ballerine/issues/new?assignees=&labels=bug&template=bug_report.md) ## Contact Ballerine To start using the paid version or if you need any assistance, reach out to us at oss@ballerine.com. Join our [Discord Channel](https://discord.gg/e2rQE4YygA) and [Slack Channel](https://join.slack.com/t/ballerine-oss/shared_invite/zt-1il7txerq-K0YrXtlzMttGgD3XXYxlfw) to stay updated and engage with our community.