Screen a group of payments
post/payment
Performs a screening action on a list of payments.
1{2 "message": {3 "payment": [4 {5 "amount": 707766.03,6 "creditor": {7 "name": "Carlos Hawkins",8 "screeningResult": {9 "discardedHits": 0,10 "hits": 0,11 "messageReference": "c3880c31-7013-43ca-9a75-c1f10caaa8de",12 "statusCode": "Success"13 }14 },15 "creditorAgent": {16 "identity": [17 {18 "number": "HNEEGBAG",19 "type": "BIC"20 }21 ],22 "screeningResult": {23 "discardedHits": 0,24 "hits": 0,25 "messageReference": "c3880c31-7013-43ca-9a75-c1f10caaa8de",26 "statusCode": "Success"27 }28 },29 "currency": "UYU",30 "dataSource": "SWIFT",31 "debtor": {32 "firstName": "Habib",33 "postalAddress": [34 {35 "countryCode": "CF"36 }37 ],38 "screeningResult": {39 "discardedHits": 1,40 "hits": 4,41 "matchedProfile": [42 {43 "categories": [44 "CAF"45 ],46 "checksum": -327052795,47 "coreChecksum": -718590065,48 "dateOfBirth": [49 {50 "birthDay": 13,51 "birthDt": "1980-03-13",52 "birthMonth": 3,53 "birthYear": 198054 }55 ],56 "geoScore": 0,57 "level": "medium",58 "links": [59 {60 "method": "GET",61 "rel": "profile",62 "href": "/watchlistScreening/profiles/EU00000000106138?checksum=-327052795",63 "uri": "/watchlistScreening/profiles/EU00000000106138?checksum=-327052795",64 "type": "application/json"65 }66 ],67 "locationFrom": 0,68 "locationPath": "/debtor/name",69 "locationTo": 13,70 "matchType": "/name/alias",71 "matchedName": "Soussou, Habib",72 "primaryName": "Soussou Abib",73 "profileBirthPlaces": [74 {75 "city": "",76 "countryCode": "cf"77 }78 ],79 "profileId": "EU00000000106138",80 "profileIds": [81 "23672198628"82 ],83 "profileLastUpdated": "2025-09-08T01:10:06.925Z",84 "profilePlaces": [85 {86 "city": "Boda",87 "countryCode": "cf"88 }89 ],90 "profileRelatedCountries": [91 "cf"92 ],93 "profileStatus": "UNK",94 "profileType": "individual",95 "sanctions": [96 "EU"97 ],98 "score": 100,99 "scoreScope": [100 "COUNTRY",101 "NAME"102 ],103 "screened": "Soussou, Habib",104 "tags": [105 "SAN"106 ]107 },108 {109 "categories": [110 "Central African Republic"111 ],112 "checksum": -1727466793,113 "coreChecksum": -2056675719,114 "dateOfBirth": [115 {116 "birthDay": 13,117 "birthDt": "1980-03-13",118 "birthMonth": 3,119 "birthYear": 1980120 }121 ],122 "geoScore": 0,123 "level": "medium",124 "links": [125 {126 "method": "GET",127 "rel": "profile",128 "href": "/watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793",129 "uri": "/watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793",130 "type": "application/json"131 }132 ],133 "locationFrom": 0,134 "locationPath": "/debtor/name",135 "locationTo": 13,136 "matchType": "/name/primary",137 "matchedName": "Soussou, Habib",138 "primaryName": "Soussou, Habib",139 "profileBirthPlaces": [140 {141 "city": "",142 "countryCode": "cf"143 }144 ],145 "profileId": "HMT0000000013272",146 "profileLastUpdated": "2025-09-08T01:15:00.568Z",147 "profilePlaces": [148 {149 "city": "Boda",150 "countryCode": "cf"151 }152 ],153 "profileRelatedCountries": [154 "cf"155 ],156 "profileStatus": "UNK",157 "profileType": "individual",158 "sanctions": [159 "HMT"160 ],161 "score": 100,162 "scoreScope": [163 "COUNTRY",164 "NAME"165 ],166 "screened": "Soussou, Habib",167 "tags": [168 "SAN"169 ]170 },171 {172 "categories": [173 "CAR"174 ],175 "checksum": -1871588783,176 "coreChecksum": -662103456,177 "dateOfBirth": [178 {179 "birthDay": 13,180 "birthDt": "1980-03-13",181 "birthMonth": 3,182 "birthYear": 1980183 }184 ],185 "exceptionId": "0f43c2d2-4c9c-48ac-8814-ab2d435fef87",186 "exceptionReference": "CE_2c59e01d-5ed7-427d-a153-f304a0f2d899",187 "geoScore": 0,188 "level": "discarded",189 "links": [190 {191 "method": "GET",192 "rel": "profile",193 "href": "/watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783",194 "uri": "/watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783",195 "type": "application/json"196 },197 {198 "method": "GET",199 "rel": "exception",200 "href": "/watchlistScreening/exceptions/0f43c2d2-4c9c-48ac-8814-ab2d435fef87",201 "uri": "/watchlistScreening/exceptions/0f43c2d2-4c9c-48ac-8814-ab2d435fef87",202 "type": "application/vnd.sas.watchlist.screening.conditional.exception"203 }204 ],205 "locationFrom": 0,206 "locationPath": "/debtor/name",207 "locationTo": 13,208 "matchType": "/name/primary",209 "matchedName": "Soussou, Habib",210 "mediaAgeScore": 0,211 "mediaQuantityScore": 0,212 "primaryName": "Soussou, Habib",213 "profileId": "OFAC000000018428",214 "profileLastUpdated": "2025-09-08T01:25:06.154Z",215 "profilePlaces": [216 {217 "city": "Boda",218 "countryCode": "cf"219 }220 ],221 "profileRelatedCountries": [222 "cf"223 ],224 "profileStatus": "UNK",225 "profileType": "individual",226 "proximityScore": 100,227 "sanctions": [228 "OFACSD"229 ],230 "score": 100,231 "scoreScope": [232 "COUNTRY",233 "NAME"234 ],235 "screened": "Soussou, Habib",236 "tags": [237 "SAN"238 ]239 },240 {241 "categories": [242 "CAR"243 ],244 "checksum": -706261789,245 "coreChecksum": 770033445,246 "dateOfBirth": [247 {248 "birthDay": 13,249 "birthDt": "1980-03-13",250 "birthMonth": 3,251 "birthYear": 1980252 }253 ],254 "geoScore": 0,255 "level": "medium",256 "links": [257 {258 "method": "GET",259 "rel": "profile",260 "href": "/watchlistScreening/profiles/UN00000006908465?checksum=-706261789",261 "uri": "/watchlistScreening/profiles/UN00000006908465?checksum=-706261789",262 "type": "application/json"263 }264 ],265 "locationFrom": 0,266 "locationPath": "/debtor/name",267 "locationTo": 13,268 "matchType": "/name/primary",269 "matchedName": "Soussou, Habib",270 "primaryName": "Soussou, Habib",271 "profileBirthPlaces": [272 {273 "city": "",274 "countryCode": "cf"275 }276 ],277 "profileId": "UN00000006908465",278 "profileIds": [279 "UNCFI005"280 ],281 "profileLastUpdated": "2025-09-08T01:05:01.359Z",282 "profilePlaces": [283 {284 "city": "",285 "countryCode": "cf"286 }287 ],288 "profileRelatedCountries": [289 "cf"290 ],291 "profileStatus": "UNK",292 "profileType": "individual",293 "sanctions": [294 "UN"295 ],296 "score": 100,297 "scoreScope": [298 "COUNTRY",299 "NAME"300 ],301 "screened": "Soussou, Habib",302 "tags": [303 "SAN"304 ]305 }306 ],307 "messageReference": "c3880c31-7013-43ca-9a75-c1f10caaa8de",308 "statusCode": "Success"309 },310 "surname": "Soussou"311 },312 "debtorAgent": {313 "identity": [314 {315 "number": "ZHFZGB7Z",316 "type": "BIC"317 }318 ],319 "screeningResult": {320 "discardedHits": 0,321 "hits": 0,322 "messageReference": "c3880c31-7013-43ca-9a75-c1f10caaa8de",323 "statusCode": "Success"324 }325 },326 "identifier": "80958",327 "intermediaries": [328 {329 "identity": [330 {331 "number": "RCDFIQBA",332 "type": "BIC"333 }334 ],335 "screeningResult": {336 "discardedHits": 0,337 "hits": 1,338 "matchedProfile": [339 {340 "categories": [341 "IRAN",342 "IRAN-EO13902"343 ],344 "checksum": -1345815218,345 "coreChecksum": -971362320,346 "geoScore": 0,347 "level": "low",348 "links": [349 {350 "method": "GET",351 "rel": "profile",352 "href": "/watchlistScreening/profiles/OFAC000000013146?checksum=-1345815218",353 "uri": "/watchlistScreening/profiles/OFAC000000013146?checksum=-1345815218",354 "type": "application/json"355 }356 ],357 "locationFrom": 0,358 "locationPath": "/intermediaries[0]/ids[0]/value",359 "locationTo": 7,360 "matchType": "/id/bic",361 "matchedName": "RCDFIQBA",362 "mediaAgeScore": 0,363 "mediaQuantityScore": 0,364 "primaryName": "Islamic Regional Cooperation Bank",365 "profileId": "OFAC000000013146",366 "profileIds": [367 "RCDFIQBA"368 ],369 "profileLastUpdated": "2025-09-08T01:25:06.154Z",370 "profilePlaces": [371 {372 "city": "Baghdad",373 "countryCode": "iq"374 },375 {376 "city": "Tehran",377 "countryCode": "ir"378 },379 {380 "city": "Baghdad",381 "countryCode": "iq"382 },383 {384 "city": "Baghdad",385 "countryCode": "iq"386 }387 ],388 "profileRelatedCountries": [389 "ir"390 ],391 "profileStatus": "UNK",392 "profileType": "entity",393 "proximityScore": 100,394 "sanctions": [395 "OFACSD"396 ],397 "score": 100,398 "scoreScope": [399 "NAME"400 ],401 "screened": "RCDFIQBA",402 "tags": [403 "SAN"404 ]405 }406 ],407 "messageReference": "c3880c31-7013-43ca-9a75-c1f10caaa8de",408 "statusCode": "Success"409 }410 },411 {412 "identity": [413 {414 "number": "JTBHGB6J",415 "type": "BIC"416 }417 ],418 "screeningResult": {419 "discardedHits": 0,420 "hits": 0,421 "messageReference": "c3880c31-7013-43ca-9a75-c1f10caaa8de",422 "statusCode": "Success"423 }424 }425 ],426 "screeningResult": {427 "discardedHits": 1,428 "hits": 5,429 "messageReference": "c3880c31-7013-43ca-9a75-c1f10caaa8de",430 "remainingHits": 4,431 "statusCode": "Success"432 },433 "transactionDttm": "2021-04-23T12:00:00Z",434 "transactionId": "TXN44611",435 "ultimateCreditor": {436 "name": "Matthew Moore",437 "postalAddress": [438 {439 "countryCode": "CF"440 }441 ],442 "screeningResult": {443 "discardedHits": 0,444 "hits": 0,445 "messageReference": "c3880c31-7013-43ca-9a75-c1f10caaa8de",446 "statusCode": "Success"447 }448 }449 }450 ],451 "screeningOptions": {452 "chnPayment": "dev_chn_payment",453 "messageReference": "c3880c31-7013-43ca-9a75-c1f10caaa8de",454 "routingClassification": "real-time"455 }456 }457}
A collection of payments to be screened and the options to use for this screening request.
The collection of objects that are required to screen a payment. This is the default configuration. This request is based on a message schema and might change after deployment.
| Name | Type | Required | Description |
|---|---|---|---|
message | object | false |
| Status | Meaning | Description | ||
|---|---|---|---|---|
| 200 | OK | The request succeeded. | Headers | Schema |
| 400 | Bad Request | Bad request (the request is not well-formed). | Schema | |
| 403 | Forbidden | The request is forbidden because the license is not active. | Schema | |
| 404 | Not Found | The service is not available. | Schema | |
| 406 | Not Acceptable | Not Acceptable. Include an Accept header with a supported value on the request. | Schema | |
| 408 | Request Timeout | Request timeout. | Schema | |
| 415 | Unsupported Media Type | Unsupported Media Type. Include a Content-Type header with a supported value in the request. | Schema | |
| 502 | Bad Gateway | Bad Gateway | Schema | |
| 503 | Service Unavailable | Service Unavailable | Schema |