Skip to main content
PATCH
/
crr
/
external_scores
/
{external_score_id}
Update an external score
curl --request PATCH \
  --url https://api.synctera.com/v2/crr/external_scores/{external_score_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "<string>",
  "high_risk_override": true,
  "metadata": {},
  "score": 75
}
'
{
  "high_risk_override": true,
  "id": "7503cd8a-903b-4fee-aa54-da3dc71f4124",
  "resource_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "score": 75,
  "tenant": "abcdef_ghijkl",
  "creation_time": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "last_updated_time": "2023-11-07T05:31:56Z",
  "metadata": {}
}

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"

Body

application/json

External score fields to update

​
description
string

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

​
high_risk_override
boolean

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

​
metadata
object

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

​
score
integer

An externally sourced risk score (0-100)

Required range: 0 <= x <= 100
Example:

75

Response

External score updated 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. This is relevant for Fintechs that have multiple workspaces.

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.