Skip to content
Biometry

Update scoring system

PATCH
/v2/scoring-systems/{id}

Partially update a custom scoring system configuration.

Authorizations

Parameters

Path Parameters

id
required
string

Request Body required

object
id
string
name
string
apikey_ids
Array<string>
docauth_conditions
Array<string>
facematch_conditions
Array<object>
object
field_path
required
string
type
required
string
value
object
pass_value
object
fail_value
object
status
string
scoring_blocks
Array<object>
object
service
required
string
weight
required
number
<= 1
fail_value
required
number
<= 1
is_critical
boolean
active
boolean
scoring_range
object
pass_value
required
number
<= 1
fail_value
required
number
<= 1
session_config
object
key
additional properties
string
key
additional properties
any

Responses

200

Scoring system updated.

object
data

Endpoint-specific payload; omitted when the operation returns no data.

decision

Scoring decision computed for the request when a scoring system applies.

object
status

Decision status from the scoring engine (e.g. pass, fail, refer).

string
score
number
reasons
Array<string>
meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>
data
object
id
string
name
string
apikey_ids
Array<string>
docauth_conditions
Array<string>
facematch_conditions
Array<object>
object
field_path
required
string
type
required
string
value
object
pass_value
object
fail_value
object
status
string
scoring_blocks
Array<object>
object
service
required
string
weight
required
number
<= 1
fail_value
required
number
<= 1
is_critical
boolean
active
boolean
scoring_range
object
pass_value
required
number
<= 1
fail_value
required
number
<= 1
session_config
object
key
additional properties
string
key
additional properties
any

400

Bad Request / Parameter Validation Failed.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

401

Unauthorized / Missing or Invalid Authentication Credentials.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

404

Not Found / Specified Resource (User, Session, Reference Image, etc.) does not exist.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>

500

Internal Server Error.

object
error
required
object
code
required
string
invalid_request
message
required

Human-readable message; a string, or a field-error array for validation failures.

meta
required
object
request_id
required
string
message
string
warnings

Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.

Array<string>