Introduction

Integrating Knot is quite simple. You'll need a basic client-side and server-side integration, including calling the API, initializing the SDK, and subscribing to webhooks.

Steps

1. Access Customer Dashboard: Ensure you have access to your Customer Dashboard.
2. Authenticate to API: From your Customer Dashboard, retrieve you client_id and secret for the development environment. You'll use these as API keys to authenticate to the API. You can read more about authentication here.
3. Allowlist Domains (Web-Only): If you are using the JS SDK, allowlist your domains for the development environment and production environment in your Customer Dashboard.
4. Install SDK: Install and import an SDK of your choosing, for example on iOS here.
5. Get Session: Call Create Session to create a session for a user. You will use this to initialize the SDK. You can also see all of your requests in your Customer Dashboard.
6. Initialize SDK: Initialize the SDK with the session_id retrieved from Create Session. The SDK is where users will interact with the Knot UI to authenticate to various merchants. All login flows, including step-up authentication, are handled with the SDK. Users will see real-time feedback as they progress through authenticating with a merchant
7. Handle Callbacks: Handle SDK callbacks to be notified on the frontend when a user closes the SDK, encounters an error, and for additional events (e.g. the session needs to be refreshed).
8. Receive Webhooks: Subscribe to receive webhooks so your backend can be notified about the user's lifecycle in authenticating to a merchant, as well as various other events in real-time.
9. Switch Card: If you are integrating Knot's CardSwitcher product, call Switch Card immediately after receiving the AUTHENTICATED webhook to switch the user's card in the merchant.
   1. Alternatively, you can call Switch Card (JWE) with a JWE instead. If you prefer this method, let the Knot team know your intent.