Detect Accounts

Detect merchant accounts with a user’s email.

POST /detect

cURL

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": "[e-mail]",
  "phone_number": "[phone]"
}
'

202

Example

{
  "message": "Success"
}

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:

"[e-mail]"

phone_number · string

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

Example:

"[phone]"

Response

202

application/json

Successful request.

message · string

Success message.

Example:

"Success"