GET /risk-model

Get risk model

Bearer API key or staff session operation getRiskModel

Request

This endpoint has no request body.

curl "$MONICHEK_API/risk-model" \
  -H "Authorization: Bearer $MONICHEK_API_KEY"

const res = await fetch(`${MONICHEK_API}/risk-model`, {
  method: "GET",
  headers: {
    Authorization: `Bearer ${MONICHEK_API_KEY}`,
  },
});

const data = await res.json();

import os
import requests

res = requests.get(
    f"{os.environ['MONICHEK_API']}/risk-model",
    headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
)
print(res.json())

$ch = curl_init(getenv('MONICHEK_API') . '/risk-model');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'GET',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('MONICHEK_API_KEY'),
    ],
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Responses

200 OK model application/json

{
  "model": {
    "weights": {
      "base": 10,
      "screening_match": 25,
      "screening_review": 10,
      "pep": 25,
      "kyc_tier1": 15,
      "high_risk_country": 20
    },
    "bands": {
      "low": 35,
      "medium": 65,
      "high": 85
    }
  }
}

Error responses

Status	Meaning	Body
401	Unauthorized	RFC 9457 problem

Errors use the RFC 9457 problem format with a stable code.