Home

Awesome

<div align="right"> <img src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/6463b137c0fec38f87389eb6_star_AdobeExpress%20(2).gif" alt="Alt Text" style="width: 100%; height: auto;"> </div> <div align="center"> <a href="https://ballerine.com" title="Ballerine - Open-source Infrastructure for Identity and Risk management."> <img src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/646372b198f456345c69339c_logo%20github.png" alt="Ballerine's website"> </a>

Open-Source Infrastructure for User Risk Decisioning

</br> <!-- Nav header - Start -->

<a href="https://join.slack.com/t/ballerine-oss/shared_invite/zt-1iu6otkok-OqBF3TrcpUmFd9oUjNs2iw">Slack</a><a href="https://www.ballerine.com/">Website</a><a href="#contact-ballerine">Contact</a><a href="https://github.com/ballerine-io/ballerine/issues">Issues</a>

<!-- Nav header - END --> <!-- Badges - Start -->

<a href="https://github.com/ballerine-io/ballerine/stargazers"><img src="https://img.shields.io/github/stars/ballerine-io/ballerine?logo=GitHub&style=flat-square"></a> <a href="https://discord.gg/e2rQE4YygA"><img src="https://img.shields.io/website?color=%237289DA&down_color=%237289DA&down_message=Join&label=Discord&logo=discord&logoColor=white&style=flat-square&up_color=%237289DA&up_message=Join&url=https%3A%2F%2Fdiscord.gg%2Fe2rQE4YygA"></a> <a href="https://join.slack.com/t/ballerine-oss/shared_invite/zt-1iu6otkok-OqBF3TrcpUmFd9oUjNs2iw"><img src="https://img.shields.io/website?color=%23441949&down_color=%23441949&down_message=Join&label=Slack&logo=slack&logoColor=white&style=flat-square&up_color=%23441949&up_message=Join&url=https%3A%2F%2Fjoin.slack.com%2Ft%2Fballerine-oss%2Fshared_invite%2Fzt-1iu6otkok-OqBF3TrcpUmFd9oUjNs2iw"></a> <a href="https://twitter.com/ballerine_io"><img src="https://img.shields.io/website?color=%231DA1F2&down_color=%231DA1F2&down_message=Follow&label=Twitter&logo=twitter&logoColor=%231DA1F2&style=flat-square&up_color=%231DA1F2&up_message=%40ballerine.io&url=https%3A%2F%2Ftwitter.com%2FBallerine_io"></a> <a href="https://ycombinator.com"><img src="https://img.shields.io/website?color=%23f26522&down_message=Y%20Combinator&label=Backed&logo=ycombinator&style=flat-square&up_message=Y%20Combinator&url=https%3A%2F%2Fwww.ycombinator.com"></a> PRs Welcome GitHub release GitHub Workflow Status GitHub Workflow Status

</p> <!-- Badges - END --> </div>

Ballerine is an open-source user risk decisioning infrastructure that helps companies automate their decisions for customer and business 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.

<br/> <div align="center"> <img src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/646375ed9f42af409c55f316_main%20gif%20optimized.gif" alt="Alt Text" style="width: 100%; height: auto;"> </div> <br/>

Our vision for this project

Watch a brief video explaining what we're building.

Watch now

<br/> <a href="https://youtu.be/0SppYSZOatw" title="Ballerine Demo"> <img src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/646cb35bbee1708f66aa223a_vision%20thumbnail.png" alt="Demo video"> </a>

Features

View each component's current state in the roadmap below.

Released - 馃帀

In Development/testing - 馃敤

Planned on roadmap - 馃搶

Community driven building blocks - 馃實

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

Try Ballerine Now

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

  1. Document collection flow controlled by our Headless SDK.
  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:

Demo example video

Watch a video of how the demo works, with explanations: Watch now

<br/> <a href="https://youtu.be/EzBXhUM7gb8" title="Ballerine Demo"> <img src="https://uploads-ssl.webflow.com/62a3bad46800eb4715b2faf1/646b32fd3d69c9698cd511a1_vid%20thumbnail.png" alt="Demo video"> </a> <br/> <br/>

Getting started

To set up a local environment, follow these steps:

  1. Install prerequisites:

  2. Clone and install the project:

    1. Clone the project:
    git clone https://github.com/ballerine-io/ballerine.git
    
    1. Install npm depenencies:
    pnpm install
    
    1. Initilazie monorepo:
    pnpm monorepo:init
    
  3. Run the example

    pnpm kyc-manual-review-example
    

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

  1. http://localhost:5173/ - for the document collection flow
  2. http://localhost:5137/ - for the backffice (It's recommended to have them positioned side-by-side).
KYB Manual Review Workflow:

The following command will run the workflow's backend (workflow service API), the backoffice, and UI example using the headless web SDK:

pnpm kyb-manual-review-example

<sub>If the tabs have not opened automatically, please use the links provided above.</sub>

Steps to go over the flow:

  1. On the KYC UI, click the "Start KYC" button
  2. Go through and complete the flow
  3. Go to the backoffice tab to review the new user that was created
  4. Approve/reject/ask to revision
  5. Get back to the KYC UI to see the result

*Note: some components are currently in beta, if you run into an issue please ping us on Slack <br/>

To start using the paid version or if you need any assistance, reach out to us at oss@ballerine.com. Join our Discord Channel and Slack Channel to stay updated and engage with our community.

Contributing

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

Roadmap

High level roadmap

Back office

Plugin system

Workflow engine

Rule engine

Frontend headless SDK

User flows UX/UI

We will soon release our full long-term roadmap to the public. Follow this project to stay informed about when we provide updates.

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 and Slack Channel to stay updated and engage with our community.