IDScan.net
Search Results for

    Show / Hide Table of Contents

    DIVE Online API - Risk Events

    Risk Events are generated when certain conditions are met during the identity verification process. These events help identify potential fraud or suspicious activity associated with an applicant. These events are made by the DIVE Online system based on predefined rules and criteria set by IDScan.net.

    api/v2/public/risk-events

    [GET] /api/v2/public/risk-events
    

    Use Case - Retrieves Risk Events (if any) associated with verification requests.

    Token - public API token (pk_) or secret API Token (sk_)

    Required Parameters None

    Optional Parameters

    • Page - specifies the page number to return. The value must be between 1 and 2147483647.
    • PageSize - specifies the number of items to return per page. The value must be between 1 and 400.
    • SortField - TODO: Add description for SortField.
    • Order - can be either asc or desc to specify the order of the results.
    • TextFilter - specifies a text string to filter the request metadata by.
    • Level - specifies the risk event level to filter by.
    • Possible values are:
      • 0 - TODO: Add description for Level 0.
      • 1 - TODO: Add description for Level 1.
    • CreatedFrom - specifies the start date for filtering request metadata. The value must be in ISO 8601 format.
    • CreatedTo - specifies the end date for filtering request metadata. The value must be in ISO 8601 format.

    Request Body None

    Response Body

    {
      "succeeded": true,
      "isError": true,
      "errors": [
        {
          "code": "string",
          "description": "string",
          "data": {
            "additionalProp1": "string",
            "additionalProp2": "string",
            "additionalProp3": "string"
          }
        }
      ],
      "data": {
        "page": 0,
        "pageSize": 0,
        "total": 0,
        "totalPages": 0,
        "items": [
          {
            "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "validationResponseId": 0,
            "validationRequestId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "level": 0,
            "type": 0,
            "created": "2026-01-09T17:57:42.831Z"
          }
        ]
      }
    }
    

    Response Fields

    • succeeded (boolean) - Indicates if the request was successful.
    • isError (boolean) - Indicates if there was an error with the request.
    errors � An array of error objects. This will populate if isError = true
    • errors.code The error code.
    • errors.description A description of the error.
    • errors.data Additional data related to the error.
    • errors.data.additionalProp1 Additional property 1. TODO : Add description for additionalProp1.
    • errors.data.additionalProp2 Additional property 2. TODO : Add description for additionalProp2.
    • errors.data.additionalProp3 Additional property 3. TODO : Add description for additionalProp3.
    data � The main response data object. This will populate if isError = false
    • data.page (int) - The current page number.
    • data.pageSize (int) - The number of items per page.
    • data.total (int) - The total number of items.
    • data.totalPages (int) - The total number of pages.
    data.items � An array of risk event objects
    • data.items.id (string) - TODO Add event.
    • data.items.validationResponseId (int) - Response ID associated with the attempt.
    • data.items.validationRequestId (string) - Request ID associated with the attempt.
    • data.items.level (int) - The risk event level.
      • 0 - TODO: Add description for Level 0.
      • 1 - TODO: Add description for Level 1.
    • data.items.type (int) - The risk event type. *1 -MassAttack (RiskLevel.Significant) - the number of validation attempts from a single IP exceeds the specified limit for the given time period.
      • 2 PeriodicAttack (RiskLevel.Moderate) - at least one validation attempt comes from a device with the same fingerprint as previous attempts.
      • 3 FakeRegistration (RiskLevel.Significant) - not implemented.
      • 4 DuplicateRegistration (RiskLevel.Moderate) - not implemented.
      • 5 DuplicateFace (RiskLevel.Significant) - performs checks for a registered face profile using Fractal, but will need some modifications.
      • 6 InconsistentMetadata (RiskLevel.Significant) - (one of the conditions) the IP from WebLib doesn't match the IP received by the server, the phone number's country doesn't match the IP's country, or the time zone from WebLib doesn't match the time zone of the IP.
      • 7 MissingMetadata (RiskLevel.Moderate) - (one of the conditions) in case first/last name for applicant/document are missing, IP/time zone/country number mapping information are missing).
    • data.items.created (string) - The date and time the risk event was created in ISO 8601 format.
    Back to top IDScan.net IDScan.net GitHub