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