Skip to main content
GET
Get an external score

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

external_score_id
string<uuid>
required

ID of the external score

Example:

"7503cd8a-903b-4fee-aa54-da3dc71f4124"

Response

External score retrieved successfully

high_risk_override
boolean
required

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

id
string<uuid>
required

Unique identifier for the external score record

Example:

"7503cd8a-903b-4fee-aa54-da3dc71f4124"

resource_id
string<uuid>
required

The customer_id or business_id this score applies to

resource_type
enum<string>
required

The resource type for which the parameter is calculated

Available options:
CUSTOMER,
BUSINESS
score
integer
required

An externally sourced risk score (0-100)

Example:

75

tenant
string
required

The id of the tenant containing the resource.

Example:

"abcdef_ghijkl"

creation_time
string<date-time>

The date and time the record was created

description
string

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

last_updated_time
string<date-time>

The date and time the record was last updated

metadata
object

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