To get started with Truv, we recommend following a step-by-step walkthrough in our docs https://docs.truv.com/docs/quickstart-guide

1. Clone the repository

git clone https://github.com/truvhq/quickstart.git

2. Open quickstart directory and create .env file:

cd quickstart
make env

3. Update the values in .env file by adding in your Client ID and Sandbox Access key:

# please set your <Client ID>
API_CLIENT_ID=

# please set your <Access key>
API_SECRET=

# optional: set to false to use Users API instead of Embedded Orders API
IS_ORDER=true

Note about Orders API: The default flow uses the Orders API for income and employment products, designed for home lending and social services use cases where multiple employer connections are expected. Set IS_ORDER=false for a single connection flow. The deposit_switch and pll products always use the single connection flow.

4. Run all-in-one docker-compose

docker-compose up

or run specific image

make [python_docker|ruby_docker|golang_docker|node_docker|csharp_docker]

5. Check the quickstart demo for your programming language:

• http://localhost:5001 Python
• http://localhost:5002 Ruby
• http://localhost:5003 Go
• http://localhost:5004 Node.Js
• http://localhost:5005 C#

To receive Truv webhooks locally, use ngrok to expose your local server:

ngrok http <port>

Where <port> matches the language you are running (e.g. 5001 for Python, 5004 for Node.js). Copy the forwarding URL and set https://<your-subdomain>.ngrok.io/webhook as the webhook URL in the Truv Dashboard.