Skip to main content
POST
/
detected-accounts
/
search
cURL
curl --request POST \
  --url https://development.knotapi.com/detected-accounts/search \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "external_user_id": "123abc",
  "names": [
    "Meta",
    "Uber",
    "johnson & johnson",
    "tiktok"
  ]
}
'
[
  {
    "name": "Meta",
    "detected": true,
    "detected_at": "2025-10-23T17:00:00Z"
  },
  {
    "name": "Uber",
    "detected": true,
    "detected_at": "2025-10-23T17:00:21Z"
  },
  {
    "name": "johnson & johnson",
    "detected": false,
    "detected_at": null
  },
  {
    "name": "tiktok",
    "detected": true,
    "detected_at": "2025-10-23T17:00:23Z"
  }
]

​
Overview

This endpoint allows you to search for detected accounts by providing a list of merchant or company names. For each name, the response indicates whether the user has a detected account. This is useful for developers with a predefined list of companies or offers who want to determine whether they apply to a given user. Call this endpoint upon receiving the NEW_DETECTED_ACCOUNTS_AVAILABLE webhook.

​
Usage

Detected accounts retrieved from this endpoint can be used to closely personalize the merchants you present to users in your app or through lifecycle marketing campaigns. For example, if a detected account at Uber is present for a user, you can more prominently display Uber to that user in your app or as a push notification/email. Moreover, aggregated detected account information can be useful in designing a rewards program or other product features throughout your app.

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 identifying a user's account at a merchant.

​
external_user_id
string
required

Your unique identifier for the user.

Example:

"123abc"

​
names
string[]
required

Array of merchant or company names for which you want to identify merchant accounts. Can be a single merchant name or multiple.

Example:
[
  "Meta",
  "Uber",
  "johnson & johnson",
  "tiktok"
]

Response

Successful request.

​
name
string

The value provided in name in the request.

Example:

"Meta"

​
detected
boolean

Whether a merchant account was detected for the user.

Example:

true

​
detected_at
string<date-time> | null

ISO timestamp when the merchant account was detected on the Knot platform.

Example:

"2025-10-23T17:00:00Z"