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": "2ef111b0-bd65-4572-b9b9-b3597a53d71c",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": "2ef111b0-bd65-4572-b9b9-b3597a53d71c",26 "statusCode": "Success"27 }28 },29 "currency": "UYU",30 "dataSource ": "SWIFT",31 "debtor": {32 "firstName": "Habib",33 "postalAddress": [34 {35 "country": "CF"36 }37 ],38 "screeningResult": {39 "discardedHits": 0,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 "level": "low",57 "links": [58 {59 "method": "GET",60 "rel": "profile",61 "href": "/watchlistScreening/profiles/EU00000000106138?checksum=-327052795",62 "uri": "/watchlistScreening/profiles/EU00000000106138?checksum=-327052795",63 "type": "application/json"64 }65 ],66 "matchType": "/name/alias",67 "matchedName": "Soussou, Habib",68 "primaryName": "Soussou Abib",69 "profileBirthPlaces": [70 {71 "city": "",72 "countryCode": "cf"73 }74 ],75 "profileId": "EU00000000106138",76 "profileIds": [77 "23672198628"78 ],79 "profileLastUpdated": "2024-07-09T01:10:06.536Z",80 "profilePlaces": [81 {82 "city": "Boda",83 "countryCode": "cf"84 }85 ],86 "profileRelatedCountries": [87 "cf"88 ],89 "profileStatus": "UNK",90 "profileType": "individual",91 "proximityScore": null,92 "sanctions": [93 "EU"94 ],95 "score": 100,96 "scoreScope": [97 "NAME"98 ],99 "screened": "Soussou, Habib",100 "tags": [101 "SAN"102 ]103 },104 {105 "categories": [106 "Central African Republic"107 ],108 "checksum": -1727466793,109 "coreChecksum": -2056675719,110 "dateOfBirth": [111 {112 "birthDay": 13,113 "birthDt": "1980-03-13",114 "birthMonth": 3,115 "birthYear": 1980116 }117 ],118 "level": "low",119 "links": [120 {121 "method": "GET",122 "rel": "profile",123 "href": "/watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793",124 "uri": "/watchlistScreening/profiles/HMT0000000013272?checksum=-1727466793",125 "type": "application/json"126 }127 ],128 "matchType": "/name/primary",129 "matchedName": "Soussou, Habib",130 "primaryName": "Soussou, Habib",131 "profileBirthPlaces": [132 {133 "city": "",134 "countryCode": "cf"135 }136 ],137 "profileId": "HMT0000000013272",138 "profileLastUpdated": "2024-07-09T01:15:00.438Z",139 "profilePlaces": [140 {141 "city": "Boda",142 "countryCode": "cf"143 }144 ],145 "profileRelatedCountries": [146 "cf"147 ],148 "profileStatus": "UNK",149 "profileType": "individual",150 "proximityScore": null,151 "sanctions": [152 "HMT"153 ],154 "score": 100,155 "scoreScope": [156 "NAME"157 ],158 "screened": "Soussou, Habib",159 "tags": [160 "SAN"161 ]162 },163 {164 "categories": [165 "CAR"166 ],167 "checksum": -1871588783,168 "coreChecksum": -662103456,169 "dateOfBirth": [170 {171 "birthDay": 13,172 "birthDt": "1980-03-13",173 "birthMonth": 3,174 "birthYear": 1980175 }176 ],177 "level": "low",178 "links": [179 {180 "method": "GET",181 "rel": "profile",182 "href": "/watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783",183 "uri": "/watchlistScreening/profiles/OFAC000000018428?checksum=-1871588783",184 "type": "application/json"185 }186 ],187 "matchType": "/name/primary",188 "matchedName": "Soussou, Habib",189 "primaryName": "Soussou, Habib",190 "profileId": "OFAC000000018428",191 "profileLastUpdated": "2024-07-09T01:00:04.174Z",192 "profilePlaces": [193 {194 "city": "Boda",195 "countryCode": "cf"196 }197 ],198 "profileRelatedCountries": [199 "cf"200 ],201 "profileStatus": "UNK",202 "profileType": "individual",203 "proximityScore": null,204 "sanctions": [205 "OFACSD"206 ],207 "score": 100,208 "scoreScope": [209 "NAME"210 ],211 "screened": "Soussou, Habib",212 "tags": [213 "SAN"214 ]215 },216 {217 "categories": [218 "CAR"219 ],220 "checksum": -706261789,221 "coreChecksum": 770033445,222 "dateOfBirth": [223 {224 "birthDay": 13,225 "birthDt": "1980-03-13",226 "birthMonth": 3,227 "birthYear": 1980228 }229 ],230 "level": "low",231 "links": [232 {233 "method": "GET",234 "rel": "profile",235 "href": "/watchlistScreening/profiles/UN00000006908465?checksum=-706261789",236 "uri": "/watchlistScreening/profiles/UN00000006908465?checksum=-706261789",237 "type": "application/json"238 }239 ],240 "matchType": "/name/primary",241 "matchedName": "Soussou, Habib",242 "primaryName": "Soussou, Habib",243 "profileBirthPlaces": [244 {245 "city": "",246 "countryCode": "cf"247 }248 ],249 "profileId": "UN00000006908465",250 "profileIds": [251 "UNCFI005"252 ],253 "profileLastUpdated": "2024-07-09T01:05:03.101Z",254 "profilePlaces": [255 {256 "city": "",257 "countryCode": "cf"258 }259 ],260 "profileRelatedCountries": [261 "cf"262 ],263 "profileStatus": "UNK",264 "profileType": "individual",265 "proximityScore": null,266 "sanctions": [267 "UN"268 ],269 "score": 100,270 "scoreScope": [271 "NAME"272 ],273 "screened": "Soussou, Habib",274 "tags": [275 "SAN"276 ]277 }278 ],279 "messageReference": "2ef111b0-bd65-4572-b9b9-b3597a53d71c",280 "statusCode": "Success"281 },282 "surname": "Soussou"283 },284 "debtorAgent": {285 "identity": [286 {287 "type": "BIC",288 "number": "ZHFZGB7Z"289 }290 ],291 "screeningResult": {292 "discardedHits": 0,293 "hits": 0,294 "messageReference": "2ef111b0-bd65-4572-b9b9-b3597a53d71c",295 "statusCode": "Success"296 }297 },298 "identifier": "80958",299 "intermediaries": [300 {301 "identity": [302 {303 "number": "RCDFIQBA",304 "type": "BIC"305 }306 ],307 "screeningResult": {308 "discardedHits": 0,309 "hits": 1,310 "matchedProfile": [311 {312 "categories": [313 "IRAN",314 "IRAN-EO13902"315 ],316 "checksum": -297043716,317 "coreChecksum": -971362320,318 "level": "low",319 "links": [320 {321 "method": "GET",322 "rel": "profile",323 "href": "/watchlistScreening/profiles/OFAC000000013146?checksum=-297043716",324 "uri": "/watchlistScreening/profiles/OFAC000000013146?checksum=-297043716",325 "type": "application/json"326 }327 ],328 "matchType": "/id/bic",329 "matchedName": "RCDFIQBA",330 "primaryName": "Islamic Regional Cooperation Bank",331 "profileId": "OFAC000000013146",332 "profileIds": [333 "RCDFIQBA"334 ],335 "profileLastUpdated": "2024-07-09T01:00:04.174Z",336 "profilePlaces": [337 {338 "city": "Baghdad",339 "countryCode": "iq"340 },341 {342 "city": "Tehran",343 "countryCode": "ir"344 },345 {346 "city": "Baghdad",347 "countryCode": "iq"348 },349 {350 "city": "Baghdad",351 "countryCode": "iq"352 }353 ],354 "profileRelatedCountries": [355 "ir"356 ],357 "profileStatus": "UNK",358 "profileType": "entity",359 "proximityScore": null,360 "sanctions": [361 "OFACSD"362 ],363 "score": 100,364 "scoreScope": [365 "ID"366 ],367 "screened": "RCDFIQBA",368 "tags": [369 "SAN"370 ]371 }372 ],373 "messageReference": "2ef111b0-bd65-4572-b9b9-b3597a53d71c",374 "statusCode": "Success"375 }376 },377 {378 "identity": [379 {380 "number": "JTBHGB6J",381 "type": "BIC"382 }383 ],384 "screeningResult": {385 "discardedHits": 0,386 "hits": 0,387 "messageReference": "2ef111b0-bd65-4572-b9b9-b3597a53d71c",388 "statusCode": "Success"389 }390 }391 ],392 "screeningResult": {393 "discardedHits": 0,394 "hits": 5,395 "messageReference": "2ef111b0-bd65-4572-b9b9-b3597a53d71c",396 "statusCode": "Success"397 },398 "transactionDttm": "2021-04-23T12:00:00Z",399 "transactionId": "TXN44611",400 "ultimateCreditor": {401 "name": "Matthew Moore",402 "postalAddress": [403 {404 "country": "CF"405 }406 ],407 "screeningResult": {408 "discardedHits": 0,409 "hits": 0,410 "messageReference": "2ef111b0-bd65-4572-b9b9-b3597a53d71c",411 "statusCode": "Success"412 }413 }414 }415 ],416 "screeningOptions": {417 "chnPayment": "sas_chn_payment",418 "messageReference": "2ef111b0-bd65-4572-b9b9-b3597a53d71c"419 }420 }421}
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 |