List all cases

Deprecated

GET

List all cases for an entity from previously checked activities.

Path parameters

entityIdstringRequired

Unique identifier of a FrankieOne entity

Headers

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 objectsOptional

List of transaction check results found from the query

nextPageTokenstringOptional

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

GET

1 curl -G https://api.kycaml.uat.frankiefinancial.io/transaction/v2/entity/98ded7ac-2457-4bde-b27c-fcee05301262/cases \
2      -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3      -H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4      -H "api_key: <apiKey>" \
5      --data-urlencode type=AML,FRAUD

200Retrieved

1 {
2   "data": [
3     {
4       "checkId": "checkId",
5       "resultId": "resultId",
6       "riskToken": {
7         "sessionKey": "sessionKey",
8         "userId": "userId"
9       },
10       "paymentId": "paymentId",
11       "transactionTimestamp": "transactionTimestamp",
12       "timestamp": "timestamp",
13       "lastUpdated": "lastUpdated",
14       "status": "PENDING",
15       "riskLevel": "NONE",
16       "activityType": "REGISTRATION",
17       "paymentType": "CARD",
18       "source": "source",
19       "sourceLink": "sourceLink",
20       "deviceId": "deviceId",
21       "assignedTo": "assignedTo",
22       "amount": {
23         "value": "value",
24         "currCode": "currCode"
25       },
26       "issueType": "DEVICE",
27       "subtype": "subtype"
28     }
29   ],
30   "nextPageToken": "nextPageToken"
31 }

Resolve cases for an entity

Up Next

Built with

1	curl -G https://api.kycaml.uat.frankiefinancial.io/transaction/v2/entity/98ded7ac-2457-4bde-b27c-fcee05301262/cases \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "api_key: <apiKey>" \
5	--data-urlencode type=AML,FRAUD

1	{
2	"data": [
3	{
4	"checkId": "checkId",
5	"resultId": "resultId",
6	"riskToken": {
7	"sessionKey": "sessionKey",
8	"userId": "userId"
9	},
10	"paymentId": "paymentId",
11	"transactionTimestamp": "transactionTimestamp",
12	"timestamp": "timestamp",
13	"lastUpdated": "lastUpdated",
14	"status": "PENDING",
15	"riskLevel": "NONE",
16	"activityType": "REGISTRATION",
17	"paymentType": "CARD",
18	"source": "source",
19	"sourceLink": "sourceLink",
20	"deviceId": "deviceId",
21	"assignedTo": "assignedTo",
22	"amount": {
23	"value": "value",
24	"currCode": "currCode"
25	},
26	"issueType": "DEVICE",
27	"subtype": "subtype"
28	}
29	],
30	"nextPageToken": "nextPageToken"
31	}