Documentation Index
Fetch the complete documentation index at: https://guide.cloud.blnkfinance.com/llms.txt
Use this file to discover all available pages before exploring further.
This feature is in private beta. If you want access, please contact Support.
About Custom Apps
A Custom App is a third-party app that can be installed and used inside Blnk Cloud. It can read data from a selected Cloud instance, perform actions through Cloud APIs, connect to external systems, and show a custom interface inside the Cloud dashboard. For example, consider a KYC review workflow. Typically, this would involve managing data across Blnk identities, a KYC provider, internal spreadsheets, manual notes, etc. With a Custom App, that review flow can live inside Cloud, closer to the ledger.Start with a clear workflow
Before writing code, define the workflow your app should support:Describe your app in one sentence
The best Custom Apps are focused. They help a team complete one job inside Cloud instead of trying to become a large internal system.For our KYC app, its job is:
KYC app description
Map your workflow
From there, map the work the app needs to handle. Here’s the workflow for our KYC app:
This gives the app a clear boundary of what the workflow is responsible for and what should happen at each step.
| Step | What the app needs to do |
|---|---|
| Read records | Fetch identities from the selected Cloud instance. |
| Run a check | Send identity details to a KYC provider or internal review service. |
| Save the result | Write the KYC status back to the identity metadata. |
| Flag exceptions | Create an alert when an identity needs manual review. |
| Show progress | Display reviewed identities, statuses, and action logs inside the app portal. |
Run the example KYC app
Open the demo repository and follow its README to run the KYC example app this documentation is built around.