Skip to main content
POST
/
api
/
v3
/
applicants
/
{applicant_id}
/
search-options
Change Applicant Search Options
curl --request POST \
  --url https://api.dataspike.io/api/v3/applicants/{applicant_id}/search-options \
  --header 'Content-Type: application/json' \
  --header 'ds-api-token: <api-key>' \
  --data '{
  "risk_scores": [
    "Low"
  ],
  "tags": [
    "Finance"
  ],
  "sources": [
    "<string>"
  ],
  "fuzziness": true,
  "fuzziness_level": 1,
  "phonetics": true,
  "mode": 0
}'

Authorizations

​
ds-api-token
string
header
required

Path Parameters

​
applicant_id
string<uuid>
required

Search Options Applicant ID

Example:

"01827ed4-c928-7a3c-9a30-7ab7cc169d11"

Body

application/json

Search Options Applicant Request

The Search Options functionality is intended for the customization of applicant AML monitoring

​
risk_scores
enum<string>[] | null
​
tags
enum<string>[] | null
​
sources
string[] | null

Possible Source IDs, contains all publicly available sources, constantly updated, for the most up to date list please check https://dash.dataspike.io/pep-sanctions/data-sources

​
fuzziness
boolean | null
default:true

A boolean flag (True/False). When set to True (default), broad matches are allowed. If set to False, only exact matches are permitted.

​
fuzziness_level
number | null
default:1

Controls the strictness of name matching. 0 means exact match, 1 means broad match. Recommended value is 1. Intermediate values (e.g., 0.5) can be used to fine-tune the balance between precision and scope.

Required range: 0 <= x <= 1
​
phonetics
boolean | null
default:true

This setting enables phonetic similarity during AML searches, which is helpful for finding similar names across different languages. We generally recommend keeping this set to True.

​
mode
enum<integer> | null
default:0

0 - AUTO(Recommended), Automatically optimize query - full_name serves as the primary search term, unless both the first and last names are provided. In such a scenario, the combination of the first and last names becomes the primary term, and the full_name is employed to enhance the relevance of results.

1 - FULL_NAME_ONLY, ignores first_name and last_name fields, and only use full_name in search requests

2 - FIRST_AND_LAST_NAMES_ONLY, ignores full_name field and uses only combination of first_name and last_name in search requests

Available options:
0,
1,
2

Response

200

Search Options Applicant Response