Skip to main content
POST
/
api
/
v3
/
aml
/
search
Search
curl --request POST \
  --url https://api.dataspike.io/api/v3/aml/search \
  --header 'Content-Type: application/json' \
  --header 'ds-api-token: <api-key>' \
  --data '
{
  "full_name": "Grace MUGABE",
  "first_name": "Grace",
  "last_name": "MUGABE",
  "countries": [
    "ZW"
  ],
  "cities": [],
  "postal_codes": [],
  "date_of_birth": {
    "gte": "1987-12-24T00:00:00.000Z",
    "lte": "1987-12-24T00:00:00.000Z"
  },
  "risk_scores": [
    "High"
  ],
  "tags": [
    "Sanctions"
  ],
  "entity_types": [
    "Person"
  ],
  "sources": [],
  "fuzziness": true,
  "fuzziness_level": 1,
  "phonetics": true,
  "registration_ids": [],
  "mode": "AUTO",
  "gender": "<string>",
  "search_kyb": true
}
'
{
  "requested_name": "<string>",
  "search_uuid": "<string>",
  "max_risk_score": "Low",
  "data": [
    {
      "uuid": "<string>",
      "type": "Person",
      "annotation": "<string>",
      "tags": [
        "Finance"
      ],
      "risk_score": "Low",
      "fields": {
        "names": [
          {
            "full_name": "<string>",
            "first_name": "<string>",
            "last_name": "<string>",
            "middle_name": "<string>",
            "lang": "<string>"
          }
        ],
        "sources": [
          {
            "source_id": "<string>",
            "name": "<string>",
            "reason": "<string>",
            "summary": "<string>",
            "source_url": "<string>",
            "risk_score": "Low",
            "tags": [
              "Finance"
            ]
          }
        ],
        "media": [
          {
            "source_name": "<string>",
            "source_url": "<string>",
            "headline": "<string>",
            "summary": "<string>",
            "published_at": 123,
            "risk_score": "Low",
            "importance_score": 123,
            "sentiment": 123,
            "tags": [
              "Finance"
            ],
            "country_codes": [
              "<string>"
            ]
          }
        ],
        "images": [
          {
            "description": "<string>",
            "url": "<string>"
          }
        ],
        "contact_info": [
          {
            "emails": [
              "<string>"
            ],
            "phones": [
              "<string>"
            ],
            "websites": [
              "<string>"
            ]
          }
        ],
        "registration_ids": [
          {
            "id": "<string>",
            "id_type": "<string>",
            "date": "2023-12-25",
            "industry": "<string>",
            "country": "<string>",
            "imo_number": "<string>",
            "mmsi_number": "<string>",
            "currency": "<string>"
          }
        ],
        "addresses": [
          {
            "country": "<string>",
            "region": "<string>",
            "city": "<string>",
            "postal_code": "<string>",
            "address": "<string>"
          }
        ],
        "genders": [
          "Male"
        ],
        "dates_of_birth": [
          {
            "gte": "1987-12-24T00:00:00.000Z",
            "lte": "1987-12-24T00:00:00.000Z"
          }
        ],
        "places_of_birth": [
          {
            "country": "<string>",
            "region": "<string>",
            "city": "<string>",
            "postal_code": "<string>",
            "address": "<string>"
          }
        ],
        "dates_of_death": [
          {
            "gte": "1987-12-24T00:00:00.000Z",
            "lte": "1987-12-24T00:00:00.000Z"
          }
        ],
        "places_of_death": [
          {
            "country": "<string>",
            "region": "<string>",
            "city": "<string>",
            "postal_code": "<string>",
            "address": "<string>"
          }
        ],
        "citizenships": [
          "<string>"
        ],
        "nationalities": [
          "<string>"
        ],
        "political_roles": [
          {
            "role": "<string>",
            "country": "<string>"
          }
        ],
        "occupations": [
          {
            "occupation": "<string>",
            "country": "<string>"
          }
        ],
        "companies_and_enterprises": [
          {
            "name": "<string>",
            "reference": "<string>",
            "role": "<string>",
            "country": "<string>",
            "start_date": {
              "gte": "1987-12-24T00:00:00.000Z",
              "lte": "1987-12-24T00:00:00.000Z"
            },
            "end_date": {
              "gte": "1987-12-24T00:00:00.000Z",
              "lte": "1987-12-24T00:00:00.000Z"
            },
            "ownership_value": "<string>",
            "currency": "<string>",
            "ownership_percentage": "<string>",
            "additional_source": {
              "source_id": "<string>",
              "name": "<string>",
              "reason": "<string>",
              "summary": "<string>",
              "source_url": "<string>",
              "risk_score": "Low",
              "tags": [
                "Finance"
              ]
            }
          }
        ],
        "owners_and_beneficiaries": [
          {
            "name": "<string>",
            "reference": "<string>",
            "role": "<string>",
            "country": "<string>",
            "start_date": {
              "gte": "1987-12-24T00:00:00.000Z",
              "lte": "1987-12-24T00:00:00.000Z"
            },
            "end_date": {
              "gte": "1987-12-24T00:00:00.000Z",
              "lte": "1987-12-24T00:00:00.000Z"
            },
            "ownership_value": "<string>",
            "currency": "<string>",
            "ownership_percentage": "<string>",
            "additional_source": {
              "source_id": "<string>",
              "name": "<string>",
              "reason": "<string>",
              "summary": "<string>",
              "source_url": "<string>",
              "risk_score": "Low",
              "tags": [
                "Finance"
              ]
            }
          }
        ],
        "associates": [
          {
            "uuid": "<string>",
            "name": "<string>",
            "start_date": {
              "gte": "1987-12-24T00:00:00.000Z",
              "lte": "1987-12-24T00:00:00.000Z"
            },
            "end_date": {
              "gte": "1987-12-24T00:00:00.000Z",
              "lte": "1987-12-24T00:00:00.000Z"
            },
            "relationship": "<string>",
            "is_relative": true
          }
        ],
        "fatf_records": [
          {
            "fatf_status": "FatfMember",
            "url": "<string>",
            "description": "<string>",
            "country": "<string>"
          }
        ]
      },
      "updated_at": 123,
      "importance_score": 123
    }
  ],
  "fatf_records": [
    {
      "fatf_status": "FatfMember",
      "url": "<string>",
      "description": "<string>",
      "country": "<string>"
    }
  ]
}

Authorizations

​
ds-api-token
string
header
required

Body

application/json

AML Search

AML Search request

​
full_name
string
required

The full_name is a mandatory field and 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.

Example:

"Grace MUGABE"

​
first_name
string

This optional field serves to optimize the overall search experience when both first_name and last_name are provided.

Example:

"Grace"

​
last_name
string

This optional field serves to optimize the overall search experience when both first_name and last_name are provided.

Example:

"MUGABE"

​
countries
string[]

ISO 3166-1 alpha-2 country codes

Example:
["ZW"]
​
cities
string[]
​
postal_codes
string[]
​
date_of_birth
object

Date range, represented as a pair of dates in ISO 8601 format

​
risk_scores
enum<string>[]

Assigned Risk Score

Available options:
Low,
Medium,
High
Example:
["High"]
​
tags
enum<string>[]

Possible Entity Tags

Available options:
Finance,
Legal,
Terrorism,
Criminal,
PEP,
Media,
Social,
Sanctions,
UnofficialSource,
Leaks,
CompanyRegistry,
Associate,
Debarred,
PublicInterest,
RegulatoryWarning
Example:
["Sanctions"]
​
entity_types
enum<string>[]

Possible types

Available options:
Person,
Organization,
Country,
Vessel,
Aircraft,
CryptoWallet
Example:
["Person"]
​
sources
string[]

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
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<double> | 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
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.

​
registration_ids
string[]
​
mode
enum<string>
default:AUTO

Controls how name fields are used for matching.

  • AUTO — automatically determine the best matching strategy.
  • FULL_NAME_ONLY — use only the full_name field.
  • FIRST_AND_LAST_NAME_ONLY — use only the first_name and last_name fields.
Available options:
AUTO,
FULL_NAME_ONLY,
FIRST_AND_LAST_NAME_ONLY
​
gender
string

Filter results by gender (e.g. Male, Female, Other)

​
search_kyb
boolean

When set to true, also search KYB (company) databases in addition to individual records.

Response

200 - application/json

AML Search Result

​
requested_name
string
​
search_uuid
string

Search id, could be use later to fetch the existing search result

​
max_risk_score
enum<string>

Assigned Risk Score

Available options:
Low,
Medium,
High
​
data
object[]
​
fatf_records
object[]

FATF (Financial Action Task Force) records for countries referenced in search results