List existing applicants

Authorizations

ds-api-token

string

header

required

Query Parameters

page

integer

default:0

Current page

limit

integer

default:10

Limit of returned applicants per page

Response

200 - application/json

List of the applicants

data

object[]

required

List of an existing paginated items Object contains a list of an existing Applicant profiles

Object contains detailed information about the requested applicant, including various attributes associated with the applicant`s profile, facilitating a comprehensive understanding of their data.

Option 1
Option 2

Show child attributes

data.applicant_id

string<uuid>

Applicant ID in Dataspike system

Example:

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

data.external_id

string | null

This is a unique identifier originating from your system, associated and linked to the corresponding Applicant ID in our system.

Example:

"external_user_id_123"

data.type

enum<string>

default:Person

Possible types

Available options:

Person,

Organization,

Country,

Vessel,

Aircraft,

CryptoWallet

data.email

string | null

applicant email

Example:

"[email protected]"

data.phone

string | null

applicant phone number

Example:

"+1234567890"

data.system_info

object

Additional info, generated during verification process by system

Show child attributes

data.system_info.full_name

string

Full Person name, if not specified will fallback to first_name and last name

Example:

"John Doe"

data.system_info.first_name

string

First name

Example:

"John"

data.system_info.last_name

string

Last name

Example:

"Doe"

data.system_info.dob

string<ISO-8601>

Date of birth in ISO-8601 format

Example:

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

data.system_info.gender

enum<string>

gender that is used in official documents

Available options:

M,

F

Example:

"M"

data.system_info.citizenship

string<ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Currently can be set via manual fields feature via API when creating applicants. (Available in provided_info in applicant)

Example:

"DE"

data.system_info.country

string<ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Country extracted from POI document. (Available in system_info in applicant)

Example:

"DE"

data.system_info.address

string

Applicant address, could be used for any type of applicants

Example:

"Paris, France"

data.system_info.addresses

object

List of applicant addresses, only residence for now.

Show child attributes

data.system_info.addresses.residence

object

Detailed address

Show child attributes

data.system_info.addresses.residence.country

string

required

ISO 3166-1 ALPHA-2 code

Example:

"DE"

data.system_info.addresses.residence.city

string

required

City name

Example:

"Berlin"

data.system_info.addresses.residence.postal_code

string

required

postal code (or zip) for the address.

Example:

"10999"

data.system_info.addresses.residence.street

string

required

Street adress line

Example:

"Wiener Straße 17"

data.system_info.custom_fields

object

Key - value object, values can be only strings

data.provided_info

object

External data provided during applicant creation

Show child attributes

data.provided_info.full_name

string

Full Person name, if not specified will fallback to first_name and last name

Example:

"John Doe"

data.provided_info.first_name

string

First name

Example:

"John"

data.provided_info.last_name

string

Last name

Example:

"Doe"

data.provided_info.dob

string<ISO-8601>

Date of birth in ISO-8601 format

Example:

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

data.provided_info.gender

enum<string>

gender that is used in official documents

Available options:

M,

F

Example:

"M"

data.provided_info.citizenship

string<ISO 3166-1 ALPHA-2 code>

Example:

"DE"

data.provided_info.country

string<ISO 3166-1 ALPHA-2 code>

Two-letter ISO 3166-1 ALPHA-2 code, reference https://www.iban.com/country-codes. Country extracted from POI document. (Available in system_info in applicant)

Example:

"DE"

data.provided_info.address

string

Applicant address, could be used for any type of applicants

Example:

"Paris, France"

data.provided_info.addresses

object

List of applicant addresses, only residence for now.

Show child attributes

data.provided_info.addresses.residence

object

Detailed address

Show child attributes

data.provided_info.addresses.residence.country

string

required

ISO 3166-1 ALPHA-2 code

Example:

"DE"

data.provided_info.addresses.residence.city

string

required

City name

Example:

"Berlin"

data.provided_info.addresses.residence.postal_code

string

required

postal code (or zip) for the address.

Example:

"10999"

data.provided_info.addresses.residence.street

string

required

Street adress line

Example:

"Wiener Straße 17"

data.provided_info.custom_fields

object

Key - value object, values can be only strings

data.last_verification_id

string<uuid> | null

The id of last document verification

Example:

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

data.verification_status

enum<string>

Status of applicant's last verification. Initial if applicant doesn't have a completed verification.

Available options:

initial,

passed,

failed

data.aml_screening_enabled

boolean | null

default:false

Describes whether AML screening option is enabled for specified Applicant or disabled

data.last_aml_screening_id

string<uuid> | null

Id of the last screening operation

Example:

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

data.last_screened_at

string<ISO-8601> | null

Timestamp of the last screening operation

Example:

"2023-07-18T15:32:13.000Z"

data.last_risk_score

enum<string>

Assigned Risk Score

Available options:

Low,

Medium,

High

data.last_tags

enum<string>[] | null

List of tags of the last screening operation

Possible Entity Tags

Available options:

Finance,

Legal,

Terrorism,

Criminal,

PEP,

Media,

Social,

Sanctions,

UnofficialSource,

Leaks,

CompanyRegistry,

Associate,

Debarred

data.tg_profile

string | null

Telegram ID linked to Applicant

Example:

"1234567890"

data.search_options

object

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

Show child attributes

data.search_options.risk_scores

enum<string>[] | null

Assigned Risk Score

Available options:

Low,

Medium,

High

data.search_options.tags

enum<string>[] | null

Possible Entity Tags

Available options:

Finance,

Legal,

Terrorism,

Criminal,

PEP,

Media,

Social,

Sanctions,

UnofficialSource,

Leaks,

CompanyRegistry,

Associate,

Debarred

data.search_options.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

data.search_options.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.

data.search_options.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

data.search_options.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.

data.search_options.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

has_next

boolean

default:false

This property serves as an indicator of whether there is a next page available in the paginated result

API documentation

Authorizations

Query Parameters

Response