Skip to main content
GET
/
api
/
v3
/
applicants
/
by_external_id
/
{external_id}
Get Applicant by External id
curl --request GET \
  --url https://api.dataspike.io/api/v3/applicants/by_external_id/{external_id} \
  --header 'ds-api-token: <api-key>'
{
  "applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  "external_id": "external_user_id_123",
  "type": "Person",
  "email": "john.doe@example.org",
  "phone": "+1234567890",
  "system_info": {
    "full_name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "dob": "1987-12-24T00:00:00.000Z",
    "gender": "M",
    "citizenship": "DE",
    "country": "DE",
    "address": "Paris, France",
    "addresses": {
      "residence": {
        "country": "DE",
        "city": "Berlin",
        "postal_code": "10999",
        "street": "Wiener Straße 17"
      }
    },
    "custom_fields": {}
  },
  "provided_info": {
    "full_name": "John Doe",
    "first_name": "John",
    "last_name": "Doe",
    "dob": "1987-12-24T00:00:00.000Z",
    "gender": "M",
    "citizenship": "DE",
    "country": "DE",
    "address": "Paris, France",
    "addresses": {
      "residence": {
        "country": "DE",
        "city": "Berlin",
        "postal_code": "10999",
        "street": "Wiener Straße 17"
      }
    },
    "custom_fields": {}
  },
  "last_verification_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  "verification_status": "initial",
  "aml_screening_enabled": false,
  "last_aml_screening_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
  "last_screened_at": "2023-07-18T15:32:13.000Z",
  "last_risk_score": "Low",
  "last_tags": [
    "Finance"
  ],
  "tg_profile": "1234567890",
  "search_options": {
    "risk_scores": [
      "Low"
    ],
    "tags": [
      "Finance"
    ],
    "sources": [
      "<string>"
    ],
    "fuzziness": true,
    "fuzziness_level": 0.5,
    "phonetics": true,
    "mode": 0
  }
}

Authorizations

​
ds-api-token
string
header
required

Path Parameters

​
external_id
string
required

External id of applicant

Response

Applicant Response

  • Option 1
  • Option 2

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 This object allows you to include any supplementary information about the applicant, such as their first, last name or citizenship.

​
provided_info
object

External data provided during applicant creation This object allows you to include any supplementary information about the applicant, such as their first, last name or citizenship.

​
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

​
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