curl --request POST \
--url https://development.knotapi.com/session/create \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "card_switcher",
"external_user_id": "abc123",
"card_id": "81n9al10a0ayn13",
"email": "ada.lovelace@gmail.com",
"phone_number": "+11234567890"
}
'{
"session": "915efe72-5136-4652-z91q-d9d48003c102"
}Create Session
Create a session and use it to initialize the SDK.
curl --request POST \
--url https://development.knotapi.com/session/create \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "card_switcher",
"external_user_id": "abc123",
"card_id": "81n9al10a0ayn13",
"email": "ada.lovelace@gmail.com",
"phone_number": "+11234567890"
}
'{
"session": "915efe72-5136-4652-z91q-d9d48003c102"
}KnotConfiguration class of the SDK during initialization. Sessions last 30 minutes. To keep an open SDK session alive longer, call Extend Session when the SDK emits REFRESH_SESSION_REQUEST. It is best practice to create a new session each time you initialize the SDK and not log the session in any internal or 3rd party tooling.Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password. Use your client_id as the username and your secret as the password value.
Body
The input parameters required for creating a session.
Product to associate the session with.
card_switcher, transaction_link, link, vault "card_switcher"
Your unique identifier for the user.
"123abc"
Your unique identifier for a specific card. Required when type = card_switcher. Optionally accepted when type = vault.
"81n9al10a0ayn13"
Your unique identifier for a specific bank account. Only accepted when type = card_switcher. When provided, the user can switch a bank account instead of a card at supported merchants. card_id is still required.
"91n9al81da0k1yn13"
User's email address. When provided, Knot will automatically detect the user's online merchant accounts to personalize the experience in the SDK.
"ada.lovelace@gmail.com"
User's phone number in E.164 format. When provided, Knot will automatically detect the user's online merchant accounts to personalize the experience in the SDK.
"+11234567890"
Country of the user (ISO 3166-1 alpha-2, upper case). Determines which merchants are available in the session and is applied to the merchant accounts the user links in it. Omit the field to use your default country, which is US unless your account is set up for a single other country. A country that is not enabled for your account returns a 403.
US, CA "CA"
Plaid processor_token if using transaction data from Plaid to detect merchants.
Optional key-value pairs to include in webhook payloads. Maximum 10 keys, 500 characters per value.
Show child attributes
Show child attributes
{
"reference_token": "abc123",
"trace_id": "def456"
}
Response
Successful request.
A session.
"915efe72-5136-4652-z91q-d9d48003c102"
Was this page helpful?