Skip to main content
The quickstart repo runs a complete Truv integration end-to-end: create a user, launch Bridge, receive webhooks, and fetch reports. Available in five server-side languages, plus separate iOS and Android apps.

Setup

Prerequisites

Clone and configure

git clone https://github.com/truvhq/quickstart.git
cd quickstart
make env
Open .env and add your credentials from the Dashboard API Keys page:
API_CLIENT_ID=your_client_id
API_SECRET=your_secret
Set IS_ORDER=true to use the Orders API instead of the Users API. The Orders API lets you pre-configure employer and account information.
The quickstart also supports API_PRODUCT_TYPE values such as income, employment, deposit_switch, pll, and admin. Choose the product flow you want to exercise before starting the app.

Environments

All environments use the same base URL: https://prod.truv.com/v1/. Your credentials determine which environment you’re using.
EnvironmentPurpose
SandboxTest with sandbox credentials and simulated providers
ProductionLive user traffic and billed activity

Languages and repos

Server-side quickstarts

LanguageRepoPort
Node.jsquickstart/node5004
Pythonquickstart/python5001
Rubyquickstart/ruby5002
Goquickstart/golang5003
C#quickstart/c-sharp5005

Webhooks with ngrok

To receive webhooks locally, start ngrok in a separate terminal:
ngrok http 3001
Copy the forwarding URL into .env:
NGROK_URL=https://xxxx-xxxx-xxxx.ngrok-free.app
Restart the app. It automatically registers a sandbox webhook and cleans it up on exit.

Run

Pick your language and run with Docker:
make node_docker     # http://localhost:5004
make python_docker   # http://localhost:5001
make ruby_docker     # http://localhost:5002
make golang_docker   # http://localhost:5003
make csharp_docker   # http://localhost:5005
To run all languages simultaneously: docker-compose up

Providers and credentials

Sandbox data

Use goodlogin / goodpassword to test a standard login flow, or goodlogin / mfa (MFA code: 12345) to test the MFA flow. See Test Credentials for all scenarios including error states, pay frequencies, and financial accounts.