> ## Documentation Index > Fetch the complete documentation index at: https://docs.synctera.com/llms.txt > Use this file to discover all available pages before exploring further. # List CRRs > Get paginated list of CRR ## OpenAPI ````yaml openapi.json get /crr openapi: 3.0.3 info: description: >- This is the official reference documentation for Synctera APIs. If you need something specific or have a question, contact us.

license: name: Apache 2.0 url: https://www.apache.org/licenses/LICENSE-2.0.html title: Synctera API version: 0.217.0 servers: - description: Sandbox (no real world financial impact) url: https://api-sandbox.synctera.com/v0 - description: Production url: https://api.synctera.com/v0 security: - bearerAuth: [] tags: - description: Lookup merchant information name: Merchants - description: Requests to generate simulated webhooks name: Card Webhook Simulations - description: >- Account programs define configurations for payment rails and transaction capabilities across different account types. name: Account Programs - description: Simulate receiving ACH transactions and returns name: ACH Transaction Simulations - description: Requests for risk evaluation and decisioning name: Risk Evaluations - description: Requests to link and manage External Cards name: External Cards - description: | The disclosures resource is used to track the status of disclosures and ensure that all parties have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures - description: Create and manage Cash Order and Cash Deposit transfers name: Cash Orders and Deposits (alpha) - description: Requests to initiate customer verification. name: KYC Verification (deprecated) - description: Request to create and manage users name: Users - description: See balance history name: BalanceHistory - description: >- Migration mappings associate resources from an old tenant identity with a new tenant identity. name: Migration Mappings - description: | The External Account resource is used for managing links to accounts that operate outside of the Synctera ecosystem. name: External Accounts - description: Requests to create and manage account products, including fees, interest. name: Account Products - description: Requests to create and manage webhooks name: Webhooks - description: Create and manage documents. name: Documents - description: >- Create and manage same currency and multi-currency international wire transfers name: International Wires (alpha) - description: Requests for transaction risk detection name: Transaction risk - description: >- Used to configure bank accounts for which synctera accounts are considered a "subledger" to name: Bank Account - description: Request to create and manage party groups and party group members name: Party Groups - description: Requests to manage addresses name: Addresses - description: Requests to manage monitoring subscriptions and alerts for customers. name: Monitoring - description: Requests to search and manage compliance searches name: Compliance Searches - description: Requests to create and manage customers name: Customers - description: | The internal account resource is used for managing links to internal accounts where the funds are managed by integrators. name: Internal Accounts - description: Create and manage spending controls name: Spend Controls - description: Retrieve user identity information name: Identity - description: Requests to manage banks name: Banks - description: | The Disclosures resource is used to track the status of disclosures and ensure that customers have been shown the necessary disclosures to meet regulatory obligations. name: Disclosures (deprecated) - description: Create and manage wire transfers name: Wires - description: Requests to issue and manage Cards name: Cards - description: Request to create and manage edd name: Trust - description: Request to enroll, renew, or cancel watchlist monitors name: Watchlist (deprecated) - description: Endpoints for modifying or fetching posting dates name: Posting Dates - description: Transaction lines API name: transactions - description: Request to create and manage accounts name: Accounts - description: Requests to create and manage notes name: Notes - description: Account Template name: Account Templates - description: API for effective balances name: effective_balances - description: Requests to create and manage personal ID configurations name: Personal ID Configuration - description: > A natural person (individual human) that is relevant to the Synctera platform in some way: e.g. a personal customer or a director/officer/owner of a business. name: Persons - description: > Represents the relationships between parties. A relationship can exist between personal customers, business customers, or non-customer persons/organizations. name: Relationships - description: > A legal entity (corporation, partnership, etc.) that is relevant to the Synctera platform in some way: a business customer or some other organization that has an ownership share in such a business customer. name: Businesses - description: Request to create and manage payment_schedules name: Cronut - description: Requests to manage partners name: Partners - description: Request to create and manage deposits using remote deposit capture name: Remote Check Deposit - description: Requests to create and manage API keys name: API Keys - description: Requests to create and manage ban rules name: Ban Rules - description: Admin API for Middesk configuration using the tenants API keys. name: Middesk - description: Request to create and manage exclusions name: Stately - description: Request to create and manage partner configurations name: Quickstart - description: Manage contacts for bank and fintech partners name: Contacts - description: Create and manage transactions name: Transactions - description: Request to create and manage rdc configurations name: RDC Config - description: Create and manage holds name: Hold - description: Requests to create and manage roles name: Roles - description: Simulate receiving Wire transactions and returns name: Wire Transaction Simulations - description: Requests to create licenses name: Licenses - description: Requests to Admins to grant permissions to user name: Request Permissions - description: Configure vendor secrets for egress requests name: Egress Gateway Vendor Secret CRUD API - description: Requests to screen parties against sanctions watchlists name: Sanctions Screening - description: Create and manage payments name: ACH - description: Requests to calculate and manage CRR name: CRR - description: Requests to search financial institutions name: Institutions (Beta) - description: Create and manage tenant configurations name: Tenant Configs - description: Create and manage sweep configurations name: Configs - description: > Represents the compliance rules that are used to verify certain kinds of money movement. name: Compliance Rules - description: Configure webhook secrets for egress requests name: Egress Gateway Webhook Secret CRUD API - description: Create and manage transactions name: Transactions (internal) - description: History name: History - description: Create and manage EFT Canada transfers name: EFT Canada (Beta) - description: Requests to generate simulated transactions name: Card Transaction Simulations - description: Requests to initiate customer verification. name: KYC/KYB Verifications paths: /crr: summary: CRR get: tags: - CRR summary: List CRRs description: Get paginated list of CRR operationId: listCRR parameters: - $ref: '#/components/parameters/customer_id1' - $ref: '#/components/parameters/include_history' - $ref: '#/components/parameters/page_token' - $ref: '#/components/parameters/limit' - $ref: '#/components/parameters/business_id1' responses: '200': content: application/json: schema: $ref: '#/components/schemas/crr_list' description: List of CRR for customers, or businesses '401': $ref: '#/components/responses/unauthorized' '403': $ref: '#/components/responses/forbidden' '500': $ref: '#/components/responses/internal_server_error' components: parameters: customer_id1: description: ID of the customer that the risk score applies to in: query name: customer_id schema: example: 77275c65-8702-4b27-8e60-20f4292054ac format: uuid type: string include_history: description: If true, include old risk scores in the response in: query name: include_history schema: default: false type: boolean page_token: in: query name: page_token schema: description: >- Optional pagination token to be provided to retrieve subsequent pages, returned from previous get example: a8937a0d type: string limit: in: query name: limit schema: default: 100 description: > Maximum number of objects to return per page. If the limit is greater than 100, then it will be set to 100. example: 100 minimum: 1 type: integer business_id1: description: ID of the business that the risk score applies to in: query name: business_id schema: example: edebece0-4a06-4806-b062-7de25a848be8 format: uuid type: string schemas: crr_list: allOf: - $ref: '#/components/schemas/paginated_response' - properties: risk_scores: description: Array of risk scores items: $ref: '#/components/schemas/crr_response' type: array required: - risk_scores type: object paginated_response: properties: next_page_token: description: >- If returned, use the next_page_token to query for the next page of results. Not returned if there are no more rows. example: a8937a0d type: string title: Paginated List response type: object crr_response: properties: business_id: description: >- ID of the customer that the risk score applies to. Either customer_id or business_id will be provided but not both example: 06a644f6-2623-4dd2-b2cd-da8a8667515e format: uuid type: string calculated_score: description: >- 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. example: 47 type: integer calculations_breakdown: description: >- An array that holds the calculated weights for each risk parameter that was used in the score calculation items: $ref: '#/components/schemas/calculation_breakdown' type: array creator_id: description: >- ID of the user that created risk score. creator_id will be null if score was calculated automatically example: 53869fb3-c58e-4a49-badb-7b273a7bdd34 format: uuid type: string customer_id: description: >- ID of the customer that the risk score applies to. Either customer_id or business_id will be provided but not both example: 272878fe-355f-4308-8d1d-4c7d43d698f6 format: uuid type: string id: description: Risk score record unique ID example: 7503cd8a-903b-4fee-aa54-da3dc71f4124 format: uuid type: string note: description: >- The attached note for the risk score. An note is always added when a score has been overridden by a user example: Customer was found on a watchlist. Setting the risk score to 80 type: string risk_level: description: Risk score classification enum: - HIGH - LOW - MEDIUM type: string risk_score: description: >- The calculated risk score for the customer/business. When auto_high is triggered, this is forced to 100. example: 37 type: integer tenant: $ref: '#/components/schemas/tenant_id' valid_from: description: The start date that this risk score came into effect. example: '2023-01-05T11:23:34.321Z' format: date-time type: string valid_to: description: The end date that this risk score came into effect. example: '2024-01-05T11:23:34.321Z' format: date-time type: string required: - id - risk_level - risk_score - tenant type: object error: description: >- Synctera error responses in API v0 follow [RFC 7807](https://datatracker.ietf.org/doc/html/rfc7807). Following that standard, the field for a machine-readable "error code" in API v0 is `type`. In our future API v1, we are phasing out RFC 7807 and adopting a custom error format. That format will be documented in our API v1 spec. But you may see some v0 error responses with a machine-readable `code` field while we are making the transition from v0 to v1. properties: code: description: >- An optional “sneak preview” of our future API v1 error responses. This is provided to give integrators a chance to work with our future error codes. Error codes for the same error may change between v0 and v1. example: BAD_REQUEST_BODY type: string detail: description: | A human-readable string explaining this particular error. example: 'missing required fields: first_name, dob' type: string status: description: the HTTP status code for this response example: 400 type: integer title: description: > A human-readable string for this general category of error, which corresponds 1-to-1 with error types (`title` is the human-readable version of `type`). There can be multiple distinct titles for the same HTTP status code, and the same `title` can result in many different `detail` strings. This field will be removed in API v1. example: Bad Request Body type: string type: description: > A machine-readable string that identifies the error for programmatic use. This is a URI, i.e. a globally unique identifier. It is _not_ necessarily a URL, so do not expect it to resolve to a web page. You can use this whole string as an error code, or just everything after the last slash. This field will be removed in API v1. example: https://dev.synctera.com/errors/bad-request-body type: string title: Standard error response (RFC 7807 problem report) type: object calculation_breakdown: description: >- An array that holds the calculated weights for each risk parameter that was used in the score calculation properties: auto_high_risk_triggered: description: Whether this parameter triggered auto-high risk in the calculation type: boolean condition: $ref: '#/components/schemas/condition' overridden_score: description: >- Additional score points attributed from auto-high override. The remainder (100 - calculated_score) is divided evenly across all auto-high parameters. format: double type: number parameter_label: description: The user-friendly label for the parameter example: Customer Country type: string parameter_name: description: The name of the parameter that was used in the score calculation enum: - 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 type: string parameter_score: description: >- The calculated weight of the risk param. calculated_weight = parameter weight/sum(parameters weight) * 100 example: 46.42 format: double type: number parameter_weight: description: The weight of the risk param as defined in the risk config example: 25 type: integer required: - parameter_score - parameter_weight type: object tenant_id: description: > The id of the tenant containing the resource. This is relevant for Fintechs that have multiple workspaces. example: abcdef_ghijkl type: string condition: description: The parameter condition was used in the score calculation properties: lower: description: >- If the condition type is RANGE. condition_lower is the field that stores the lower value of the condition example: 0 type: integer type: $ref: '#/components/schemas/condition_type' upper: description: >- If the condition type is RANGE. condition_upper is the field that stores the upper value of the condition example: 150000 type: integer value: description: >- If the condition type is CATEGORICAL. condition_value is the field that stores the discrete value type: string weight: description: | 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. example: 75 maximum: 100 minimum: 0 type: integer required: - type - weight type: object condition_type: description: >- 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. enum: - CATEGORICAL - NONE - RANGE type: string responses: unauthorized: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Unauthorized forbidden: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Forbidden error internal_server_error: content: application/problem+json: schema: $ref: '#/components/schemas/error' description: Internal server error securitySchemes: bearerAuth: bearerFormat: api_key scheme: bearer type: http ````