Get an entity's risk level scorecard

GET

Get current risk level of an entity from fraud or transaction monitoring.

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

Response

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

overallobjectOptional

factorsobjectOptional

issueslist of objectsOptional

Results that have been evaluated for this entity, the lack of Result object value for a Result Type indicates that a check has been done for a transaction resulting in that result being produced

GET

1 curl https://api.kycaml.uat.frankiefinancial.io/transaction/v2/entities/98ded7ac-2457-4bde-b27c-fcee05301262/risk \
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>"

200Retrieved

1 {
2   "overall": {
3     "aml": {
4       "rating": 2.3,
5       "level": "NONE"
6     },
7     "fraud": {
8       "rating": 2.3,
9       "level": "NONE"
10     },
11     "firstCheckDate": "2006-01-02T15:04:05-0700",
12     "lastUpdated": "2006-01-02T15:04:05-0700"
13   },
14   "factors": {
15     "aml": [
16       {
17         "name": "name",
18         "description": "description",
19         "rating": 3.4,
20         "level": "NONE",
21         "count": 10
22       }
23     ],
24     "fraud": [
25       {
26         "name": "name",
27         "description": "description",
28         "rating": 3.4,
29         "level": "NONE",
30         "count": 10
31       }
32     ]
33   },
34   "issues": [
35     {
36       "type": "TXN_AML",
37       "activities": [
38         "REGISTRATION"
39       ],
40       "lastUpdated": "2006-01-02T15:04:05-0700",
41       "dateCreated": "2006-01-02T15:04:05-0700"
42     }
43   ]
44 }

Fetch all alerts

Up Next

Built with

1	curl https://api.kycaml.uat.frankiefinancial.io/transaction/v2/entities/98ded7ac-2457-4bde-b27c-fcee05301262/risk \
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>"

1	{
2	"overall": {
3	"aml": {
4	"rating": 2.3,
5	"level": "NONE"
6	},
7	"fraud": {
8	"rating": 2.3,
9	"level": "NONE"
10	},
11	"firstCheckDate": "2006-01-02T15:04:05-0700",
12	"lastUpdated": "2006-01-02T15:04:05-0700"
13	},
14	"factors": {
15	"aml": [
16	{
17	"name": "name",
18	"description": "description",
19	"rating": 3.4,
20	"level": "NONE",
21	"count": 10
22	}
23	],
24	"fraud": [
25	{
26	"name": "name",
27	"description": "description",
28	"rating": 3.4,
29	"level": "NONE",
30	"count": 10
31	}
32	]
33	},
34	"issues": [
35	{
36	"type": "TXN_AML",
37	"activities": [
38	"REGISTRATION"
39	],
40	"lastUpdated": "2006-01-02T15:04:05-0700",
41	"dateCreated": "2006-01-02T15:04:05-0700"
42	}
43	]
44	}