Sign in

v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB
CRR

Get CRR

Get a CRR record by ID.

get/crr/{risk_score_id}

Path parameters

risk_score_idstring uuid required
Example:7503cd8a-903b-4fee-aa54-da3dc71f4124

ID of the risk score

Response

CRR record

business_idstring uuid

ID of the customer that the risk score applies to. Either customer_id or business_id will be provided but not both

calculated_scoreinteger

The organically calculated risk score via the weighted average formula. When auto_high is triggered, risk_score is forced to 100 but this field preserves the original calculated value.

creator_idstring uuid

ID of the user that created risk score. creator_id will be null if score was calculated automatically

customer_idstring uuid

ID of the customer that the risk score applies to. Either customer_id or business_id will be provided but not both

idstring uuid required

Risk score record unique ID

notestring

The attached note for the risk score. An note is always added when a score has been overridden by a user

risk_level'HIGH' | 'LOW' | 'MEDIUM' required

Risk score classification

risk_scoreinteger required

The calculated risk score for the customer/business. When auto_high is triggered, this is forced to 100.

tenantstring required

The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.

valid_fromstring date-time

The start date that this risk score came into effect.

valid_tostring date-time

The end date that this risk score came into effect.

Example response

{
  "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"
}