DAdatadome
collect

Enrich DataDome engine

When you don't need an action but just inform DataDome about an event, use this API.

post/v1/collect/registration

Request

  • Base URL
    https://account-api.datadome.co
  • URL
    https://account-api.datadome.co/v1/collect/registration
  • 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'attempted' | 'succeeded' | 'failed'

Status of the registration to be able to identify where are we in the account creation process (supports multi-step registration)

failReason'duplicatedAccount' | 'invalidMfa' | 'cancelled' | 'internalBusinessRule' | 'technicalIssue' | 'other'

Reason why the registration 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

Example request

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

Response

The event has been collected

Changes

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