v3

latestOpenAPI 3.0.3Apache 2.02026-07-312637031.3 MB

CRR

Get an external score

Get a specific external score

get/crr/external_scores/{external_score_id}

external_score_idstring uuid required

Example:7503cd8a-903b-4fee-aa54-da3dc71f4124

ID of the external score

External score retrieved successfully

creation_timestring date-time

The date and time the record was created

descriptionstring

Free-text narrative supplied by the operator or external system describing the rationale for the score.

high_risk_overrideboolean required

When true, forces the customer's computed CRR rating to high regardless of the numeric score.

idstring uuid required

Unique identifier for the external score record

last_updated_timestring date-time

The date and time the record was last updated

metadataobject

Free-form structured metadata supplied by the operator or external system.

resource_idstring uuid required

The customer_id or business_id this score applies to

resource_type'BUSINESS' | 'CUSTOMER' required

The resource type for which the parameter is calculated

scoreinteger required

An externally sourced risk score (0-100)

tenantstring required

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

{
  "id": "7503cd8a-903b-4fee-aa54-da3dc71f4124",
  "score": 75,
  "tenant": "abcdef_ghijkl"
}