Skip to main content
GET
/
entity
/
{entityId}
/
cases
List all cases
curl --request GET \
  --url https://api.frankiefinancial.io/transaction/v2/entity/{entityId}/cases \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'apiKey: <api-key>'
{
  "data": [
    {
      "checkId": "<string>",
      "resultId": "<string>",
      "riskToken": {
        "sessionKey": "<string>",
        "userId": "<string>"
      },
      "paymentId": "<string>",
      "transactionTimestamp": "<string>",
      "timestamp": "<string>",
      "lastUpdated": "<string>",
      "status": "PENDING",
      "riskLevel": "MEDIUM",
      "activityType": "REGISTRATION",
      "paymentType": "CARD",
      "source": "<string>",
      "sourceLink": "<string>",
      "deviceId": "<string>",
      "assignedTo": "<string>",
      "amount": {
        "value": "<string>",
        "currCode": "<string>"
      },
      "issueType": "DEVICE",
      "subtype": "<string>"
    }
  ],
  "nextPageToken": "<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"

Query Parameters

type
string

comma delimited list of EnumRiskResultType

needsAttention
boolean
default:false

A flag to fetch only the cases that require attention from users. These are cases that have met a MEDIUM risk level and have a PENDING status.

limit
number
default:20

Number of results to be presented in the case results

nextPageToken
string

Identifier Index for the next page of results

Response

Response from the GET /entity/{entityId}/cases endpoint

data
object[]

List of transaction check results found from the query

nextPageToken
string

Identifier for the next page of results, if not populated there is no more results to paginate for