Get a preset by its ID

get/presets/{presetId}

Returns a preset by its ID.

Request Samples

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 "riskCountries": [
60 "string"
61 ],
62 "riskRegions": [
63 "Centre/cm",
64 "Wisconsin "
65 ],
66 "status": "any",
67 "inactiveDays": 0,
68 "pepLevel": "intl",
69 "tweaks": {
70 "detectTitle": false,
71 "detectBicCodes": true,
72 "useTextPlaces": false,
73 "surnameAbbreviations": false,
74 "perfectSmallNames": false,
75 "bidirectionalMatching": false,
76 "deepIndexSearch": false,
77 "lowQualityNicknames": false,
78 "partialIndividualNames": "NONE",
79 "partialIndividualNamePatterns": [
80 "1,1"
81 ],
82 "partialEntityNames": "NONE",
83 "longAbbreviations": false,
84 "minTextMatchLength": 0,
85 "globalLegalForms": false
86 },
87 "exclusions": [
88 "string"
89 ],
90 "fieldPresets": {
91 "debtor": "my-preset1"
92 },
93 "detectStripping": false,
94 "detectDuplicates": false
95 },
96 "creationTimeStamp": "2023-08-31T13:56:49.021Z",
97 "modifiedTimeStamp": "2023-08-31T13:56:57.596Z",
98 "version": 1,
99 "links": [
100 {
101 "method": "GET",
102 "rel": "up",
103 "href": "/watchlistScreening/presets",
104 "uri": "/watchlistScreening/presets",
105 "type": "application/vnd.sas.collection",
106 "itemType": "application/vnd.sas.watchlist.screening.preset"
107 },
108 {
109 "method": "GET",
110 "rel": "self",
111 "href": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a",
112 "uri": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a",
113 "type": "application/vnd.sas.watchlist.screening.preset"
114 },
115 {
116 "method": "PUT",
117 "rel": "update",
118 "href": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a",
119 "uri": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a",
120 "type": "application/vnd.sas.watchlist.screening.preset",
121 "responseType": "application/vnd.sas.watchlist.screening.preset"
122 },
123 {
124 "method": "DELETE",
125 "rel": "delete",
126 "href": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a",
127 "uri": "/watchlistScreening/presets/ee0b5606-36a2-4fcd-9b06-1e71e1caee5a"
128 }
129 ]
130}

Path Parameters

NameTypeRequiredDescription
presetId
string
true

The ID of the preset.

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

Responses

StatusMeaningDescription
200OK

The request succeeded.

HeadersSchema
404Not Found

The specified resource was not found.

Schema
406Not Acceptable

Not Acceptable. Include an Accept header with a supported value on the request.

Schema
500Internal Server Error

The service encountered an error.

Schema
502Bad Gateway

Unable to contact Neterium or a generic bad gateway error.

Schema
503Service Unavailable

Service Unavailable

Schema