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": {},
"custom_fields": {}
},
"aml_screening_enabled": false,
"applicant_type": "Person",
"search_options": {
"risk_scores": [],
"tags": [],
"sources": [
"<string>"
],
"fuzziness": true,
"fuzziness_level": 1,
"phonetics": true,
"mode": 0
}
}
'import requests
url = "https://api.dataspike.io/api/v3/applicants"
payload = {
"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": {},
"custom_fields": {}
},
"aml_screening_enabled": False,
"applicant_type": "Person",
"search_options": {
"risk_scores": [],
"tags": [],
"sources": ["<string>"],
"fuzziness": True,
"fuzziness_level": 1,
"phonetics": True,
"mode": 0
}
}
headers = {
"ds-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'ds-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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: {},
custom_fields: {}
},
aml_screening_enabled: false,
applicant_type: 'Person',
search_options: {
risk_scores: [],
tags: [],
sources: ['<string>'],
fuzziness: true,
fuzziness_level: 1,
phonetics: true,
mode: 0
}
})
};
fetch('https://api.dataspike.io/api/v3/applicants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dataspike.io/api/v3/applicants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
],
'custom_fields' => [
]
],
'aml_screening_enabled' => false,
'applicant_type' => 'Person',
'search_options' => [
'risk_scores' => [
],
'tags' => [
],
'sources' => [
'<string>'
],
'fuzziness' => true,
'fuzziness_level' => 1,
'phonetics' => true,
'mode' => 0
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"ds-api-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dataspike.io/api/v3/applicants"
payload := strings.NewReader("{\n \"external_id\": \"external_user_id_123\",\n \"email\": \"john.doe@example.org\",\n \"phone\": \"+1234567890\",\n \"info\": {\n \"full_name\": \"John Doe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"dob\": \"1987-12-24T00:00:00.000Z\",\n \"gender\": \"M\",\n \"citizenship\": \"DE\",\n \"country\": \"DE\",\n \"address\": \"Paris, France\",\n \"addresses\": {},\n \"custom_fields\": {}\n },\n \"aml_screening_enabled\": false,\n \"applicant_type\": \"Person\",\n \"search_options\": {\n \"risk_scores\": [],\n \"tags\": [],\n \"sources\": [\n \"<string>\"\n ],\n \"fuzziness\": true,\n \"fuzziness_level\": 1,\n \"phonetics\": true,\n \"mode\": 0\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ds-api-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.dataspike.io/api/v3/applicants")
.header("ds-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"external_user_id_123\",\n \"email\": \"john.doe@example.org\",\n \"phone\": \"+1234567890\",\n \"info\": {\n \"full_name\": \"John Doe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"dob\": \"1987-12-24T00:00:00.000Z\",\n \"gender\": \"M\",\n \"citizenship\": \"DE\",\n \"country\": \"DE\",\n \"address\": \"Paris, France\",\n \"addresses\": {},\n \"custom_fields\": {}\n },\n \"aml_screening_enabled\": false,\n \"applicant_type\": \"Person\",\n \"search_options\": {\n \"risk_scores\": [],\n \"tags\": [],\n \"sources\": [\n \"<string>\"\n ],\n \"fuzziness\": true,\n \"fuzziness_level\": 1,\n \"phonetics\": true,\n \"mode\": 0\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dataspike.io/api/v3/applicants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ds-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_id\": \"external_user_id_123\",\n \"email\": \"john.doe@example.org\",\n \"phone\": \"+1234567890\",\n \"info\": {\n \"full_name\": \"John Doe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"dob\": \"1987-12-24T00:00:00.000Z\",\n \"gender\": \"M\",\n \"citizenship\": \"DE\",\n \"country\": \"DE\",\n \"address\": \"Paris, France\",\n \"addresses\": {},\n \"custom_fields\": {}\n },\n \"aml_screening_enabled\": false,\n \"applicant_type\": \"Person\",\n \"search_options\": {\n \"risk_scores\": [],\n \"tags\": [],\n \"sources\": [\n \"<string>\"\n ],\n \"fuzziness\": true,\n \"fuzziness_level\": 1,\n \"phonetics\": true,\n \"mode\": 0\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11"
}Applicants
Create New Applicant
Submit applicant details, such as name, contact information or identification data, in JSON format to create a new applicant profile. The API will respond with a unique applicant ID for further interactions.
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": {},
"custom_fields": {}
},
"aml_screening_enabled": false,
"applicant_type": "Person",
"search_options": {
"risk_scores": [],
"tags": [],
"sources": [
"<string>"
],
"fuzziness": true,
"fuzziness_level": 1,
"phonetics": true,
"mode": 0
}
}
'import requests
url = "https://api.dataspike.io/api/v3/applicants"
payload = {
"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": {},
"custom_fields": {}
},
"aml_screening_enabled": False,
"applicant_type": "Person",
"search_options": {
"risk_scores": [],
"tags": [],
"sources": ["<string>"],
"fuzziness": True,
"fuzziness_level": 1,
"phonetics": True,
"mode": 0
}
}
headers = {
"ds-api-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'ds-api-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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: {},
custom_fields: {}
},
aml_screening_enabled: false,
applicant_type: 'Person',
search_options: {
risk_scores: [],
tags: [],
sources: ['<string>'],
fuzziness: true,
fuzziness_level: 1,
phonetics: true,
mode: 0
}
})
};
fetch('https://api.dataspike.io/api/v3/applicants', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.dataspike.io/api/v3/applicants",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'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' => [
],
'custom_fields' => [
]
],
'aml_screening_enabled' => false,
'applicant_type' => 'Person',
'search_options' => [
'risk_scores' => [
],
'tags' => [
],
'sources' => [
'<string>'
],
'fuzziness' => true,
'fuzziness_level' => 1,
'phonetics' => true,
'mode' => 0
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"ds-api-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.dataspike.io/api/v3/applicants"
payload := strings.NewReader("{\n \"external_id\": \"external_user_id_123\",\n \"email\": \"john.doe@example.org\",\n \"phone\": \"+1234567890\",\n \"info\": {\n \"full_name\": \"John Doe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"dob\": \"1987-12-24T00:00:00.000Z\",\n \"gender\": \"M\",\n \"citizenship\": \"DE\",\n \"country\": \"DE\",\n \"address\": \"Paris, France\",\n \"addresses\": {},\n \"custom_fields\": {}\n },\n \"aml_screening_enabled\": false,\n \"applicant_type\": \"Person\",\n \"search_options\": {\n \"risk_scores\": [],\n \"tags\": [],\n \"sources\": [\n \"<string>\"\n ],\n \"fuzziness\": true,\n \"fuzziness_level\": 1,\n \"phonetics\": true,\n \"mode\": 0\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("ds-api-token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.dataspike.io/api/v3/applicants")
.header("ds-api-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"external_id\": \"external_user_id_123\",\n \"email\": \"john.doe@example.org\",\n \"phone\": \"+1234567890\",\n \"info\": {\n \"full_name\": \"John Doe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"dob\": \"1987-12-24T00:00:00.000Z\",\n \"gender\": \"M\",\n \"citizenship\": \"DE\",\n \"country\": \"DE\",\n \"address\": \"Paris, France\",\n \"addresses\": {},\n \"custom_fields\": {}\n },\n \"aml_screening_enabled\": false,\n \"applicant_type\": \"Person\",\n \"search_options\": {\n \"risk_scores\": [],\n \"tags\": [],\n \"sources\": [\n \"<string>\"\n ],\n \"fuzziness\": true,\n \"fuzziness_level\": 1,\n \"phonetics\": true,\n \"mode\": 0\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dataspike.io/api/v3/applicants")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ds-api-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"external_id\": \"external_user_id_123\",\n \"email\": \"john.doe@example.org\",\n \"phone\": \"+1234567890\",\n \"info\": {\n \"full_name\": \"John Doe\",\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"dob\": \"1987-12-24T00:00:00.000Z\",\n \"gender\": \"M\",\n \"citizenship\": \"DE\",\n \"country\": \"DE\",\n \"address\": \"Paris, France\",\n \"addresses\": {},\n \"custom_fields\": {}\n },\n \"aml_screening_enabled\": false,\n \"applicant_type\": \"Person\",\n \"search_options\": {\n \"risk_scores\": [],\n \"tags\": [],\n \"sources\": [\n \"<string>\"\n ],\n \"fuzziness\": true,\n \"fuzziness_level\": 1,\n \"phonetics\": true,\n \"mode\": 0\n }\n}"
response = http.request(request)
puts response.read_body{
"id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11"
}Authorizations
Body
application/json
Create Applicant Request
- Option 1
- Option 2
Create Applicant Request
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"
applicant email
Example:
"john.doe@example.org"
applicant phone number
Example:
"+1234567890"
This object allows you to include any supplementary information about the applicant, such as their first, last name or citizenship.
Show child attributes
Show child attributes
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.
Possible types
Available options:
Person, Organization, Country, Vessel, Aircraft, CryptoWallet The Search Options functionality is intended for the customization of applicant AML monitoring
Show child attributes
Show child attributes
Response
200 - application/json
Create Applicant Response
Create Applicant Response
Id of created applicant
Example:
"01827ed4-c928-7a3c-9a30-7ab7cc169d11"
⌘I