Fraud Case Management

Broadcast a fraud alert

SecurityapiKey
Request
path Parameters
fraudCaseId
required
string

ID of the Fraud Case that the alert is about

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": "string",
  • "timestamp": "string",
  • "message": "string",
  • "error": "string",
  • "path": "string",
  • "status": 0
}
Create a Fraud Case
SecurityapiKey 
Request 
Request Body schema: 
required
object (FraudCase) 
 
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": "string",
  • "version": 0,
  • "dateOfAttack": "string",
  • "type": "string",
  • "description": "string",
  • "internalComment": "string",
  • "confirmationState": "string",
  • "classification": "DEMO",
  • "businessPartnerName": "string",
  • "businessPartnerCountryCode": "string",
  • "businessPartnerLocality": "string",
  • "fraudsterEmail": "string",
  • "fraudsterPhone": "string",
  • "fraudsterWebsite": "string",
  • "alternativePayee": "string",
  • "bankAccount": {
    },
  • "archived": true,
  • "alertTriggered": true,
  • "createdAt": "string",
  • "creatorOrganization": "string",
  • "createdBy": "string",
  • "disclosedAttributes": [
    ],
  • "relatedFraudCases": 0
}
Delete a Fraud Case
SecurityapiKey 
Request 
path Parameters
fraudCaseId
required
string
ID of the Fraud Case that is about to be deleted


 
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": "string",
  • "timestamp": "string",
  • "message": "string",
  • "error": "string",
  • "path": "string",
  • "status": 0
}
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": 0,
  • "cachedValue": true,
  • "numberOfAllFraudCases": 0,
  • "numberOfDisclosedFraudCases": 0,
  • "numberOfUndisclosedFraudCases": 0,
  • "numberOfFraudCasesOfTheUsersOrganization": 0,
  • "numberOfDisclosedFraudCasesOfTheUsersOrganization": 0,
  • "numberOfUndisclosedFraudCasesOfTheUsersOrganization": 0
}
Read a Fraud Cases
SecurityapiKey 
Request 
query Parameters
classification
string (FraudCaseClassification) 
 Default:  "STANDARD"
Classification used to filter results.


 
page
integer
 Default:  0
The page index. The index of the first page is 0.


 
pageSize
integer
 Default:  200
Number of records listed on one page.


 
search
string
The phrase that the query will look for.


 
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": 0,
  • "numberOfPages": 0,
  • "recordCount": 0,
  • "sortField": "string",
  • "ascending": true,
  • "fraudCases": [
    ]
}
Update a Fraud Case
SecurityapiKey 
Request 
path Parameters
fraudCaseId
required
string
ID of the Fraud Case that is being updated


 
Request Body schema: 
required
object (FraudCase) 
 
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": "string",
  • "version": 0,
  • "dateOfAttack": "string",
  • "type": "string",
  • "description": "string",
  • "internalComment": "string",
  • "confirmationState": "string",
  • "classification": "DEMO",
  • "businessPartnerName": "string",
  • "businessPartnerCountryCode": "string",
  • "businessPartnerLocality": "string",
  • "fraudsterEmail": "string",
  • "fraudsterPhone": "string",
  • "fraudsterWebsite": "string",
  • "alternativePayee": "string",
  • "bankAccount": {
    },
  • "archived": true,
  • "alertTriggered": true,
  • "createdAt": "string",
  • "creatorOrganization": "string",
  • "createdBy": "string",
  • "disclosedAttributes": [
    ],
  • "relatedFraudCases": 0
}