curl --request GET \
--url https://api.dataspike.io/api/v3/notifications/webhook/history \
--header 'ds-api-token: <api-key>'{
"data": [
{
"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": []
},
"search_response": {
"requested_name": "<string>",
"search_uuid": "<string>",
"max_risk_score": "Low",
"data": [
{
"uuid": "<string>",
"type": "Person",
"annotation": "<string>",
"tags": [
"Finance"
],
"risk_score": "Low",
"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>",
"risk_score": "Low",
"tags": [
"Finance"
]
}
],
"media": [
{
"source_name": "<string>",
"source_url": "<string>",
"headline": "<string>",
"summary": "<string>",
"published_at": 123,
"risk_score": "Low",
"importance_score": 123,
"sentiment": 123,
"tags": [
"Finance"
],
"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>"
}
],
"addresses": [
{
"country": "<string>",
"region": "<string>",
"city": "<string>",
"postal_code": "<string>",
"address": "<string>"
}
],
"genders": [
"Male"
],
"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>"
}
],
"owners_and_beneficiaries": [
{
"name": "<string>",
"reference": "<string>",
"role": "<string>",
"country": "<string>"
}
],
"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
}
]
},
"updated_at": 123,
"importance_score": 123
}
]
},
"completed_at": "2023-07-18T15:32:13.000Z",
"risk_score": {
"type": "Low"
},
"external_id": "external_id_123"
}
}
],
"has_next": false
}View Webhook Hisotry
View history of the latest webhook notification events
curl --request GET \
--url https://api.dataspike.io/api/v3/notifications/webhook/history \
--header 'ds-api-token: <api-key>'{
"data": [
{
"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": []
},
"search_response": {
"requested_name": "<string>",
"search_uuid": "<string>",
"max_risk_score": "Low",
"data": [
{
"uuid": "<string>",
"type": "Person",
"annotation": "<string>",
"tags": [
"Finance"
],
"risk_score": "Low",
"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>",
"risk_score": "Low",
"tags": [
"Finance"
]
}
],
"media": [
{
"source_name": "<string>",
"source_url": "<string>",
"headline": "<string>",
"summary": "<string>",
"published_at": 123,
"risk_score": "Low",
"importance_score": 123,
"sentiment": 123,
"tags": [
"Finance"
],
"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>"
}
],
"addresses": [
{
"country": "<string>",
"region": "<string>",
"city": "<string>",
"postal_code": "<string>",
"address": "<string>"
}
],
"genders": [
"Male"
],
"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>"
}
],
"owners_and_beneficiaries": [
{
"name": "<string>",
"reference": "<string>",
"role": "<string>",
"country": "<string>"
}
],
"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
}
]
},
"updated_at": 123,
"importance_score": 123
}
]
},
"completed_at": "2023-07-18T15:32:13.000Z",
"risk_score": {
"type": "Low"
},
"external_id": "external_id_123"
}
}
],
"has_next": false
}Authorizations
Query Parameters
From what event id start fetch history
"01827ed4-c928-7a3c-9a30-7ab7cc169d11"
Filter by Webhook Configuration ID
"01827ed4-c928-7a3c-9a30-7ab7cc169d11"
Response
Paginated list of Webhook object
List of an existing paginated items Object contains a list of a webhook events
Show child attributes
Show child attributes
Unique webhook event id
"01827ed4-c928-7a3c-9a30-7ab7cc169d11"
Triggered webhook Id configuration. the configuration itself could be found in your Dataspike account
"01827ed4-c928-7a3c-9a30-7ab7cc169d11"
AML_SCREENING, DOCVER, TRANSACTION_MONITORING, KYT_WALLET_CHECK "AML_SCREENING"
Timestamp of the webhook event
"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
Id of applicant
"01827ed4-c928-7a3c-9a30-7ab7cc169d11"
Screening identifier for corresponding AML screening operation
"01827ed4-c928-7a3c-9a30-7ab7cc169d11"
AML Search request
Show child attributes
Show child attributes
The full_name is a mandatory field and serves as the primary search term, unless both the first and last names are provided. In such a scenario, the combination of the first and last names becomes the primary term, and the full_name is employed to enhance the relevance of results.
"Grace MUGABE"
This optional field serves to optimize the overall search experience when both first_name and last_name are provided.
"Grace"
This optional field serves to optimize the overall search experience when both first_name and last_name are provided.
"MUGABE"
ISO 3166-1 alpha-2 country codes
["ZW"]Assigned Risk Score
Low, Medium, High ["High"]Possible Entity Tags
Finance, Legal, Terrorism, Criminal, PEP, Media, Social, Sanctions, UnofficialSource, Leaks, CompanyRegistry, Associate, Debarred ["Sanctions"]Possible types
Person, Organization, Country, Vessel, Aircraft, CryptoWallet ["Person"]Possible Source IDs, contains all publicly available sources, constantly updated, for the most up to date list please check https://dash.dataspike.io/pep-sanctions/data-sources
A boolean flag (True/False). When set to True (default), broad matches are allowed. If set to False, only exact matches are permitted.
Controls the strictness of name matching. 0 means exact match, 1 means broad match. Recommended value is 1. Intermediate values (e.g., 0.5) can be used to fine-tune the balance between precision and scope.
0 <= x <= 1This setting enables phonetic similarity during AML searches, which is helpful for finding similar names across different languages. We generally recommend keeping this set to True.
Show child attributes
Show child attributes
Search id, could be use later to fetch the existing search result
Assigned Risk Score
Low, Medium, High Show child attributes
Show child attributes
Possible types
Person, Organization, Country, Vessel, Aircraft, CryptoWallet Any general information
Possible Entity Tags
Finance, Legal, Terrorism, Criminal, PEP, Media, Social, Sanctions, UnofficialSource, Leaks, CompanyRegistry, Associate, Debarred Assigned Risk Score
Low, Medium, High Show child attributes
Show child attributes
Generic
Show child attributes
Show child attributes
ISO 639-1 language code
Show child attributes
Show child attributes
Possible Source IDs, contains all publicly available sources, constantly updated, for the most up to date list please check https://dash.dataspike.io/pep-sanctions/data-sources
Assigned Risk Score
Low, Medium, High Possible Entity Tags
Finance, Legal, Terrorism, Criminal, PEP, Media, Social, Sanctions, UnofficialSource, Leaks, CompanyRegistry, Associate, Debarred Show child attributes
Show child attributes
Assigned Risk Score
Low, Medium, High Possible Entity Tags
Finance, Legal, Terrorism, Criminal, PEP, Media, Social, Sanctions, UnofficialSource, Leaks, CompanyRegistry, Associate, Debarred ISO 3166-1 alpha-2 country codes
Show child attributes
Show child attributes
Any local document type, e.g. 'Company registration number' or 'Tax ID'
ISO 8601 date
ISO 3166-1 alpha-2 country code
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code
Person
Possible Entity Gender values
Male, Female, Other Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code
Organization
Show child attributes
Show child attributes
ISO 3166-1 alpha-2 country code
Show child attributes
Show child attributes
Date range, represented as a pair of dates in ISO 8601 format
Date range, represented as a pair of dates in ISO 8601 format
epoch seconds
Relative importance score of entity, use risk_score for a final decision
Timestamp of the screening operation
"2023-07-18T15:32:13.000Z"
External applicant Id
"external_id_123"
This property serves as an indicator of whether there is a next page available in the paginated result