DAdatadome
validate

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

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

post/v1/validate/login

Request

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

Request body

accountstring required

User account (mail address, username, alias, login, ...)

partnerIdstring

For customers who sell their product as white label app, identify the partner using the solution to adapt detection models.

eventDatestring date-time

Date when the event occurred on your side, if you send it later than it happened (for example from a queue). Format ISO 8601 YYYY-MM-DDThh:mm:ss.sssTZD. DataDome uses it to order the events. If eventDate is absent or has an invalid format, DataDome uses module.requestTimeMicros instead, and the event is still processed.

status'failed' | 'succeeded' required

User login authentication status

failReason'unknownAccount' | 'wrongPassword' | 'expiredPassword' | 'disabledAccount' | 'blockedAccount' | 'invalidMfa' | 'internalBusinessRule' | 'technicalIssue' | 'other'

Reason why the login failed. Helps differentiate different types of fraud patterns.

accountType'guest' | 'staff' | 'external' | 'partner' | 'customer' | 'merchant' | 'vip' | 'test' | 'other'

Type of the account to adapt detection model on the user type

accountCreationDatestring date-time

Date when account was created. Help improve detection for account created before Account Protect setup. Format ISO 8601 YYYY-MM-DDThh:mm:ssTZD

Example request

{
  "account": "john.doe@example.com",
  "status": "succeeded",
  "module": {
    "requestTimeMicros": 1705314600000000,
    "name": "my-module",
    "version": "1.0.0"
  }
}

Response

Login 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.

ipstring required

User IP

Example response

{
  "action": "allow",
  "eventId": "019441b4-7757-7ba4-a039-6d47b64ced20",
  "ip": "203.0.113.42",
  "location": {
    "countryCode": "US",
    "country": "United States",
    "city": "New York"
  }
}

Changes

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