Getting Started

Welcome to Taffrail

Taffrail provides personalized, compliant financial advice for brokerages and banks through a deterministic Rules Engine. Integrate Taffrail into your application via our API, embed widget, or hosted AdviceLink.

Quickstart

Make your first API call in three steps:

1. Get your API key from Advice Builder or contact us.

2. Call the Advice API:

curl -X GET "https://engine-staging.taffrail.com/api/advice/TFU3nYztaJ8yxgNGQkGsP7k" \
  -H "Authorization: Bearer <YOUR_API_KEY>" \
  -H "Accept: application/vnd.taffrail.json+html" \
  -H "Taffrail-Version: 2"

3. Get your response:

{
  "id": "393v-NbKSn5yguFu_OrJN",
  "data": {
    "advice": [
      {
        "headline": "Congratulations, your configuration is setup!",
        "headline_html": "<p>Congratulations, your configuration is setup!</p>\n",
        "summary": "Browse the library of Advice Rules and start integrating with our API.",
        "type": "ADVICE"
      }
    ],
    "adviceset": {
      "id": "TFU3nYztaJ8yxgNGQkGsP7k",
      "title": "API Testing only"
    }
  }
}

See the full Hello World recipe for JavaScript, Python, and detailed response walkthrough.

Integration Options

Advice Embed — Paste one line of code into your website or CMS. The simplest way to get started.
Advice API — Build custom integrations with full control over the user experience.
AdviceLink — A branded, hosted web page for your advice content. Contact us for details.

Next Steps

Authentication — Set up your API key.
Environments — Understand staging and production endpoints.
Headers — Required request and response headers.
Advice Content Types — Choose the right response format.
Taffrail User Experience — Understand chips, Backlinks, and how users interact with Advice.

Questions? Contact our support team or visit our support site.