Skip to main content

​
Introduction

Detect enables you to identify a user’s online merchant accounts and retrieve them from the Knot platform, allowing you to then personalize your user experience.

​
Getting started

If you’ve already integrated another of Knot’s products, rather than implementing any of the below, simply provide a user’s email & phone # when calling Session Create to take advantage of Detect.
1

Access your dashboard

Ensure you have access to the Knot Dashboard and retrieve your client_id and secret to create an API key. Learn more about creating an API key and authentication to the API here.
2

Call the API

Call Detect Accounts with the user’s email and phone_number to detect their online merchant accounts.
3

Handle webhook events

Subscribe to webhooks in the Knot Dashboard so your backend can be notified about server-side events. Listen for the NEW_DETECTED_ACCOUNTS_AVAILABLE webhook event to be notified when new detected accounts have been found for a given user.
4

Sync detected accounts

When you receive the NEW_DETECTED_ACCOUNTS_AVAILABLE webhook, call Sync Detected Accounts to retrieve the detected accounts.In the development environment, this endpoint returns 6 mock detected accounts generated for a given user.