---
title: "List CRRs"
method: GET
path: "/crr"
tags: ["CRR"]
---

# List CRRs

`GET /crr`

Get paginated list of CRR

## Query parameters

- `customer_id` string, uuid
- `include_history` boolean
- `page_token` string — Optional pagination token to be provided to retrieve subsequent pages, returned from previous get
- `limit` integer — Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100.
- `business_id` string, uuid

## Response `200`

List of CRR for customers, or businesses

- CrrList
  - `next_page_token` string — If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows.
  - `risk_scores` CrrResponse[], required — Array of risk scores
    - `business_id` string, uuid — ID of the customer that the risk score applies to. Either customer_id or business_id will be provided but not both
    - `calculated_score` integer — 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.
    - `calculations_breakdown` CalculationBreakdown[] — An array that holds the calculated weights for each risk parameter that was used in the score calculation
      - `auto_high_risk_triggered` boolean — Whether this parameter triggered auto-high risk in the calculation
      - `condition` Condition — The parameter condition was used in the score calculation
        - `lower` integer — If the condition type is RANGE. condition_lower is the field that stores the lower value of the condition
        - `type` 'CATEGORICAL' | 'NONE' | 'RANGE', required — Conditions can be of type CATEGORICAL or RANGE where the weight is determined by the lower and upper limit fields. NONE is used for parameters like EXTERNAL_SCORE that have no conditions.
        - `upper` integer — If the condition type is RANGE. condition_upper is the field that stores the upper value of the condition
        - `value` string — If the condition type is CATEGORICAL. condition_value is the field that stores the discrete value
        - `weight` integer, required — The weight of the condition as specified in the risk config. For EXTERNAL_SCORE (condition type NONE), this is the applied external score value at the time of calculation, sourced from risk_config_external_score. EXTERNAL_SCORE has no config-defined conditions.
      - `overridden_score` number, double — Additional score points attributed from auto-high override. The remainder (100 - calculated_score) is divided evenly across all auto-high parameters.
      - `parameter_label` string — The user-friendly label for the parameter
      - `parameter_name` 'ADVERSE_MEDIA' | 'AML_CASE_DISPOSITION' | 'ANNUAL_INCOME' | 'BUSINESS_CATEGORY' | 'CIP' | 'CUSTOMER_COUNTRY' | 'CUSTOMER_TENURE' | 'EXTERNAL_SCORE' | 'FINANCIAL_SERVICES' | 'HIDTA_HIFCA' | 'INDUSTRY' | 'OWNERSHIP_STRUCTURE' | 'PARTNER_TYPE' | 'PAYMENT_TYPE' | 'PEP_CLASSIFICATION' | 'SPECIAL_INVOLVEMENT' | 'TRANSACTION_GEOGRAPHY' — The name of the parameter that was used in the score calculation
      - `parameter_score` number, double, required — The calculated weight of the risk param. calculated_weight = parameter weight/sum(parameters weight) * 100
      - `parameter_weight` integer, required — The weight of the risk param as defined in the risk config
    - `creator_id` string, uuid — ID of the user that created risk score. creator_id will be null if score was calculated automatically
    - `customer_id` string, uuid — ID of the customer that the risk score applies to. Either customer_id or business_id will be provided but not both
    - `id` string, uuid, required — Risk score record unique ID
    - `note` string — 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_score` integer, required — The calculated risk score for the customer/business. When auto_high is triggered, this is forced to 100.
    - `tenant` string, required — The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces.
    - `valid_from` string, date-time — The start date that this risk score came into effect.
    - `valid_to` string, date-time — The end date that this risk score came into effect.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden error
- `500` — Internal server error

---

[API](https://skmtc.net/synctera/apis/synctera-api.md) · [All operations](https://skmtc.net/synctera/apis/synctera-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/synctera/synctera-api/revisions/b0d812e6cdd0/schema)