Platform Overview

TAPP Cash is a financial platform API that gives organizations programmatic control over the full banking lifecycle — covering role hierarchy, user types, environments, and key concepts from admin setup through client operations.

---

Role Hierarchy

TAPP Cash organizes users into two groups: admin roles that manage the organization and its clients, and client-facing roles that hold and operate financial accounts.

flowchart TD
    Root["Root Advisor"]
    HBM["Head Branch Manager"]
    BM["Branch Manager"]
    Advisor["Advisor"]
    Ind["Individual"]
    BO["Business Owner"]
    Op["Operator"]

    Root --> HBM
    Root --> BM
    HBM --> Advisor
    BM --> Advisor
    Advisor -->|invites| Ind
    Advisor -->|invites| BO
    BO -->|invites| Op

---

Admin Roles

---

Client-Facing Roles

---

User Lifecycle

flowchart TD
    A["Advisor signs in"]
    A --> B{"Invite client"}
    B -->|Individual| C["Individual accepts invite"]
    B -->|Business Owner| D["Business Owner accepts invite"]
    C --> E["Individual completes KYC"]
    D --> F["Business Owner completes KYB"]
    E --> G(["Individual accounts active"])
    F --> H(["Business accounts active"])
    H --> I["Business Owner invites Operators"]
    G --> J["Transfers, balances, notifications"]
    H --> J
    I --> J

---

Base URLs

Replace {tenant} with your organization's assigned tenant identifier. For example, if your tenant is acme:

POST https://api-acme.stage2.tappbank.com/users/public/v1/auth/signin

Contact [email protected] to obtain your tenant identifier and production credentials.

Staging shortcut: The shared test environment is available at https://api-test.stage2.tappbank.com — useful for initial exploration before your tenant is provisioned.

---

Selecting Your Tenant in the API Reference

When using the Try It feature in the API Reference pages, a server selector appears at the top of each endpoint. You must choose the correct server and enter your tenant identifier before sending requests.

1. Open any API Reference endpoint (e.g., Sign In).
2. Click the Server dropdown — it defaults to the shared staging URL.
3. Select Staging (custom tenant) or Production if your organization has a dedicated tenant.
4. Replace the {tenant} variable in the URL field with your tenant identifier (e.g., acme).
5. Add your Bearer token in the Authorization section.
6. Click Try It to send the request.

If you are just getting started and do not yet have a tenant, use the default staging server (https://api-test.stage2.tappbank.com) with the test credentials provided during onboarding.

---

API Versioning

Endpoints follow a versioned path pattern:

/{service}/{visibility}/v{version}/{resource}

---

Environments

Staging is for development and testing. Use test credentials and dummy data — no real money moves. Staging credentials will not work against the production base URL.

Production requires separate credentials issued by the TAPP Cash platform team. Contact [email protected] to request production access.