Skip to main content
GET
Get Applicant by External id

Authorizations

ds-api-token
string
header
required

Path Parameters

external_id
string
required

External id of applicant

Response

Applicant Response

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

applicant_id
string<uuid>

Applicant ID in Dataspike system

Example:

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

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"

type
enum<string>
default:Person

Possible types

Available options:
Person,
Organization,
Country,
Vessel,
Aircraft,
CryptoWallet
email
string | null

applicant email

Example:

"john.doe@example.org"

phone
string | null

applicant phone number

Example:

"+1234567890"

system_info
object

Additional info, generated during verification process by system

provided_info
object

External data provided during applicant creation

last_verification_id
string<uuid> | null

The id of last document verification

Example:

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

verification_status
enum<string>

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

Available options:
initial,
passed,
failed
aml_screening_enabled
boolean | null
default:false

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

last_aml_screening_id
string<uuid> | null

Id of the last screening operation

Example:

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

last_screened_at
string<ISO-8601> | null

Timestamp of the last screening operation

Example:

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

last_risk_score
enum<string>

Assigned Risk Score

Available options:
Low,
Medium,
High
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,
PublicInterest,
RegulatoryWarning
tg_profile
string | null

Telegram ID linked to Applicant

Example:

"1234567890"

search_options
object | null

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