Skip to main content
GET
Get an entity's risk level scorecard

Authorizations

apiKey
string
header
required

API key issued by FrankieOne. This will rotate regularly.

Headers

X-Frankie-CustomerID
string
required

Your Customer ID provided by FrankieOne

Example:

"12345678-1234-1234-1234-123456789012"

X-Frankie-CustomerChildID
string

Your Customer Child ID provided by FrankieOne

Example:

"87654321-4321-4321-4321-210987654321"

Path Parameters

entityId
string
required

Unique identifier of a FrankieOne entity The unique identifier for a FrankieOne entity construct

Example:

"98ded7ac-2457-4bde-b27c-fcee05301262"

Response

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

overall
object
factors
object
issues
object[]

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