validate

Validate if this custom event should be allowed, challenged, denied or reviewed.

Analyzes a custom event in real time and returns a recommendation (allow, challenge, deny or review) so you can act on it.

post/v1/validate/custom

Request

  • Base URL
    https://account-api.datadome.co
  • URL
    https://account-api.datadome.co/v1/validate/custom
  • Auth
    API key in header x-api-key

Request body

OR

Example request

{
  "eventName": "myEventName",
  "module": {
    "requestTimeMicros": 1705314600000000,
    "name": "my-module",
    "version": "1.0.0"
  },
  "header": {
    "addr": "203.0.113.42",
    "contentType": "application/json",
    "host": "www.example.com",
    "port": 443,
    "xRealIp": "203.0.113.42",
    "xForwardedForIp": "203.0.113.42",
    "acceptEncoding": "gzip, deflate, br",
    "acceptLanguage": "en-US,en;q=0.9",
    "accept": "*/*",
    "method": "POST",
    "protocol": "HTTP",
    "serverHostname": "www.example.com",
    "referer": "https://www.example.com/login",
    "userAgent": "Mozilla/5.0",
    "from": "",
    "request": "/login",
    "origin": "https://www.example.com",
    "acceptCharset": "utf-8",
    "connection": "keep-alive",
    "clientID": "datadome_cookie_value"
  }
}

Response

Custom event validation response sent from Account Protect server to Customer

action'deny' | 'review' | 'challenge' | 'allow' required

Action answered to Customer endpoint

reasonsstring[]

List of models matching the event

eventIdstring required

Event identifier associated to this validate event (for both registration and login)

scoreinteger

The level of confidence when identifying a request as coming from a fraudster.

Example response

{
  "action": "allow",
  "eventId": "019441b4-7757-7ba4-a039-6d47b64ced20"
}

Changes

No recorded changes to this operation across all 1 revision of this API.