Skip to main content
POST
/
api
/
v3
/
applicants
Create New Applicant
curl --request POST \
  --url https://api.dataspike.io/api/v3/applicants \
  --header 'Content-Type: application/json' \
  --header 'ds-api-token: <api-key>' \
  --data '{
  "external_id": "external_user_id_123",
  "email": "john.doe@example.org",
  "phone": "+1234567890",
  "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": {}
  },
  "aml_screening_enabled": false,
  "applicant_type": "Person",
  "search_options": {
    "risk_scores": [
      "Low"
    ],
    "tags": [
      "Finance"
    ],
    "sources": [
      "<string>"
    ],
    "fuzziness": true,
    "fuzziness_level": 1,
    "phonetics": true,
    "mode": 0
  }
}'
{
  "id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11"
}

Authorizations

​
ds-api-token
string
header
required

Body

application/json

Create Applicant Request

  • Option 1
  • Option 2
​
external_id
string

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

Example:

"external_user_id_123"

​
email
string | null

applicant email

Example:

"john.doe@example.org"

​
phone
string | null

applicant phone number

Example:

"+1234567890"

​
info
object

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

​
aml_screening_enabled
boolean | null
default:false

Enables the option to activate or deactivate daily AML monitoring for applicants. When an applicant is identified in any Sanction List during the monitoring process, a notification will be triggered through the configured Webhooks.

​
applicant_type
enum<string>
default:Person

Possible types

Available options:
Person,
Organization,
Country,
Vessel,
Aircraft,
CryptoWallet
​
search_options
object | null

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

Response

200 - application/json

Create Applicant Response

​
id
string<uuid>

Id of created applicant

Example:

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