Example of Possible Webhook Events
curl --request POST \
--url https://api.dataspike.io/webhook \
--header 'ds-api-token: <api-key>'import requests
url = "https://api.dataspike.io/webhook"
headers = {"ds-api-token": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'ds-api-token': '<api-key>'}};
fetch('https://api.dataspike.io/webhook', 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/webhook",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.dataspike.io/webhook"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("ds-api-token", "<api-key>")
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/webhook")
.header("ds-api-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dataspike.io/webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ds-api-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"webhook_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"event_type": "AML_SCREENING",
"timestamp": "2023-07-18T15:32:13.000Z",
"payload": {
"applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"screening_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"search_request": {
"full_name": "Grace MUGABE",
"first_name": "Grace",
"last_name": "MUGABE",
"countries": [
"ZW"
],
"cities": [],
"postal_codes": [],
"date_of_birth": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"risk_scores": [
"High"
],
"tags": [
"Sanctions"
],
"entity_types": [
"Person"
],
"sources": [],
"fuzziness": true,
"fuzziness_level": 1,
"phonetics": true,
"registration_ids": [],
"mode": "AUTO",
"gender": "<string>",
"search_kyb": true
},
"search_response": {
"requested_name": "<string>",
"search_uuid": "<string>",
"data": [
{
"uuid": "<string>",
"type": "Person",
"annotation": "<string>",
"tags": [],
"fields": {
"names": [
{
"full_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"lang": "<string>"
}
],
"sources": [
{
"source_id": "<string>",
"name": "<string>",
"reason": "<string>",
"summary": "<string>",
"source_url": "<string>",
"tags": []
}
],
"media": [
{
"source_name": "<string>",
"source_url": "<string>",
"headline": "<string>",
"summary": "<string>",
"published_at": 123,
"importance_score": 123,
"sentiment": 123,
"tags": [],
"country_codes": [
"<string>"
]
}
],
"images": [
{
"description": "<string>",
"url": "<string>"
}
],
"contact_info": [
{
"emails": [
"<string>"
],
"phones": [
"<string>"
],
"websites": [
"<string>"
]
}
],
"registration_ids": [
{
"id": "<string>",
"id_type": "<string>",
"date": "2023-12-25",
"industry": "<string>",
"country": "<string>",
"imo_number": "<string>",
"mmsi_number": "<string>",
"currency": "<string>"
}
],
"addresses": [
{
"country": "<string>",
"region": "<string>",
"city": "<string>",
"postal_code": "<string>",
"address": "<string>"
}
],
"genders": [],
"dates_of_birth": [
{
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
}
],
"places_of_birth": [
{
"country": "<string>",
"region": "<string>",
"city": "<string>",
"postal_code": "<string>",
"address": "<string>"
}
],
"dates_of_death": [
{
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
}
],
"places_of_death": [
{
"country": "<string>",
"region": "<string>",
"city": "<string>",
"postal_code": "<string>",
"address": "<string>"
}
],
"citizenships": [
"<string>"
],
"nationalities": [
"<string>"
],
"political_roles": [
{
"role": "<string>",
"country": "<string>"
}
],
"occupations": [
{
"occupation": "<string>",
"country": "<string>"
}
],
"companies_and_enterprises": [
{
"name": "<string>",
"reference": "<string>",
"role": "<string>",
"country": "<string>",
"start_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"end_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"ownership_value": "<string>",
"currency": "<string>",
"ownership_percentage": "<string>",
"additional_source": {
"source_id": "<string>",
"name": "<string>",
"reason": "<string>",
"summary": "<string>",
"source_url": "<string>",
"tags": []
}
}
],
"owners_and_beneficiaries": [
{
"name": "<string>",
"reference": "<string>",
"role": "<string>",
"country": "<string>",
"start_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"end_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"ownership_value": "<string>",
"currency": "<string>",
"ownership_percentage": "<string>",
"additional_source": {
"source_id": "<string>",
"name": "<string>",
"reason": "<string>",
"summary": "<string>",
"source_url": "<string>",
"tags": []
}
}
],
"associates": [
{
"uuid": "<string>",
"name": "<string>",
"start_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"end_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"relationship": "<string>",
"is_relative": true
}
],
"fatf_records": [
{
"url": "<string>",
"description": "<string>",
"country": "<string>"
}
]
},
"updated_at": 123,
"importance_score": 123,
"search_metadata": {
"best_match_name": "<string>",
"name_match_percentage": 123,
"risk_profile_info": {
"id": "<string>",
"name": "<string>",
"version": 123
}
},
"risk_score_value": 123
}
],
"fatf_records": [
{
"url": "<string>",
"description": "<string>",
"country": "<string>"
}
]
},
"completed_at": "2023-07-18T15:32:13.000Z",
"risk_score": {},
"external_id": "external_id_123"
}
}Webhooks
Example of Possible Webhook Events
Fake path to describe webhook format. Click Callbacks bellow to see possible Webhook Object options. More information about webhooks can be found in the documentation.
POST
/
webhook
Example of Possible Webhook Events
curl --request POST \
--url https://api.dataspike.io/webhook \
--header 'ds-api-token: <api-key>'import requests
url = "https://api.dataspike.io/webhook"
headers = {"ds-api-token": "<api-key>"}
response = requests.post(url, headers=headers)
print(response.text)const options = {method: 'POST', headers: {'ds-api-token': '<api-key>'}};
fetch('https://api.dataspike.io/webhook', 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/webhook",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.dataspike.io/webhook"
req, _ := http.NewRequest("POST", url, nil)
req.Header.Add("ds-api-token", "<api-key>")
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/webhook")
.header("ds-api-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.dataspike.io/webhook")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["ds-api-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"webhook_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"event_type": "AML_SCREENING",
"timestamp": "2023-07-18T15:32:13.000Z",
"payload": {
"applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"screening_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
"search_request": {
"full_name": "Grace MUGABE",
"first_name": "Grace",
"last_name": "MUGABE",
"countries": [
"ZW"
],
"cities": [],
"postal_codes": [],
"date_of_birth": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"risk_scores": [
"High"
],
"tags": [
"Sanctions"
],
"entity_types": [
"Person"
],
"sources": [],
"fuzziness": true,
"fuzziness_level": 1,
"phonetics": true,
"registration_ids": [],
"mode": "AUTO",
"gender": "<string>",
"search_kyb": true
},
"search_response": {
"requested_name": "<string>",
"search_uuid": "<string>",
"data": [
{
"uuid": "<string>",
"type": "Person",
"annotation": "<string>",
"tags": [],
"fields": {
"names": [
{
"full_name": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"middle_name": "<string>",
"lang": "<string>"
}
],
"sources": [
{
"source_id": "<string>",
"name": "<string>",
"reason": "<string>",
"summary": "<string>",
"source_url": "<string>",
"tags": []
}
],
"media": [
{
"source_name": "<string>",
"source_url": "<string>",
"headline": "<string>",
"summary": "<string>",
"published_at": 123,
"importance_score": 123,
"sentiment": 123,
"tags": [],
"country_codes": [
"<string>"
]
}
],
"images": [
{
"description": "<string>",
"url": "<string>"
}
],
"contact_info": [
{
"emails": [
"<string>"
],
"phones": [
"<string>"
],
"websites": [
"<string>"
]
}
],
"registration_ids": [
{
"id": "<string>",
"id_type": "<string>",
"date": "2023-12-25",
"industry": "<string>",
"country": "<string>",
"imo_number": "<string>",
"mmsi_number": "<string>",
"currency": "<string>"
}
],
"addresses": [
{
"country": "<string>",
"region": "<string>",
"city": "<string>",
"postal_code": "<string>",
"address": "<string>"
}
],
"genders": [],
"dates_of_birth": [
{
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
}
],
"places_of_birth": [
{
"country": "<string>",
"region": "<string>",
"city": "<string>",
"postal_code": "<string>",
"address": "<string>"
}
],
"dates_of_death": [
{
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
}
],
"places_of_death": [
{
"country": "<string>",
"region": "<string>",
"city": "<string>",
"postal_code": "<string>",
"address": "<string>"
}
],
"citizenships": [
"<string>"
],
"nationalities": [
"<string>"
],
"political_roles": [
{
"role": "<string>",
"country": "<string>"
}
],
"occupations": [
{
"occupation": "<string>",
"country": "<string>"
}
],
"companies_and_enterprises": [
{
"name": "<string>",
"reference": "<string>",
"role": "<string>",
"country": "<string>",
"start_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"end_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"ownership_value": "<string>",
"currency": "<string>",
"ownership_percentage": "<string>",
"additional_source": {
"source_id": "<string>",
"name": "<string>",
"reason": "<string>",
"summary": "<string>",
"source_url": "<string>",
"tags": []
}
}
],
"owners_and_beneficiaries": [
{
"name": "<string>",
"reference": "<string>",
"role": "<string>",
"country": "<string>",
"start_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"end_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"ownership_value": "<string>",
"currency": "<string>",
"ownership_percentage": "<string>",
"additional_source": {
"source_id": "<string>",
"name": "<string>",
"reason": "<string>",
"summary": "<string>",
"source_url": "<string>",
"tags": []
}
}
],
"associates": [
{
"uuid": "<string>",
"name": "<string>",
"start_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"end_date": {
"gte": "1987-12-24T00:00:00.000Z",
"lte": "1987-12-24T00:00:00.000Z"
},
"relationship": "<string>",
"is_relative": true
}
],
"fatf_records": [
{
"url": "<string>",
"description": "<string>",
"country": "<string>"
}
]
},
"updated_at": 123,
"importance_score": 123,
"search_metadata": {
"best_match_name": "<string>",
"name_match_percentage": 123,
"risk_profile_info": {
"id": "<string>",
"name": "<string>",
"version": 123
}
},
"risk_score_value": 123
}
],
"fatf_records": [
{
"url": "<string>",
"description": "<string>",
"country": "<string>"
}
]
},
"completed_at": "2023-07-18T15:32:13.000Z",
"risk_score": {},
"external_id": "external_id_123"
}
}Authorizations
Response
200 - application/json
Description of possible webhook schemas
Common fields for any webhook event
Unique webhook event id
Example:
"01827ed4-c928-7a3c-9a30-7ab7cc169d11"
Triggered webhook Id configuration. the configuration itself could be found in your Dataspike account
Example:
"01827ed4-c928-7a3c-9a30-7ab7cc169d11"
Available options:
AML_SCREENING, DOCVER, TRANSACTION_MONITORING, KYT_WALLET_CHECK Example:
"AML_SCREENING"
Timestamp of the webhook event
Example:
"2023-07-18T15:32:13.000Z"
AML Notification Events are triggered upon the completion of AML screening.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
Show child attributes
Show child attributes
⌘I