Skip to main content
POST
Create Knot Zero Link

Authorizations

Authorization
string
header
required

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

application/json

The parameters to include in the user's link.

type
enum<string>
required

Product to associate the link with.

Available options:
card_switcher
Example:

"card_switcher"

phone_number
string
required

User's phone number in E.164 format. Must be a valid US or Canadian phone number. Knot sends a one-time code to this number to verify the user each time they open the link.

Example:

"+12025550123"

external_user_id
string
required

Your unique identifier for the user.

Maximum string length: 256
Example:

"123abc"

card_id
string
required

Your unique identifier for the user's card.

Maximum string length: 256
Example:

"81n9al10a0ayn13"

Response

Successful request.

The Knot Zero link for the user: your base link with a unique token appended that references the user's stored parameters. Share it as a URL or encode it as a QR code. The link can be opened any number of times, with a new one-time code each time, and expires after 1 year. It stops working earlier if you create a new link for the same user and card, or revoke it.

Example:

"https://clip.knotapi.com/switch?token=example_knot_zero_token_1xxxxxxxxxxxxxxxxxx"

token
string

The unique token in link, returned separately so you don't need to parse it from the link.

Example:

"example_knot_zero_token_1xxxxxxxxxxxxxxxxxx"