Fraud Case Management

Broadcast a fraud alert

Broadcast a fraud alert for the given Fraud Case.

SecurityapiKey
Request
path Parameters
fraudCaseId
required
string

ID of the Fraud Case that the alert is about

Example: oaRnfC1D1Q
Responses
200

Alert triggered

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Unsupported Media Type

503

Service Unavailable

post/fraudcases/{fraudCaseId}/triggeralert
Request samples
Response samples
{
  • "id": "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a",
  • "timestamp": "2024-06-20T07:02:21Z",
  • "message": "This user is not allowed to access this service.",
  • "error": "BAD_REQUEST",
  • "path": "/v2/businesspartners/lookup",
  • "status": "400"
}

Create a Fraud Case

Create a new Fraud Case with the given data.

SecurityapiKey
Request
Request Body schema:
required
object (FraudCase)

-> Represents a fraud case with properties such as the unique identifier of the case, its version, the date of the attack, and the type of the fraud case.

Responses
201

Created

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Unsupported Media Type

503

Service Unavailable

post/fraudcases
Request samples
{
  • "fraudCase": {
    }
}
Response samples
{
  • "cdlId": "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a",
  • "version": "1",
  • "dateOfAttack": "2024-06-20T07:02:21Z",
  • "type": "ACTIVE_WARNING",
  • "description": "Fraud case description",
  • "internalComment": "Internal comment",
  • "confirmationState": "CONFIRMED",
  • "classification": "STANDARD",
  • "businessPartnerName": "Corporate Data Quality AG",
  • "businessPartnerCountryCode": "CH",
  • "businessPartnerLocality": "Sankt Gallen",
  • "fraudsterEmail": "thisisnot@fraud.com",
  • "fraudsterPhone": "+49123456789",
  • "fraudsterWebsite": "www.thisisnotafraud.com",
  • "alternativePayee": "Alternative payee's name",
  • "bankAccount": {
    },
  • "archived": "false",
  • "alertTriggered": "false",
  • "createdAt": "2024-06-20T07:02:21Z",
  • "creatorOrganization": "Organization name",
  • "createdBy": "User name",
  • "disclosedAttributes": [
    ],
  • "relatedFraudCases": "5"
}

Delete a Fraud Case

Delete a Fraud Case with the given ID.

SecurityapiKey
Request
path Parameters
fraudCaseId
required
string

ID of the Fraud Case that is about to be deleted.

Example: ID?
Responses
200

Deleted

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Unsupported Media Type

503

Service Unavailable

delete/fraudcases/{fraudCaseId}
Request samples
Response samples
{
  • "id": "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a",
  • "timestamp": "2024-06-20T07:02:21Z",
  • "message": "This user is not allowed to access this service.",
  • "error": "BAD_REQUEST",
  • "path": "/v2/businesspartners/lookup",
  • "status": "400"
}

Fraud Cases Statistics

Get statistics about the Fraud Cases.

SecurityapiKey
Responses
200

Fraud Cases Statistics

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Unsupported Media Type

503

Service Unavailable

get/fraudcases/statistics
Request samples
Response samples
{
  • "date": "20240302",
  • "cachedValue": "false",
  • "numberOfAllFraudCases": "10",
  • "numberOfDisclosedFraudCases": "10",
  • "numberOfUndisclosedFraudCases": "10",
  • "numberOfFraudCasesOfTheUsersOrganization": "10",
  • "numberOfDisclosedFraudCasesOfTheUsersOrganization": "10",
  • "numberOfUndisclosedFraudCasesOfTheUsersOrganization": "10"
}

Read Fraud Cases

Read a page of Fraud Cases.

SecurityapiKey
Request
query Parameters
classification
string (FraudCaseClassification)
Default: "STANDARD"

Classification used to filter results.

Example: classification=STANDARD
page
integer
Default: 0

The page index. The index of the first page is 0.

Example: page=0
pageSize
integer
Default: 200

Number of records listed on one page.

Example: pageSize=200
search
string

The phrase that the query will look for.

Example: search=phrase
sort
string
Default: "creationTimestamp"

Defines the attributes to sort by.

Example: sort=-dateOfAttack
Responses
200

Page of Fraud Cases

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Unsupported Media Type

503

Service Unavailable

get/fraudcases
Request samples
Response samples
{
  • "page": "0",
  • "pageSize": "20",
  • "numberOfPages": "10",
  • "recordCount": "2000",
  • "sortField": "dateOfAttack",
  • "ascending": "true",
  • "fraudCases": [
    ]
}

Update a Fraud Case

Update a Fraud Case with the given data.

SecurityapiKey
Request
path Parameters
fraudCaseId
required
string

ID of the Fraud Case that is being updated.

Example: oaRnfC1D1Q
Request Body schema:
required
object (FraudCase)

-> Represents a fraud case with properties such as the unique identifier of the case, its version, the date of the attack, and the type of the fraud case.

Responses
200

Updated

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

406

Unsupported Media Type

503

Service Unavailable

put/fraudcases/{fraudCaseId}
Request samples
{
  • "fraudCase": {
    }
}
Response samples
{
  • "cdlId": "5c6a2c7e-9b0a-4e1a-8b0a-4e1a8b0a4e1a",
  • "version": "1",
  • "dateOfAttack": "2024-06-20T07:02:21Z",
  • "type": "ACTIVE_WARNING",
  • "description": "Fraud case description",
  • "internalComment": "Internal comment",
  • "confirmationState": "CONFIRMED",
  • "classification": "STANDARD",
  • "businessPartnerName": "Corporate Data Quality AG",
  • "businessPartnerCountryCode": "CH",
  • "businessPartnerLocality": "Sankt Gallen",
  • "fraudsterEmail": "thisisnot@fraud.com",
  • "fraudsterPhone": "+49123456789",
  • "fraudsterWebsite": "www.thisisnotafraud.com",
  • "alternativePayee": "Alternative payee's name",
  • "bankAccount": {
    },
  • "archived": "false",
  • "alertTriggered": "false",
  • "createdAt": "2024-06-20T07:02:21Z",
  • "creatorOrganization": "Organization name",
  • "createdBy": "User name",
  • "disclosedAttributes": [
    ],
  • "relatedFraudCases": "5"
}