Fraud & AML API EndpointsRisk

Get an entity's risk level scorecard

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

Authentication

apiKeystring
API Key authentication via header

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

overallobject or null
factorsobject or null
issueslist of objects or null
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

Errors