Platform Overview

TAPP Cash is a multi-tenant financial platform. Every integration involves two distinct roles working together: an Account Manager who administers a portfolio of individuals, and Individual Users who hold accounts and move money.

User Roles

Role	Also called	What they do
Account Manager	Advisor	Signs in, manages a branch portfolio, sends invitations, monitors onboarding status
Individual User	Individual	Holds financial accounts, completes onboarding, initiates transfers, views transactions

Your API credentials are scoped to one role. Calling an endpoint outside your role returns 403 Forbidden.

The User Lifecycle

Account Manager signs in
        ↓
Manager invites individual (POST /branches/private/v1/individual)
        ↓
Individual receives email → completes onboarding (Steps 1–10)
        ↓
Individual exchanges temporary token for full access token
        ↓
Individual uses banking features (accounts, transfers, notifications)

Base URLs

Environment	Base URL
Staging	`https://api-test.stage2.tappbank.com`
Production	Contact [email protected]

All API paths are appended to the base URL. Example:

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

API Versioning

Endpoints follow a versioned path pattern:

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

Segment	Example	Meaning
`service`	`users`, `branches`, `accounts`	Microservice owning the resource
`visibility`	`public`, `private`	Public = no auth; Private = Bearer token required
`version`	`v1`	API version
`resource`	`auth/signin`, `individual`	Resource path

Rate Limits

The staging environment enforces standard rate limits. If you receive 429 Too Many Requests, back off and retry with exponential backoff. Contact support for production rate limit details.

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.