v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

CRR

List CRRs

Get paginated list of CRR

get/crr

Query parameters

customer_idstring uuid

Example:77275c65-8702-4b27-8e60-20f4292054ac

ID of the customer that the risk score applies to

include_historyboolean

If true, include old risk scores in the response

page_tokenstring

Optional pagination token to be provided to retrieve subsequent pages, returned from previous get

Example:a8937a0d

limitinteger

Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.

Example:100

business_idstring uuid

Example:edebece0-4a06-4806-b062-7de25a848be8

ID of the business that the risk score applies to

Response

List of CRR for customers, or businesses

next_page_tokenstring

If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.

Example response

{
  "next_page_token": "a8937a0d",
  "risk_scores": [
    {
      "business_id": "06a644f6-2623-4dd2-b2cd-da8a8667515e",
      "calculated_score": 47,
      "calculations_breakdown": [
        {
          "condition": {
            "upper": 150000,
            "weight": 75
          },
          "parameter_label": "Customer Country",
          "parameter_score": 46.42,
          "parameter_weight": 25
        }
      ],
      "creator_id": "53869fb3-c58e-4a49-badb-7b273a7bdd34",
      "customer_id": "272878fe-355f-4308-8d1d-4c7d43d698f6",
      "id": "7503cd8a-903b-4fee-aa54-da3dc71f4124",
      "note": "Customer was found on a watchlist. Setting the risk score to 80",
      "risk_score": 37,
      "tenant": "abcdef_ghijkl",
      "valid_from": "2023-01-05T11:23:34.321Z",
      "valid_to": "2024-01-05T11:23:34.321Z"
    }
  ]
}