Skip to main content
POST
/
webhook
Example of Possible Webhook Events
curl --request POST \
  --url https://api.dataspike.io/webhook \
  --header 'ds-api-token: <api-key>'
{
  "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": {
    "risk_score": {
      "type": "Low"
    },
    "applicant_id": "01827ed4-c928-7a3c-9a30-7ab7cc169d11",
    "external_id": "external_id_123",
    "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"
  }
}

Authorizations

ds-api-token
string
header
required

Response

200 - application/json

Description of possible webhook schemas

Common fields for any webhook event

id
string

Unique webhook event id

Example:

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

webhook_id
string

Triggered webhook Id configuration. the configuration itself could be found in your Dataspike account

Example:

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

event_type
enum<string>
Available options:
AML_SCREENING,
DOCVER,
TRANSACTION_MONITORING,
KYT_WALLET_CHECK
Example:

"AML_SCREENING"

timestamp
string<ISO-8601>

Timestamp of the webhook event

Example:

"2023-07-18T15:32:13.000Z"

payload
object

AML Notification Events are triggered upon the completion of AML screening.

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5