Historical Search Report

curl --request GET \
  --url https://api.dataspike.io/api/v3/aml/search/history/{id} \
  --header 'ds-api-token: <api-key>'

{
  "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>"
          }
        ],
        "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>"
          }
        ],
        "owners_and_beneficiaries": [
          {
            "name": "<string>",
            "reference": "<string>",
            "role": "<string>",
            "country": "<string>"
          }
        ],
        "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
          }
        ]
      },
      "updated_at": 123,
      "importance_score": 123
    }
  ]
}

GET

api

aml

history

{id}

Historical Search Report

curl --request GET \
  --url https://api.dataspike.io/api/v3/aml/search/history/{id} \
  --header 'ds-api-token: <api-key>'

{
  "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>"
          }
        ],
        "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>"
          }
        ],
        "owners_and_beneficiaries": [
          {
            "name": "<string>",
            "reference": "<string>",
            "role": "<string>",
            "country": "<string>"
          }
        ],
        "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
          }
        ]
      },
      "updated_at": 123,
      "importance_score": 123
    }
  ]
}

Authorizations

ds-api-token

string

header

required

Path Parameters

string<uuid>

required

Retrieve search history result by 'search_uuid'

Example:

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

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[]

Show child attributes

data.uuid

string

data.type

enum<string>

default:Person

Possible types

Available options:

Person,

Organization,

Country,

Vessel,

Aircraft,

CryptoWallet

data.annotation

string | null

Any general information

data.tags

enum<string>[]

Possible Entity Tags

Available options:

Finance,

Legal,

Terrorism,

Criminal,

PEP,

Media,

Social,

Sanctions,

UnofficialSource,

Leaks,

CompanyRegistry,

Associate,

Debarred

data.risk_score

enum<string>

Assigned Risk Score

Available options:

Low,

Medium,

High

data.fields

object

Show child attributes

data.fields.names

object[]

Generic

Show child attributes

data.fields.names.full_name

string

data.fields.names.first_name

string | null

data.fields.names.last_name

string | null

data.fields.names.middle_name

string | null

data.fields.names.lang

string | null

ISO 639-1 language code

data.fields.sources

object[]

Show child attributes

data.fields.sources.source_id

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

data.fields.sources.name

string

data.fields.sources.reason

string | null

data.fields.sources.summary

string | null

data.fields.sources.source_url

string

data.fields.sources.risk_score

enum<string>

Assigned Risk Score

Available options:

Low,

Medium,

High

data.fields.sources.tags

enum<string>[]

Possible Entity Tags

Available options:

Finance,

Legal,

Terrorism,

Criminal,

PEP,

Media,

Social,

Sanctions,

UnofficialSource,

Leaks,

CompanyRegistry,

Associate,

Debarred

data.fields.media

object[]

Show child attributes

data.fields.media.source_name

string

data.fields.media.source_url

string

data.fields.media.headline

string | null

data.fields.media.summary

string | null

data.fields.media.published_at

integer<int64>

data.fields.media.risk_score

enum<string>

Assigned Risk Score

Available options:

Low,

Medium,

High

data.fields.media.importance_score

number<double>

data.fields.media.sentiment

number<double>

data.fields.media.tags

enum<string>[]

Possible Entity Tags

Available options:

Finance,

Legal,

Terrorism,

Criminal,

PEP,

Media,

Social,

Sanctions,

UnofficialSource,

Leaks,

CompanyRegistry,

Associate,

Debarred

data.fields.media.country_codes

string[]

ISO 3166-1 alpha-2 country codes

data.fields.images

object[]

Show child attributes

data.fields.images.description

string | null

data.fields.images.url

string | null

data.fields.contact_info

object[]

Show child attributes

data.fields.contact_info.emails

string[]

data.fields.contact_info.phones

string[]

data.fields.contact_info.websites

string[]

data.fields.registration_ids

object[]

Show child attributes

data.fields.registration_ids.id

string

data.fields.registration_ids.id_type

string | null

Any local document type, e.g. 'Company registration number' or 'Tax ID'

data.fields.registration_ids.date

string<date> | null

ISO 8601 date

data.fields.registration_ids.industry

string | null

data.fields.registration_ids.country

string | null

ISO 3166-1 alpha-2 country code

data.fields.addresses

object[]

Show child attributes

data.fields.addresses.country

string

ISO 3166-1 alpha-2 country code

data.fields.addresses.region

string

data.fields.addresses.city

string

data.fields.addresses.postal_code

string

data.fields.addresses.address

string

data.fields.genders

enum<string>[]

Person

Possible Entity Gender values

Available options:

Male,

Female,

Other

data.fields.dates_of_birth

object[]

Show child attributes

data.fields.dates_of_birth.gte

string<date>

Example:

"1987-12-24T00:00:00.000Z"

data.fields.dates_of_birth.lte

string<date>

Example:

"1987-12-24T00:00:00.000Z"

data.fields.places_of_birth

object[]

Show child attributes

data.fields.places_of_birth.country

string

ISO 3166-1 alpha-2 country code

data.fields.places_of_birth.region

string

data.fields.places_of_birth.city

string

data.fields.places_of_birth.postal_code

string

data.fields.places_of_birth.address

string

data.fields.dates_of_death

object[]

Show child attributes

data.fields.dates_of_death.gte

string<date>

Example:

"1987-12-24T00:00:00.000Z"

data.fields.dates_of_death.lte

string<date>

Example:

"1987-12-24T00:00:00.000Z"

data.fields.places_of_death

object[]

Show child attributes

data.fields.places_of_death.country

string

ISO 3166-1 alpha-2 country code

data.fields.places_of_death.region

string

data.fields.places_of_death.city

string

data.fields.places_of_death.postal_code

string

data.fields.places_of_death.address

string

data.fields.citizenships

string[]

data.fields.nationalities

string[]

data.fields.political_roles

object[]

Show child attributes

data.fields.political_roles.role

string

data.fields.political_roles.country

string | null

ISO 3166-1 alpha-2 country code

data.fields.occupations

object[]

Show child attributes

data.fields.occupations.occupation

string

data.fields.occupations.country

string | null

ISO 3166-1 alpha-2 country code

data.fields.companies_and_enterprises

object[]

Show child attributes

data.fields.companies_and_enterprises.name

string

data.fields.companies_and_enterprises.reference

string | null

data.fields.companies_and_enterprises.role

string | null

data.fields.companies_and_enterprises.country

string | null

ISO 3166-1 alpha-2 country code

data.fields.owners_and_beneficiaries

object[]

Organization

Show child attributes

data.fields.owners_and_beneficiaries.name

string

data.fields.owners_and_beneficiaries.reference

string | null

data.fields.owners_and_beneficiaries.role

string | null

data.fields.owners_and_beneficiaries.country

string | null

ISO 3166-1 alpha-2 country code

data.fields.associates

object[]

Show child attributes

data.fields.associates.uuid

string

required

data.fields.associates.name

string

required

data.fields.associates.start_date

object

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

Show child attributes

data.fields.associates.start_date.gte

string<date>

Example:

"1987-12-24T00:00:00.000Z"

data.fields.associates.start_date.lte

string<date>

Example:

"1987-12-24T00:00:00.000Z"

data.fields.associates.end_date

object

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

Show child attributes

data.fields.associates.end_date.gte

string<date>

Example:

"1987-12-24T00:00:00.000Z"

data.fields.associates.end_date.lte

string<date>

Example:

"1987-12-24T00:00:00.000Z"

data.fields.associates.relationship

string

data.fields.associates.is_relative

boolean

data.updated_at

integer<int64>

epoch seconds

data.importance_score

number<double> | null

Relative importance score of entity, use risk_score for a final decision

AML PDF Report List existing applicants

⌘I

API documentation

Authorizations

Path Parameters

Response