Skip to main content
PATCH
/
entity
/
{entityId}
/
cases
/
{caseId}
Update a case
curl --request PATCH \
  --url https://api.frankiefinancial.io/transaction/v2/entity/{entityId}/cases/{caseId} \
  --header 'Content-Type: application/json' \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'apiKey: <api-key>' \
  --data '
{
  "createdBy": "[email protected]",
  "comment": "Case has been manually reviewed to be a false positive",
  "newStatus": "PENDING",
  "assignedTo": "[email protected]"
}
'
{
  "requestId": "<string>"
}

Authorizations

​
apiKey
string
header
required

API key issued by FrankieOne. This will rotate regularly.

Headers

​
X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

​
X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

Path Parameters

​
entityId
string
required

Unique identifier of a FrankieOne entity The unique identifier for a FrankieOne entity construct

Example:

"98ded7ac-2457-4bde-b27c-fcee05301262"

​
caseId
string<uuid>
required

Unique Identifier of a Transaction Check Result

Body

application/json

Describes the update to a case status check, either via a comment appended to the case, a status update or an assignment of the case to another user

​
createdBy
string
required

User ID of the User that created the comment

Example:

"[email protected]"

​
comment
string
Maximum string length: 4028
Example:

"Case has been manually reviewed to be a false positive"

​
newStatus
enum<string>

Current status of an alert

Available options:
PENDING,
APPROVED,
MANUALLY_APPROVED,
MANUALLY_DECLINED
​
assignedTo
string

User ID of the User that the case was assigned to

Example:

"[email protected]"

Response

The request was valid and can potentially be fulfilled. The FrankieOne service has now accepted responsibility for processing and we will either push the results to you, or send you a notification, depending on the request and your configuration.

The request was valid and can potentially be fulfilled. The FrankieOne service has now accepted responsibility for processing and we will either push the results to you, or send you a notification, depending on the request and your configuration.

​
requestId
string<ulid>

Unique identifier assigned by FrankieOne for every request. Can be used for tracking down answers with technical support. Uses the ULID format (a time-based, sortable UUID) example: 01BFJA617JMJXEW6G7TDDXNSHX

Required string length: 26