Create a new preset

post/presets

Creates a new custom preset

Request Samples

1

Response Samples

1{
2 "id": "ee0b5606-36a2-4fcd-9b06-1e71e1caee5a",
3 "name": "preset_example",
4 "options": {
5 "threshold": 85,
6 "metaScore": true,
7 "matching": "fuzzy",
8 "recordType": "individual",
9 "geoScore": false,
10 "geoThreshold": 0,
11 "bicThreshold": 100,
12 "lowQualityAliases": "none",
13 "dobMatching": "year",
14 "dobPrecision": 0,
15 "dobPolicy": {
16 "value": "required",
17 "match": "required",
18 "level": "low"
19 },
20 "genderPolicy": {
21 "value": "required",
22 "match": "required",
23 "level": "low"
24 },
25 "idPolicy": {
26 "value": "required",
27 "match": "required",
28 "level": "low"
29 },
30 "idPrecision": 5,
31 "tags": [
32 "SAN"
33 ],
34 "categories": [
35 "PROFILE_CATEGORY"
36 ],
37 "sanctionCountries": [
38 "US",
39 "GB"
40 ],
41 "sanctions": [
42 "SANCTION_CODE"
43 ],
44 "matchTypes": [
45 "/name/primary"
46 ],
47 "cityProximity": 50,
48 "cityPolicy": {
49 "value": "required",
50 "match": "required",
51 "level": "low"
52 },
53 "countryPolicy": {
54 "value": "required",
55 "match": "required",
56 "level": "low"
57 },
58 "charset": "latin",
59 "affinity": "def",
60 "riskCountries": [
61 "string"
62 ],
63 "riskRegions": [
64 "Centre/cm",
65 "Wisconsin "
66 ],
67 "status": "any",
68 "inactiveDays": 0,
69 "pepLevel": "intl",
70 "tweaks": {
71 "detectTitle": false,
72 "detectBicCodes": true,
73 "useTextPlaces": false,
74 "surnameAbbreviations": false,
75 "perfectSmallNames": false,
76 "bidirectionalMatching": false,
77 "deepIndexSearch": false,
78 "lowQualityNicknames": false,
79 "partialIndividualNames": "NONE",
80 "partialIndividualNamePatterns": [
81 "1,1"
82 ],
83 "partialEntityNames": "NONE",
84 "longAbbreviations": false,
85 "minTextMatchLength": 0,
86 "globalLegalForms": false
87 },
88 "exclusions": [
89 "string"
90 ],
91 "fieldPresets": {
92 "debtor": "my-preset1"
93 },
94 "detectStripping": false,
95 "detectDuplicates": false
96 },
97 "creationTimeStamp": "2023-08-31T13:56:49.021Z",
98 "modifiedTimeStamp": "2023-08-31T13:56:57.596Z",
99 "version": 1,
100 "links": [
101 {
102 "method": "GET",
103 "rel": "up",
104 "href": "/watchlistScreening/presets",
105 "uri": "/watchlistScreening/presets",
106 "type": "application/vnd.sas.collection",
107 "itemType": "application/vnd.sas.watchlist.screening.preset"
108 },
109 {
110 "method": "GET",
111 "rel": "self",
112 "href": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a",
113 "uri": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a",
114 "type": "application/vnd.sas.watchlist.screening.preset"
115 },
116 {
117 "method": "PUT",
118 "rel": "update",
119 "href": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a",
120 "uri": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a",
121 "type": "application/vnd.sas.watchlist.screening.preset",
122 "responseType": "application/vnd.sas.watchlist.screening.preset"
123 },
124 {
125 "method": "DELETE",
126 "rel": "delete",
127 "href": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a",
128 "uri": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a"
129 }
130 ]
131}

Header Parameters

NameTypeRequiredDescription
Accept
string
false

The desired representation for the response.

Allowed values:
application/vnd.sas.watchlist.screening.preset+jsonapplication/vnd.sas.watchlist.screening.preset+json;version=1application/vnd.sas.watchlist.screening.channel+jsonapplication/vnd.sas.watchlist.screening.channel+json;version=1application/json
Default:
application/vnd.sas.watchlist.screening.preset+json
Content-Type
string
false

The representation for the request.

Allowed values:
application/vnd.sas.watchlist.screening.preset+jsonapplication/vnd.sas.watchlist.screening.preset+json;version=1application/vnd.sas.watchlist.screening.channel+jsonapplication/vnd.sas.watchlist.screening.channel+json;version=1application/json
Default:
application/vnd.sas.watchlist.screening.preset+json

Request Body

The preset to create.

Presets are predefined options that control screening requests.

NameTypeRequiredDescription
id
string
false

A unique identifier for the preset.

name
string
true

A unique name for the preset. The name is referenced in screening requests that use the preset. Names are automatically prefixed with the configured client reference for the deployment in order to ensure uniqueness across multiple environments (such as test and production).

options
object
true

The set of options for this preset.

creationTimeStamp
string<date-time>
false

Specifies the date and time that this object was created, in the format of YYYY-MM-DDThh:mm:ss.sssZ. This value is ignored on input.

modifiedTimeStamp
string<date-time>
false

Specifies the date and time that this object was last modified, in the format of YYYY-MM-DDThh:mm:ss.sssZ. This value is ignored on input.

version
integer
false

Specifies the version number of the media type.

links
array [Link]
false

Specifies the links that apply to the object. This value is ignored on input.

Responses

StatusMeaningDescription
201Created

The new preset was created.

HeadersSchema
400Bad Request

Bad request (the request is not well-formed).

Schema
404Not Found

The service is not available.

Schema
409Conflict

Resource Conflict. The request cannot be completed due to a conflict with the current state of the target resource.

Schema
502Bad Gateway

Unable to contact Neterium or a generic bad gateway error.

Schema