Fetch the details for a specific alert

GET

/alerts/:alertId

GET

/transaction/v2/alerts/:alertId

1 curl https://api.frankiefinancial.io/transaction/v2/alerts/db30f17e-5e79-4185-b7d5-6dfc06478055 \
2      -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3      -H "apiKey: <apiKey>"

Try it

200Retrieved

1 {
2   "activityType": "REGISTRATION",
3   "alertId": "db30f17e-5e79-4185-b7d5-6dfc06478055",
4   "checkId": "7eb4432d-398b-40f7-b24b-7d1208b83e2a",
5   "createdDate": "foo",
6   "entityId": "98ded7ac-2457-4bde-b27c-fcee05301262",
7   "issueType": "DEVICE",
8   "lastUpdated": "foo",
9   "resultId": "89022126-ae30-4d06-b73d-95cf16230d3c",
10   "riskLevel": "NONE",
11   "source": "foo",
12   "status": "PENDING",
13   "transactionTimestamp": "foo",
14   "amount": {
15     "value": "foo",
16     "currCode": "foo"
17   },
18   "assignedTo": "foo",
19   "deviceId": "foo",
20   "originatingCheck": {
21     "riskToken": {
22       "sessionKey": "foo",
23       "userId": "foo"
24     },
25     "transactionId": "foo",
26     "customer": {
27       "customerId": "foo",
28       "customerType": "foo",
29       "dataSource": "foo",
30       "productType": "foo",
31       "entityId": "98ded7ac-2457-4bde-b27c-fcee05301262",
32       "createdDatetime": "foo",
33       "firstName": "foo",
34       "middleName": "foo",
35       "lastName": "foo",
36       "dob": "1983-04-22",
37       "address": {
38         "country": "Testalia",
39         "addressId": "foo",
40         "addressType": "OTHER",
41         "startDate": "foo",
42         "endDate": "foo",
43         "careOf": "foo",
44         "unitNumber": "Suite 1006",
45         "streetNumber": "42a",
46         "streetName": "Test Eagle",
47         "streetType": "Road",
48         "buildingName": "Tower of Power",
49         "suburb": "Testbeds",
50         "town": "Testville",
51         "region": "Test County",
52         "state": "TST",
53         "postalCode": "123-TST"
54       },
55       "email": "foo",
56       "phone": "foo",
57       "consent": "UNKNOWN",
58       "nationalId": "foo",
59       "companyName": "foo",
60       "extraData": {},
61       "frankieId": "98ded7ac-2457-4bde-b27c-fcee05301262"
62     },
63     "activity": {
64       "activityType": "REGISTRATION",
65       "timestamp": "foo",
66       "customerTransaction": {
67         "paymentRole": "TXN_ROLE_ORIGINATOR",
68         "paymentType": "CARD",
69         "paymentDesc": "foo",
70         "paymentId": "foo",
71         "paymentAmount": 42,
72         "paymentStatus": "foo",
73         "currencyCode": "foo",
74         "transactionType": "BUY",
75         "order": {
76           "prevOrderCount": 42,
77           "lastOrderDate": "1983-04-22",
78           "orderChannel": "foo",
79           "prevUnpaidOrderCount": 42
80         },
81         "disbursementType": "BILLPAY",
82         "merchant": {
83           "id": "foo",
84           "mcc": "foo",
85           "category": "foo"
86         },
87         "transferType": "ACH",
88         "accountType": "CHECKING",
89         "accountPan": "foo",
90         "hashedPan": "foo",
91         "maskedPan": "foo",
92         "accountRoute": "foo",
93         "accountIban": "foo",
94         "accountSwift": "foo",
95         "accountName": "foo",
96         "accountClass": "PERSONAL",
97         "accountExtId": "foo",
98         "accountExtType": "EXTERNAL_IDNO",
99         "extraData": {}
100       },
101       "counterParty": {
102         "partyDetails": {
103           "customerId": "foo",
104           "customerType": "foo",
105           "dataSource": "foo",
106           "productType": "foo",
107           "entityId": "98ded7ac-2457-4bde-b27c-fcee05301262",
108           "frankieId": "98ded7ac-2457-4bde-b27c-fcee05301262",
109           "createdDatetime": "foo",
110           "firstName": "foo",
111           "middleName": "foo",
112           "lastName": "foo",
113           "dob": "1983-04-22",
114           "address": {
115             "addressId": "foo",
116             "addressType": "OTHER",
117             "startDate": "foo",
118             "endDate": "foo",
119             "careOf": "foo",
120             "unitNumber": "Suite 1006",
121             "streetNumber": "42a",
122             "streetName": "Test Eagle",
123             "streetType": "Road",
124             "buildingName": "Tower of Power",
125             "suburb": "Testbeds",
126             "town": "Testville",
127             "region": "Test County",
128             "state": "TST",
129             "country": "Testalia",
130             "postalCode": "123-TST"
131           },
132           "email": "foo",
133           "phone": "foo",
134           "consent": "UNKNOWN",
135           "nationalId": "foo",
136           "companyName": "foo",
137           "extraData": {}
138         },
139         "transactionDetails": {
140           "paymentRole": "TXN_ROLE_ORIGINATOR",
141           "paymentType": "CARD",
142           "paymentDesc": "foo",
143           "paymentId": "foo",
144           "paymentAmount": 42,
145           "paymentStatus": "foo",
146           "currencyCode": "foo",
147           "transactionType": "BUY",
148           "order": {
149             "prevOrderCount": 42,
150             "lastOrderDate": "1983-04-22",
151             "orderChannel": "foo",
152             "prevUnpaidOrderCount": 42
153           },
154           "disbursementType": "BILLPAY",
155           "merchant": {
156             "id": "foo",
157             "mcc": "foo",
158             "category": "foo"
159           },
160           "transferType": "ACH",
161           "accountType": "CHECKING",
162           "accountPan": "foo",
163           "hashedPan": "foo",
164           "maskedPan": "foo",
165           "accountRoute": "foo",
166           "accountIban": "foo",
167           "accountSwift": "foo",
168           "accountName": "foo",
169           "accountClass": "PERSONAL",
170           "accountExtId": "foo",
171           "accountExtType": "EXTERNAL_IDNO",
172           "extraData": {}
173         }
174       }
175     },
176     "device": {
177       "id": "foo",
178       "origin": "foo",
179       "os": "foo",
180       "browser": "foo",
181       "platform": "foo",
182       "riskScore": 42,
183       "ip": "foo",
184       "ipGeoAsn": "foo",
185       "ipGeoCity": "foo",
186       "ipGeoCountry": "foo",
187       "ipGeoLat": "foo",
188       "ipGeoLong": "foo",
189       "isBot": true,
190       "isRat": true,
191       "isMobileBot": true,
192       "isRecentRat": true,
193       "isSupported": true,
194       "isEmulated": true,
195       "session": "foo",
196       "activity": "foo",
197       "extraData": {}
198     },
199     "extraData": {},
200     "checkId": "foo"
201   },
202   "paymentId": "foo",
203   "paymentType": "CARD",
204   "riskToken": {
205     "sessionKey": "foo",
206     "userId": "foo"
207   },
208   "sourceLink": "foo",
209   "subtype": "foo"
210 }

Path parameters

alertIdstringRequired

Unique identifier of a Transaction Check Alert

Response

Alert information

activityTypeenum

Type of the activity that was used for the check

alertIdstring

The unique identifier for an alert that has been created when customer configuration thresholds are breached.

checkIdstring

The unique identifier for a transaction monitoring check that was execute for a transaction

createdDatestringformat: "datetime"

ISO-8601 format date-time that the alert was created

entityIdstring

The unique identifier for a FrankieOne entity construct

issueTypeenum

Enum of risk assessment groupings, such as customer, device, transaction, AML, PEP as determined by the risk checking service

Allowed values:

lastUpdatedstringformat: "datetime"

ISO-8601 format date-time of the time that alert was last updated

resultIdstring

The unique identifier for a result that was returned from a transaction check

riskLevelenum

Level of risk as determined by the service.

Allowed values:

sourcestring

Name of the upstream vendor of where the alert came from

statusenum

Current status of an alert

Allowed values:

transactionTimestampstringformat: "datetime"

ISO-8601 format date-time that the transaction occurred

amountobject or null

The amount described in the transaction risk check

assignedTostring or null

Current FrankieOne Portal user that is assigned to this user

deviceIdstring or null

Identifier of the device that was used for this check, this would be provided from the initial request data

originatingCheckobject or null

A recorded activity that is/has been assessed by the Transaction Monitoring Service

paymentIdstring or null

Identifier for the customer transaction, only populated for financial transaction checks

paymentTypeenum or null

The type of payment that the transaction used.

Allowed values:

riskTokenobject or null

Includes any data required for authorizations by upstream services. To confirm if this is required, please reach out to the FrankieOne Support team.

sourceLinkstring or null

URL to the upstream vendor to provide more information about the transaction

subtypestring or null

The subtype of the risk check

Fetch the details for a specific alert

Path parameters

Headers

Response

Errors