Skip to main content
GET
/
entities
/
{entityId}
/
risk
Get an entity's risk level scorecard
curl --request GET \
  --url https://api.frankiefinancial.io/transaction/v2/entities/{entityId}/risk \
  --header 'X-Frankie-CustomerID: <x-frankie-customerid>' \
  --header 'apiKey: <api-key>'
{
  "overall": {
    "aml": {
      "rating": 2.3,
      "level": "MEDIUM"
    },
    "fraud": {
      "rating": 2.3,
      "level": "MEDIUM"
    },
    "firstCheckDate": "2006-01-02T15:04:05-0700",
    "lastUpdated": "2006-01-02T15:04:05-0700"
  },
  "factors": {
    "aml": [
      {
        "name": "<string>",
        "description": "<string>",
        "rating": 3.4,
        "level": "MEDIUM",
        "count": 10
      }
    ],
    "fraud": [
      {
        "name": "<string>",
        "description": "<string>",
        "rating": 3.4,
        "level": "MEDIUM",
        "count": 10
      }
    ]
  },
  "issues": [
    {
      "type": "TXN_AML",
      "activities": [
        "REGISTRATION"
      ],
      "lastUpdated": "2006-01-02T15:04:05-0700",
      "dateCreated": "2006-01-02T15:04:05-0700"
    }
  ]
}

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