General
- Introduction
- Webhooks
- Launch Checklist
- Dashboard
SDK
- Introduction
- iOS
- Android
- React Native
- Flutter
- Web
- Migration Guides
CardSwitcher
- Quickstart
- Webhook Events
- Testing
- Sending Card Data
- Direct Processor Integrations
- MassSwitcher (Beta)
- Plaid Integration
TransactionLink
Merchant Account Linking
Quickstart
Introduction
Integrating Knot is quite simple. You’ll need a basic client-side and server-side integration, including calling the API, invoking the SDK, and subscribing to webhooks.
Start the Flow
Ensure you have access to your Customer Dashboard and retrieve your API keys: client_id
and secret
.
With your client_id
and secret
for the development
environment, call Create Session to create a session used when invoking the SDK.
Install and import an SDK of your choosing, for example on iOS here. If you are using the Web SDK, make sure to allowlist your application’s domains for the development
and production
environments in your Customer Dashboard.
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.
Handle Events
Handle onSuccess
, onError
, onExit
, and onEvent
SDK callbacks to be notified of client-side events.
Subscribe to webhooks so your backend can be notified about user-generated events, as well as asynchronous processes.
Switch a Card
Post card information to Switch Card or Switch Card (JWE) within 15 seconds when you receive the AUTHENTICATED
webhook, fired after a user authenticates to a merchant account. You can read more about sending card data to Knot here.
Was this page helpful?