LogoLogo
SupportSign Up
IntroductionOneSDKKYCKYBPortalFraudAPIRelease Notes
IntroductionOneSDKKYCKYBPortalFraudAPIRelease Notes
  • Guide to the API
    • Introduction
    • Common API Objects & Fields
    • Country Specific ID Document Requirements
    • OCR extraction API
    • Using the Sandbox
  • Financial API Endpoints
  • Fraud & AML API Endpoints
  • IDV API Endpoints
    • POSTMark all data from an IDV check as captured
    • POSTProcess an identity document photo for ocr
    • POSTProcess results of IDV check. Optionally re-process results
    • POSTRetrieve a token to use with a check
    • POSTProvide onboarding url for hosted onesdk
  • KYB Trust Agent
  • KYB V2 API - Preview
SupportSign Up
Fraud & AML API EndpointsCases

List all cases

Deprecated
GET
/entity/:entityId/cases
GET
/transaction/v2/entity/:entityId/cases
1curl -G https://api.frankiefinancial.io/transaction/v2/entity/98ded7ac-2457-4bde-b27c-fcee05301262/cases \
2 -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3 -H "apiKey: <apiKey>" \
4 --data-urlencode type=AML,FRAUD
Try it
200Retrieved
1{
2 "data": [
3 {
4 "checkId": "string",
5 "resultId": "string",
6 "riskToken": {
7 "sessionKey": "string",
8 "userId": "string"
9 },
10 "paymentId": "string",
11 "transactionTimestamp": "string",
12 "timestamp": "string",
13 "lastUpdated": "string",
14 "status": "PENDING",
15 "riskLevel": "NONE",
16 "activityType": "REGISTRATION",
17 "paymentType": "CARD",
18 "source": "string",
19 "sourceLink": "string",
20 "deviceId": "string",
21 "assignedTo": "string",
22 "amount": {
23 "value": "string",
24 "currCode": "string"
25 },
26 "issueType": "DEVICE",
27 "subtype": "string"
28 }
29 ],
30 "nextPageToken": "string"
31}
List all cases for an entity from previously checked activities.

Path parameters

entityIdstringRequired
Unique identifier of a FrankieOne entity

Headers

apiKeystringRequired
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne

Query parameters

typestringOptional
comma delimited list of EnumRiskResultType
needsAttentionbooleanOptionalDefaults to 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.
limitdoubleOptionalDefaults to 20
Number of results to be presented in the case results
nextPageTokenstringOptional
Identifier Index for the next page of results

Response

Response from the GET /entity/{entityId}/cases endpoint
datalist of objects or null
List of transaction check results found from the query
nextPageTokenstring or null
Identifier for the next page of results, if not populated there is no more results to paginate for

Errors

Was this page helpful?
Previous

Resolve cases for an entity

Next
Built with
Unique identifier of a FrankieOne entity
Your Customer ID provided by FrankieOne
Your Customer Child ID provided by FrankieOne
comma delimited list of EnumRiskResultType
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.
Number of results to be presented in the case results
Identifier Index for the next page of results

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