Skip to main content

Antifraud

The following endpoints provide the available functionalities for Antifraud management.


Create fraud marker​

Endpoint to create a fraud marker.

Idempotency

The fraud marker creation operation is idempotent. To ensure idempotency, the request contains a RequestId field, which must be unique within the context of the same participant.

POST /dict/fraud-markers
Requires authorization for the scope: antifraud.ind.write


Request

{
  "fraudMarker": {
    "fraudType": "MULE_ACCOUNT",
    "key": "[email protected]",
    "taxIdNumber": "01234567890"
  },
  "requestId": "a946d533-7f22-42a5-9a9b-e87cd55c0f4d"
}

Responses

The responses below represent Success (200) and Failure/Error cases.

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "responseTime": 299,
  "fraudMarker": {
    "taxIdNumber": "01234567890",
    "key": "[email protected]",
    "fraudType": "MULE_ACCOUNT",
    "identification": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
    "status": "REGISTERED",
    "creationTime": "2020-01-17T10:00:00.000Z",
    "lastModified": "2020-01-17T10:00:00.000Z"
  }
}

Get fraud marker​

Endpoint to retrieve details of a fraud marker.

GET /dict/fraud-markers/:fraudMarkerId
Requires authorization for the scope: antifraud.ind.read


Request

The request sent to this endpoint does not require a body, only the OAuth authorization headers, parameters, and account certificate.

Responses

The responses below represent Success (200) and Failure/Error cases.

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "fraudMarker": {
    "creationTime": "2020-01-17T10:00:00.000Z",
    "fraudType": "MULE_ACCOUNT",
    "id": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
    "key": "[email protected]",
    "lastModified": "2020-01-17T10:00:00.000Z",
    "status": "REGISTERED",
    "taxIdNumber": "01234567890"
  },
  "responseTime": 0
}

Cancel fraud marker​

Endpoint to cancel a fraud marker.

It can be performed by the participant who created the fraud marker.

A fraud marker created as a result of closing an infraction notification can be canceled by the counterparty participant who closed the notification.

Idempotency

The operation is idempotent. If the record has already been canceled with the same parameters, a response equivalent to the first request will be returned.

POST /dict/fraud-markers/:fraudMarkerId/cancel
Requires authorization for the scope: antifraud.ind.write


Request

{
  "fraudMarkerId": "91d65e98-97c0-4b0f-b577-73625da1f9fc"
}

Responses

The responses below represent Success (200) and Failure/Error cases.

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "fraudMarker": {
    "creationTime": "2020-01-17T10:00:00.000Z",
    "fraudType": "MULE_ACCOUNT",
    "id": "91d65e98-97c0-4b0f-b577-73625da1f9fc",
    "key": "[email protected]",
    "lastModified": "2023-01-17T10:00:00.000Z",
    "status": "CANCELLED",
    "taxIdNumber": "01234567890"
  },
  "responseTime": 0
}

Get person statistics​

Endpoint to retrieve statistical data of an end user.

GET /dict/persons/:taxIdNumber/statistics
Requires authorization for the scope: statistics.ind.read


Request

The request sent to this endpoint does not require a body, only the OAuth authorization headers, parameters, and account certificate.

Responses

The responses below represent Success (200) and Failure/Error cases.

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "personStatistics": {
    "entries": {
      "registeredAccounts": 0,
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "fraudMarkers": {
      "applicationFrauds": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "distinctFraudReporters": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "muleAccounts": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "otherFrauds": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "scammerAccounts": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "totalFraudTransactionAmount": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "unknownFrauds": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "infractionReports": {
      "openReports": 0,
      "openReportsDistinctReporters": 0,
      "rejectedReports": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "spi": {
      "settlements": {
        "d90": 0,
        "m12": 0,
        "m60": 0
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    }
  },
  "responseTime": 0,
  "taxIdNumber": "12345678901"
}

Get registered key statistics​

Endpoint to retrieve statistical data related to a registered key.

GET /dict/entries/:key/statistics
Requires authorization for the scope: statistics.ind.read


Request

The request sent to this endpoint does not require a body, only the OAuth authorization headers, parameters, and account certificate.

Responses

The responses below represent Success (200) and Failure/Error cases.

{
  "correlationId": "abcdef01-2345-6789-0123-456789012345",
  "responseTime": 300,
  "key": "11122233300",
  "keyStatistics": {
    "entries": {
      "distinctAccounts": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "fraudMarkers": {
      "applicationFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "distinctFraudReporters": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "muleAccounts": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "otherFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "scammerAccounts": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "totalFraudTransactionAmount": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "unknownFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "infractionReports": {
      "openReports": "0",
      "openReportsDistinctReporters": "0",
      "rejectedReports": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "spi": {
      "settlements": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    }
  },
  "ownerStatistics": {
    "entries": {
      "registeredAccounts": "0",
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "fraudMarkers": {
      "applicationFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "distinctFraudReporters": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "muleAccounts": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "otherFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "scammerAccounts": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "totalFraudTransactionAmount": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "unknownFrauds": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "infractionReports": {
      "openReports": "0",
      "openReportsDistinctReporters": "0",
      "rejectedReports": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    },
    "spi": {
      "settlements": {
        "d90": "0",
        "m12": "0",
        "m60": "0"
      },
      "watermark": "2023-01-01T10:00:00.000Z"
    }
  }
}

Last updated on