Webhooks
Setup Webhook
Our Anti Money Laundering (AML) Screening API uses webhooks for quick updates.
When you set up your webhook:
- If it doesn't exist, a new record is created.
- If it already exists, the record is updated.
To setup your webhook, you will make this request:
Request
Method: POST
Endpoint: api/v1/aml/webhook
Headers :
{
"apiKey" : [YOUR APP API_KEY],
"apiSecret" : [YOUR APP API_SECRET],
"Content-Type": "application/json"
}
Body:
{
"url": "https://app.test.com/api/v1/example"
}
Response
{
"businessProfile": "64a6d6446b67960f0543b301",
"url": "https://test.example.com/api/v1/",
"updatedAt": "2023-12-20T23:21:20.495Z"
}
Response
After screening finishes, you'll get a webhook response at your chosen endpoint. This response has important details to help you match it with the original search:
PEP LIST RESPONSE
Response
{
"check_id": "3e5bf600-e5f2-4510-82c3-3e95cfec8623",
"check_creation_date": "2024-06-04T09:38:07.473Z",
"last_screened_date": "2024-06-04T09:38:07.473Z",
"created_by": "64a6d6446b67960f0543b301",
"results": [
{
"_id": "662f9308d2b06e101bde005c",
"type": "pep",
"externalId": "Q3510872",
"__v": 0,
"addresses": [
""
],
"aliases": [
"Bola Ahmed Adekunle TINUBU",
" Bola Tinubu",
" The Lion of Bourdillon",
" Jagaban",
" Asiwaju"
],
"birth_date": "1952-03-29",
"countries": [
"ng"
],
"createdAt": "2024-04-29T12:31:00.296Z",
"entityType": "Person",
"name": "Bola Ahmed Tinubu",
"sanctions": [
""
],
"updatedAt": "2024-05-26T18:54:15.601Z",
"photo": "https://upload.wikimedia.org/wikipedia/commons/7/77/Bola_Tinubu_portrait.jpg",
"politicalParty": [
"Action Congress of Nigeria",
" Alliance for Democracy",
" All Progressives Congress"
],
"positions": [
"Governor of Lagos state"
],
"education": [
"Chicago State University"
],
"gender": "male",
"confidenceScore": 100
},
{
"education": [],
"_id": "662f9417d2b06e101bf138f4",
"externalId": "ng-chip-pep-ng-0005604",
"type": "pep",
"__v": 0,
"addresses": [
"High Court of Justice, New Hospital Road, P.M.B. 614, Akure"
],
"aliases": [
""
],
"birth_date": "",
"countries": [
"ng"
],
"createdAt": "2024-04-29T12:35:23.078Z",
"entityType": "Person",
"name": "Bola S",
"sanctions": [
""
],
"updatedAt": "2024-05-26T18:54:15.603Z",
"politicalParty": [
""
],
"positions": [
""
],
"confidenceScore": 80
}
],
"search_keyword": "Bola Ahmed Tinubu"
"type": "pep"
}
| Parameter | Type | Description |
|---|---|---|
| check_id | String | The check id that was returned in the initial response from the api call |
| check_creation_date | String | The date and time the request was recorded in ISO 8601 format |
| last_screened_date | String | Same as check creation date |
| created_by | String | The unique partner id |
| results | Object Array | This is the array of objects containing the results of the check |
| results.id | String | A unique identifier associated with the entry |
| results.externalId | String | An external identifier associated with the entry |
| results.type | String | The type of PEP ("pep" in this example) |
| results.entityType | String | The type of entity, such as "Individual" or “Business” |
| results.name | String | The name of the individual or company |
| results.aliases | String Array | An array of alternative names or aliases associated with the individual or entity. |
| results.birth_date | String | Date of birth of the individual (optional for companies) |
| results.countries | String Array | An array of ISO 3166-1 alpha-2 country codes representing the nationality |
| results.createdAt | String | Date and time the entry was created in ISO 8601 format |
| results.updatedAt | String | Date and time the entry was last updated in ISO 8601 format |
| results.photo | String | URL to a photo of the individual (if available) |
| results.politicalParty | String Array | An array of political parties the individual is affiliated with (if applicable) |
| results.positions | String Array | An array of positions or titles held by the individual (if applicable) |
| results.education | String Array | An array of educational institutions attended by the individual (if applicable) |
| results.gender | String | Gender of the individual (if available) |
| results.confidenceScore | String | A numeric value representing the confidence level in the match |
| results.sanctions | String Array | An array of sanctions the individual or entity is listed on (if applicable) |
| results.addresses | String Array | An array of addresses associated with the individual or entity (if applicable) |
| results.search_keyword | String | The search keyword used for the check |
| results.type | String | The type: pep |
SANCTIONS LIST RESPONSE
Response
{
"check_id": "c60a3465-70be-459b-884c-aa65ab12487d",
"check_creation_date": "2024-06-04T09:37:58.760Z",
"last_screened_date": "2024-06-04T09:37:58.760Z",
"created_by": "64a6d6446b67960f0543b301",
"results": [
{
"politicalParty": [],
"positions": [],
"education": [],
"_id": "662f9bc1d2b06e101bfacfe5",
"externalId": "Q1317",
"type": "sanction",
"__v": 0,
"addresses": [
""
],
"aliases": [
"Abu Abdallah Abd Al Hakim",
"Abu Abdallah Abd Al-Hakim",
"Al Qaqa",
"BIN LADIN, Usama bin Muhammad bin Awad",
"Ben Laden",
"Ben Laden Osama",
"Ben Laden Ossama",
"Ben Laden Usama",
"Bin Laden",
"Bin Laden Osama Mohamed Awdh",
"Bin Laden Usamah Bin Muhammad",
"Bin Lāden",
"Crankshaft",
"Osama BIN LADEN",
"Osama BIN LADIN",
"Osama Bin Laden",
"Osama bin Laden",
"Osama bin Ladenas",
"Osama bin Ladens",
"Osama bin Ladin",
"Osama bin Mohammed bin Awad bin Laden",
"Osama bin Muhammad bin Awad BIN LADIN",
"Osama bin Muhammad bin Awad bin Ladin",
"Ossama bin Laden",
"Oszáma bin Láden",
"Oszáma bin Mohammed bin Avad bin Láden",
"Osāma bin Muhammad bin ʿAwaḍ bin Lāden",
"Oussama ben Laden",
"Shaykh Usama Bin Ladin",
"Sheikh Osama Bin Laden",
"Usama BIN LADEN",
"Usama BIN LADIN",
"Usama Bin Laden",
"Usama Bin Ladin",
"Usama Bin Muhammed Bin Awad / Osama Bin Laden / Abu Abdallah Abd Al-Hakim",
"Usama Bin Muhammed Bin Awad Osama Bin Laden",
"Usama Bin Muhammed Bin Awad, Osama Bin Laden",
"Usama Muhammed Awad BIN LADEN",
"Usama Muhammed Awad Bin Laden",
"Usama bin Ladin",
"Usama bin Mohammad bin Awad bin Ladin",
"Usama bin Muhammad bin Awad BIN LADIN",
"Usama bin Muhammad bin Awad bin Ladin",
"Usama ibn Ladin",
"Usamah Bin Muhammad Bin Ladin",
"Usamah bin Ladin",
"Usamah bin Muhammad bin Awad bin Ladin",
"Usamah bin Muhammad bin Awwad bin Ladin",
"Usame bin Ladin",
"Usame bin Muhammed bin Avad bin Ladin",
"Usoma bin Lodin",
"Usáma bin Ládin",
"Usāmah bin Muḥammad bin ‘Awaḍ bin Lādin",
"Usāmah ibn Lādin",
"Üsamə bin Laden",
"Οσάμα μπιν Λάντεν",
"Осама бен Ладен",
"Осама бин Ладен",
"Осама бін Ладен",
"Усама Бин Ладен",
"Усама Бин Мухаммед Бин Ауад, Осама Бин Ладен: известен още като Абу Абдаллах Абд Ал-Хаким",
"Усама бен Ладен",
"Усама бин Ладин",
"Усама бін Ладен",
"Усама бін Ладэн",
"Ուսամա բեն Լադեն",
"אוסאמה בן לאדן",
"أسامة بن لادن",
"أسامة بن محمد بن عوض بن لادن",
"أسامة محمد عوض بن لادن Muhammed Awad Bin Laden",
"اسامه بن لادن",
"اسامہ بن لادن",
"ओसामा बिन लादेन",
"ಒಸಾಮಾ ಬಿನ್ ಲಾಡೆನ್",
"အိုစမာ ဘင်လာဒင်",
"ოსამა ბინ ლადენი",
"អូសាម៉ា ប៊ីន ឡាឌែន",
"ウサマ・ビンラディン",
"ウサマ・ビンラーディン",
"ウサマ・ビン・ラーデン",
"ウサーマ・ビン・ラーディン",
"オサマ・ビンラディン",
"オサマ・ビン・ラディン",
"乌萨马·本·拉丹",
"奥萨玛·本·拉登",
"奥萨马·本·拉登",
"奧薩瑪",
"奧薩馬·賓·拉登",
"本·拉丹",
"本·拉登",
"本拉丹",
"賓·拉登",
"오사마",
"오사마 빈라덴"
],
"birth_date": "1956;1957-01-01;1957-03-10;1957-07-28;1957-07-30;1958",
"countries": [
"af",
"sa",
"ye"
],
"createdAt": "2024-04-29T13:08:09.619Z",
"entityType": "Person",
"name": "Usama bin Laden",
"sanctions": [
"(CE) 844/2007 du 17/07/2007 (ONU Al Qaeda Etat - Islamique - règlement (UE) 881/2002) - (UE) 36/2011 du 18/01/2011 (ONU Al Qaeda Etat - Islamique - règlement (UE) 881/2002) - (UE) 480/2011 du 18/05/2011 (ONU Al Qaeda Etat - Islamique - règlement (UE) 881/2002) - (CE) 881/2002 du 27/05/2002 (ONU Al Qaeda Etat - Islamique - règlement (UE) 881/2002) - retrait de la citoyenneté saoudienne, nationalité afghane accordée par le régime des Taliban - décès en mai 2011 au Pakistan confirmé",
"Council Decision concerning restrictive measures against ISIL (Da'esh) and Al-Qaeda and persons, groups, undertakings and entities associated with them and repealing Common Position 2002/402/CFSP",
"Council Decision concerning restrictive measures against ISIL (Da’esh) and Al-Qaeda and persons, groups, undertakings and entities associated with them",
"Ordinance of 2 October 2000 on measures against individuals and entities associated with Usama bin Laden, the group «Al-Qaïda» or the Taliban (SR 946.203), annex 2 - 2013-03-09",
"SDN List - Executive Order 13224 (Terrorism)",
"TAQA - 596/2013 (OJ L172) - 2013-06-24"
],
"updatedAt": "2024-04-29T13:08:09.619Z",
"confidenceScore": 93.33333333333333
},
{
"politicalParty": [],
"positions": [],
"education": [],
"_id": "662f908fd2b06e101bd5b077",
"type": "sanction",
"externalId": "NK-LSNEVg2u4LhNBPBcv2a2xq",
"__v": 0,
"addresses": [
""
],
"aliases": [
"Abdul Rahman AL-KAHTANE",
"Bin Muhammad Awad ABBUD",
"Muhammad 'Awad ADBUD",
"Muhammad AWAD",
"Sa'ad BIN LADEN",
"Sa'ad Muhammad Awad ABUD",
"Sa'ad Muhammad BAABOOD",
"Sad BIN LADEN"
],
"birth_date": "1982",
"countries": [
"sa",
"sd"
],
"createdAt": "2024-04-29T12:18:22.907Z",
"entityType": "Person",
"name": "BIN LADEN, Sa'ad",
"sanctions": [
"SDN List - Unknown"
],
"updatedAt": "2024-04-29T13:06:41.021Z",
"confidenceScore": 86.66666666666667
}
],
"search_keyword": "osama bin laden"
"type": "sanction"
}
| Parameter | Type | Description |
|---|---|---|
| check_id | String | The check id that was returned in the initial response from the api call |
| check_creation_date | String | The date and time the request was recorded in ISO 8601 format |
| last_screened_date | String | Same as check creation date |
| created_by | String | The unique partner id |
| results | Object Array | This is the array of objects containing the results of the check |
| results.id | String | A unique identifier associated with the entry |
| results.externalId | String | An external identifier associated with the entry |
| results.type | String | The type of PEP ("sanction" in this example) |
| results.entityType | String | The type of entity, such as "Individual" or “Business” |
| results.name | String | The name of the individual or company |
| results.aliases | String Array | An array of alternative names or aliases associated with the individual or entity. |
| results.birth_date | String | Date of birth of the individual (optional for companies) |
| results.countries | String Array | An array of ISO 3166-1 alpha-2 country codes representing the nationality |
| results.createdAt | String | Date and time the entry was created in ISO 8601 format |
| results.updatedAt | String | Date and time the entry was last updated in ISO 8601 format |
| results.sanctions | String Array | An array of sanctions the individual or entity is listed on (if applicable) |
| results.politicalParty | String Array | An array of political parties the individual is affiliated with (if applicable) |
| results.positions | String Array | An array of positions or titles held by the individual (if applicable) |
| results.education | String Array | An array of educational institutions attended by the individual (if applicable) |
| results.gender | String | Gender of the individual (if available) |
| results.confidenceScore | String | A numeric value representing the confidence level in the match |
| results.addresses | String Array | An array of addresses associated with the individual or entity (if applicable) |
| results.search_keyword | String | The search keyword used for the check |
| results.type | String | The type: sanction |