Skip to main content
POST
/
detect
cURL
curl --request POST \
  --url https://development.knotapi.com/detect \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_user_id": "123abc",
  "email": "jane@example.com",
  "phone_number": "+14155551234"
}
'
{
  "message": "Success"
}

Documentation Index

Fetch the complete documentation index at: https://docs.knotapi.com/llms.txt

Use this file to discover all available pages before exploring further.

After calling this endpoint, listen for the NEW_DETECTED_ACCOUNTS_AVAILABLE webhook event which will fire if any detected accounts are found. This may take up to 1 minute.

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 input parameters required for detecting a user's merchant accounts.

​
external_user_id
string
required

Your unique identifier for the user.

Example:

"123abc"

​
email
string
required

The user's email address.

Example:

"jane@example.com"

​
phone_number
string

The user's phone number in E.164 format. Optional.

Example:

"+14155551234"

Response

Successful request.

​
message
string

Success message.

Example:

"Success"