Create a screening profile
Request
Content type: application/json · required
| Field | Type | Required | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
name |
string | Yes | — | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
status |
string | No | one of active, paused, archived · default "active" |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
config |
object | Yes | Show 12 nested fields
|
curl -X POST "$MONICHEK_API/screening-profiles" \
-H "Authorization: Bearer $MONICHEK_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"name": "Ada Okafor",
"status": "active",
"config": {
"description": "Example note",
"algorithm": "monichek-logic-1",
"datasets": [
"string"
],
"topics": [
"string"
],
"schemas": [
"string"
],
"review_threshold": 0,
"match_threshold": 0,
"auto_block_threshold": 0,
"weights": {
"dob": 0,
"country": 0,
"gender": 0,
"address": 0
},
"name_only_review": true,
"include_weak": true,
"top_k": 1
}
}'const res = await fetch(`${MONICHEK_API}/screening-profiles`, {
method: "POST",
headers: {
Authorization: `Bearer ${MONICHEK_API_KEY}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"name": "Ada Okafor",
"status": "active",
"config": {
"description": "Example note",
"algorithm": "monichek-logic-1",
"datasets": [
"string"
],
"topics": [
"string"
],
"schemas": [
"string"
],
"review_threshold": 0,
"match_threshold": 0,
"auto_block_threshold": 0,
"weights": {
"dob": 0,
"country": 0,
"gender": 0,
"address": 0
},
"name_only_review": true,
"include_weak": true,
"top_k": 1
}
}),
});
const data = await res.json();import os
import requests
res = requests.post(
f"{os.environ['MONICHEK_API']}/screening-profiles",
headers={"Authorization": f"Bearer {os.environ['MONICHEK_API_KEY']}"},
json={
"name": "Ada Okafor",
"status": "active",
"config": {
"description": "Example note",
"algorithm": "monichek-logic-1",
"datasets": [
"string"
],
"topics": [
"string"
],
"schemas": [
"string"
],
"review_threshold": 0,
"match_threshold": 0,
"auto_block_threshold": 0,
"weights": {
"dob": 0,
"country": 0,
"gender": 0,
"address": 0
},
"name_only_review": true,
"include_weak": true,
"top_k": 1
}
},
)
print(res.json())$ch = curl_init(getenv('MONICHEK_API') . '/screening-profiles');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_HTTPHEADER => [
'Authorization: Bearer ' . getenv('MONICHEK_API_KEY'),
'Content-Type: application/json',
],
CURLOPT_POSTFIELDS => json_encode([
'name' => 'Ada Okafor',
'status' => 'active',
'config' => [
'description' => 'Example note',
'algorithm' => 'monichek-logic-1',
'datasets' => [
'string',
],
'topics' => [
'string',
],
'schemas' => [
'string',
],
'review_threshold' => 0,
'match_threshold' => 0,
'auto_block_threshold' => 0,
'weights' => [
'dob' => 0,
'country' => 0,
'gender' => 0,
'address' => 0,
],
'name_only_review' => true,
'include_weak' => true,
'top_k' => 1,
],
]),
]);
$response = curl_exec($ch);
curl_close($ch);
echo $response;Responses
201 Created
created profile
application/json
No response example is published for this status.
Error responses
| Status | Meaning | Body |
|---|---|---|
| 403 | Forbidden | RFC 9457 problem |
| 422 | Unprocessable Entity | RFC 9457 problem |
Errors use the RFC 9457 problem format with a stable code.