{ "item": [ { "name": "AML Database", "description": "The dilisense AML Database provides you with access to the dilisense consolidated file which includes a myriad of sanction, PEP, criminal watch lists and additional sources. All sources are listed on our website (https://dilisense.com). The file can be downloaded via API in JSON Lines format.\n\nYou can download the consolidated file up to 50 times a day, getConsolidatedFile and getConsolidatedDelta together.", "item": [ { "id": "57c171d5-4773-4a88-a214-779373ea7ae4", "name": "Download the changes to the AML Database", "request": { "name": "Download the changes to the AML Database", "description": { "content": "The getConsolidatedDelta API method returns a list of deviations compared to an earlier version of the database. It is formatted as JSON Lines and consists of the same attributes as described in the AML Screening API service, with a separate line per changed record.\n\nAdditionally the file-version is provided in the header which needs to be stored for the next API call.", "type": "text/plain" }, "url": { "path": [ "v1", "getConsolidatedDelta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The file-version in the response header from the API call to `getConsolidatedFile` or `getConsolidatedDelta`. The file-version cannot be older than two weeks. An unknown file-version returns a 400 HTTP error code with the error_message `Provided previous version does not exists!`.", "type": "text/plain" }, "key": "previous", "value": "1744792260290" }, { "disabled": true, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/jsonl" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "6130b20e-2a19-4efd-9f25-d537d85b8805", "name": "The changed records as JSON Lines, one change per line.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedDelta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The file-version in the response header from the API call to `getConsolidatedFile` or `getConsolidatedDelta`. The file-version cannot be older than two weeks. An unknown file-version returns a 400 HTTP error code with the error_message `Provided previous version does not exists!`.", "type": "text/plain" }, "key": "previous", "value": "1744792260290" }, { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/jsonl" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/jsonl" }, { "disabled": false, "description": { "content": "The file-version, store it to call `getConsolidatedDelta` with it as `previous` next time.", "type": "text/plain" }, "key": "File-Version", "value": "string" } ], "body": "{\"type\":\"ADD\",\"record\":{\"source_id\":\"in_interpol_most_wanted_list\",\"source_type\":\"CRIMINAL\",\"id\":\"9a18cb49f9ff6af5\",\"entity_type\":\"INDIVIDUAL\",\"gender\":\"MALE\",\"name\":\"TASAWAR IQBAL\",\"last_names\":[\"IQBAL\"],\"given_names\":[\"TASAWAR\"],\"date_of_birth\":[\"07/09/1981\"],\"place_of_birth\":[\"Pakistan\",\"Gujrat\"],\"citizenship\":[\"Pakistan\"],\"sanction_details\":[\"Issuing country: Pakistan\",\"Charge: Murder\"],\"links\":[\"https://www.interpol.int/en/How-we-work/Notices/View-Red-Notices#2018-14069\"],\"other_information\":[\"Weight: 65 kg\",\"Height: 1.72 m\",\"Language spoken: Panjabi\",\"Language spoken: Urdu\",\"Eye color: BLA\",\"Hair color: BLA\"]}}\n{\"type\":\"UPDATE\",\"record\":{\"source_id\":\"dilisense_pep\",\"source_type\":\"PEP\",\"id\":\"9a18cb46f9of6af5\",\"pep_type\":\"POLITICIAN\",\"entity_type\":\"INDIVIDUAL\",\"gender\":\"MALE\",\"name\":\"Joël Bruneau\",\"last_names\":[\"Bruneau\"],\"given_names\":[\"Joël\"],\"date_of_birth\":[\"07/09/1963\"],\"place_of_birth\":[\"Châteauroux\"],\"citizenship\":[\"France\"],\"description\":[\"French politician\"],\"occupations\":[\"board member\",\"politician\",\"professions libérales et assimilés\"],\"positions\":[\"2014-03-30 - 2020-05-17 conseiller municipal de Caen\",\"2014-04-05 - 2020-05-22 mayor of Caen\",\"Since 2017-01-01 conseiller communautaire de Caen la Mer\",\"Since 2020-05-18 conseiller municipal de Caen\",\"Since 2020-05-23 mayor of Caen\",\"conseiller régional de Basse-Normandie\"],\"political_parties\":[\"Union for a Popular Movement\"],\"links\":[\"Facebook: joel.bruneau.50\"]}}\n{\"type\":\"DELETE\",\"record\":{\"source_id\":\"us_occ_enforcement_actions_sanction_list\",\"source_type\":\"SANCTION\",\"id\":\"9a12cb46f9ff6af5\",\"entity_type\":\"ENTITY\",\"name\":\"First Fidelity Trust, National Association, Florida\",\"address\":[\"Boca Raton, Florida (FL), USA\"],\"jurisdiction\":[\"USA\"],\"sanction_details\":[\"Civil Money Penalty (CMP) for details see: https://www.occ.gov/topics/laws-regulations/enforcement-actions/enforcement-actions-types.html\",\"Start date: 8/5/1991\"]}}\n", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "d66f9cfb-dc53-4e58-9e84-4b416ee1249d", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedDelta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The file-version in the response header from the API call to `getConsolidatedFile` or `getConsolidatedDelta`. The file-version cannot be older than two weeks. An unknown file-version returns a 400 HTTP error code with the error_message `Provided previous version does not exists!`.", "type": "text/plain" }, "key": "previous", "value": "1744792260290" }, { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "18a2f039-d330-4b81-abd7-c8d367f2ea0c", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedDelta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The file-version in the response header from the API call to `getConsolidatedFile` or `getConsolidatedDelta`. The file-version cannot be older than two weeks. An unknown file-version returns a 400 HTTP error code with the error_message `Provided previous version does not exists!`.", "type": "text/plain" }, "key": "previous", "value": "1744792260290" }, { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3ab00fd2-337d-4068-9113-67ba622cb3fe", "name": "The AML Database is not enabled for your API key.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedDelta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The file-version in the response header from the API call to `getConsolidatedFile` or `getConsolidatedDelta`. The file-version cannot be older than two weeks. An unknown file-version returns a 400 HTTP error code with the error_message `Provided previous version does not exists!`.", "type": "text/plain" }, "key": "previous", "value": "1744792260290" }, { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "48b38e22-2817-431b-9605-e31fbc9c738b", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedDelta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The file-version in the response header from the API call to `getConsolidatedFile` or `getConsolidatedDelta`. The file-version cannot be older than two weeks. An unknown file-version returns a 400 HTTP error code with the error_message `Provided previous version does not exists!`.", "type": "text/plain" }, "key": "previous", "value": "1744792260290" }, { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "357005af-c845-406c-b92e-dafbb1913d13", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedDelta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The file-version in the response header from the API call to `getConsolidatedFile` or `getConsolidatedDelta`. The file-version cannot be older than two weeks. An unknown file-version returns a 400 HTTP error code with the error_message `Provided previous version does not exists!`.", "type": "text/plain" }, "key": "previous", "value": "1744792260290" }, { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "303f4f0c-cade-43aa-bdcf-2ae962aa1edb", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedDelta" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "(Required) The file-version in the response header from the API call to `getConsolidatedFile` or `getConsolidatedDelta`. The file-version cannot be older than two weeks. An unknown file-version returns a 400 HTTP error code with the error_message `Provided previous version does not exists!`.", "type": "text/plain" }, "key": "previous", "value": "1744792260290" }, { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0f10c405-f260-4576-9398-d5cd3c3586fb", "name": "Download the AML Database", "request": { "name": "Download the AML Database", "description": { "content": "The getConsolidatedFile API method returns the AML Database in JSON Lines format and consists of the same attributes as described in the AML Screening API Service: every line is one AmlRecord, without `list_date`.\n\nAdditionally the file-version is provided in the header which can be stored in order to call the `getConsolidatedDelta` endpoint.", "type": "text/plain" }, "url": { "path": [ "v1", "getConsolidatedFile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/jsonl" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "08a4932f-34f2-473b-bad8-6fb7414c2e95", "name": "The AML Database as JSON Lines, one record per line.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedFile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/jsonl" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/jsonl" }, { "disabled": false, "description": { "content": "The file-version, store it to call `getConsolidatedDelta` with it as `previous` next time.", "type": "text/plain" }, "key": "File-Version", "value": "string" } ], "body": "{\"source_id\":\"eu_financial_sanction_list\",\"source_type\":\"SANCTION\",\"id\":\"9a485b46f9ff6af5\",\"entity_type\":\"INDIVIDUAL\",\"gender\":\"MALE\",\"name\":\"Hodjatoleslam SOLTANI\",\"last_names\":[\"SOLTANI\"],\"alias_names\":[\"Hodjatoleslam Seyed Mohammad SOLTANI\"],\"given_names\":[\"Hodjatoleslam\",\"Seyed Mohammad\"],\"sanction_details\":[\"2020-04-08\",\"IRN\"],\"functions\":[\"Head of the Organisation for Islamic Propaganda in the province of Khorasan-Razavi. Judge, Mashhad Revolutionary Court until 2013.\"]}\n{\"source_id\":\"us_occ_enforcement_actions_sanction_list\",\"source_type\":\"SANCTION\",\"id\":\"9a12cb46f9ff6af5\",\"entity_type\":\"ENTITY\",\"name\":\"First Fidelity Trust, National Association, Florida\",\"address\":[\"Boca Raton, Florida (FL), USA\"],\"jurisdiction\":[\"USA\"],\"sanction_details\":[\"Civil Money Penalty (CMP) for details see: https://www.occ.gov/topics/laws-regulations/enforcement-actions/enforcement-actions-types.html\",\"Start date: 8/5/1991\"]}\n{\"source_id\":\"in_interpol_most_wanted_list\",\"source_type\":\"CRIMINAL\",\"id\":\"9a18cb49f9ff6af5\",\"entity_type\":\"INDIVIDUAL\",\"gender\":\"MALE\",\"name\":\"TASAWAR IQBAL\",\"last_names\":[\"IQBAL\"],\"given_names\":[\"TASAWAR\"],\"date_of_birth\":[\"07/09/1981\"],\"place_of_birth\":[\"Pakistan\",\"Gujrat\"],\"citizenship\":[\"Pakistan\"],\"sanction_details\":[\"Issuing country: Pakistan\",\"Charge: Murder\"],\"links\":[\"https://www.interpol.int/en/How-we-work/Notices/View-Red-Notices#2018-14069\"],\"other_information\":[\"Weight: 65 kg\",\"Height: 1.72 m\",\"Language spoken: Panjabi\",\"Language spoken: Urdu\",\"Eye color: BLA\",\"Hair color: BLA\"]}\n{\"source_id\":\"ru_ffms_terrorist_list\",\"source_type\":\"SANCTION\",\"id\":\"ca18hb46f9ff6af5\",\"entity_type\":\"ENTITY\",\"name\":\"МЕСТНАЯ РЕЛИГИОЗНАЯ ОРГАНИЗАЦИЯ СВИДЕТЕЛЕЙ ИЕГОВЫ Г.НИЖНЕКАМСКА И НИЖНЕКАМСКОГО РАЙОНА \\\"УПРАВЛЕНЧЕСКОГО ЦЕНТРА СВИДЕТЕЛЕЙ ИЕГОВЫ В РОССИИ\\\"\",\"company_number\":[\"ИНН: 1651024363;\"]}\n{\"source_id\":\"fr_tresor_registre_national_des_gels_sanction_list\",\"source_type\":\"SANCTION\",\"id\":\"9a18cp46f9ff6af5\",\"entity_type\":\"ENTITY\",\"name\":\"Med Wave Shipping\",\"sanction_details\":[\"Regime de sanction ou de gel national concerne: Libye \\n(UE Annexe III)\",\"Fondement juridique: 2016/44 18/01/2016\",\"Arrete d\\u0027extension de la mesure aux PTOM: arrêté ECOT2025028A du 21/09/2020\",\"Lien utile: https://www.tresor.economie.gouv.fr/services-aux-entreprises/sanctions-economiques\",\"Date d\\u0027ajout au registre: 9/21/20\"],\"other_information\":[\"Adresse: Office 511, 5th Floor, Baraka Building, Dauwar Al-Waha, Jordanie;\",\"Adel Al-Hojrat building n°3, 1st Floor, opposite Swefieh, Mall-Swefieh Po Box 850880 Amman, 11185 Jordanie;\",\"Ground Floor, Orient Queen Homes Building, Liban\",\"Tél. +962787064121; +96265865550; +96265868550\",\"Courriel: operation@medwave.co\",\"compagnie maritime qui exploite le navire Bana dont il a été établie qu’il a violé l’embargo sur les armes imposé à la Libye par la résolution 1970 (2011) du Conseil de sécurité des Nations unies et transposé à l’article 1er de la décision (PESC) 2015/1333. Le Bana a en particulier été lié à des transports de matériel militaire vers la Libye en janvier 2020.\",\"Désigné par le règlement (UE) 2020/1309 du 21/09/2020\"]}\n{\"source_id\":\"dilisense_pep\",\"source_type\":\"PEP\",\"id\":\"9a18cb46f9of6af5\",\"pep_type\":\"POLITICIAN\",\"entity_type\":\"INDIVIDUAL\",\"gender\":\"MALE\",\"name\":\"Joël Bruneau\",\"last_names\":[\"Bruneau\"],\"given_names\":[\"Joël\"],\"date_of_birth\":[\"07/09/1963\"],\"place_of_birth\":[\"Châteauroux\"],\"citizenship\":[\"France\"],\"description\":[\"French politician\"],\"occupations\":[\"board member\",\"politician\",\"professions libérales et assimilés\"],\"positions\":[\"2014-03-30 - 2020-05-17 conseiller municipal de Caen\",\"2014-04-05 - 2020-05-22 mayor of Caen\",\"Since 2017-01-01 conseiller communautaire de Caen la Mer\",\"Since 2020-05-18 conseiller municipal de Caen\",\"Since 2020-05-23 mayor of Caen\",\"conseiller régional de Basse-Normandie\"],\"political_parties\":[\"Union for a Popular Movement\"],\"links\":[\"Facebook: joel.bruneau.50\"]}\n", "cookie": [], "_postman_previewlanguage": "text" }, { "id": "2497dcef-3a61-43b3-94a2-b46f07ecd187", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedFile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "22b9bae4-6b3a-4b04-95c3-3beaad50ad07", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedFile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e8328a73-2d87-4917-a550-f11d4ab427cb", "name": "The AML Database is not enabled for your API key.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedFile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "e32cbef2-91ed-449f-a304-98206b897d0c", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedFile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "13f9df87-4272-4d42-9c8d-13aff51941a4", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedFile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7463d89e-ecfb-4071-ab4b-5bc9c5a73c9a", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "getConsolidatedFile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources the consolidated file contains. If the `includes` parameter is not specified, the sources included for your API key are used.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The contained sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` returns exactly those two sources, while `includes=included,br_national_registry_cnep` returns the sources included for your API key plus that one.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "AML Screening", "description": "The dilisense API provides you with machine-to-machine access to the dilisense methods for checking individual and entity names against sanction, PEP and wanted lists.\n\nScreening calls count towards your monthly quota of billed requests, which the AML Screening API and the Adverse Media Screening API share.", "item": [ { "id": "563b4690-9865-4b26-b2eb-3dc935ab51f1", "name": "Screen an entity", "request": { "name": "Screen an entity", "description": { "content": "The checkEntity API method searches for entities that match certain criteria. The client can decide which lists should be included in the search to limit the results to the relevant ones.\n\n**Legal form synonym matching.** Company legal form terms in the search string are automatically matched against their synonyms. A record is found regardless of which abbreviation, punctuation variant or long form of the legal form is used in the search or in the record itself. Examples of legal forms that are treated as equivalent:\n\n- \"LLC\", \"L.L.C.\" and \"limited liability company\"\n- \"GmbH\", \"G m b H\" and \"Gesellschaft mit beschränkter Haftung\"\n- \"SARL\", \"S.A.R.L.\" and \"société à responsabilité limitée\"\n\nFor example, a search for \"Reyco Gesellschaft mit beschränkter Haftung\" will also find the record \"REYCO GMBH\" and vice versa. The synonym matching works in both directions, applies to the `names` as well as the `search_all` parameter and is combined with the `fuzzy_search` parameter if set. No additional parameter is needed to activate it.", "type": "text/plain" }, "url": { "path": [ "v1", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": true, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": true, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4f88bad2-90fc-4b29-9f66-bf89cdbeafb9", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"timestamp\": \"2024-09-24T20:29:52Z\",\n \"total_hits\": 1,\n \"found_records\": [\n {\n \"id\": \"4bae94a04647a62f\",\n \"entity_type\": \"ENTITY\",\n \"name\": \"REYCO GMBH\",\n \"address\": [\n \"Germany\",\n \"Nordrhein-Westfalen\",\n \"Dinslaken\",\n \"Karlstrasse 19\",\n \"46535\"\n ],\n \"alias_names\": [\n \"REYCO GMBH GERMANY\"\n ],\n \"sanction_details\": [\n \"Subject to Secondary Sanctions\"\n ],\n \"source_id\": \"us_department_of_treasury_sdn\",\n \"source_type\": \"SANCTION\",\n \"list_date\": \"1615935600000\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f86b642-aaeb-4edb-9257-e3f8a202fd3a", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c14ed41f-336a-4f3f-8a80-89287915e62a", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8a81fe8c-b51e-4319-8c2d-2dc0383c897f", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e86acdd8-50de-485e-910b-fb04e0e1a274", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bb42c5fc-a68a-4311-a2e6-5668930d1c24", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "32c14e27-8888-464d-a551-f3422223f2c4", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "90e7df93-a1a5-4a89-8e2e-80b39da31a03", "name": "Screen an individual", "request": { "name": "Screen an individual", "description": { "content": "The checkIndividual API method searches for individuals that match certain criteria. The client can decide which lists should be included in the search to limit the results to the relevant ones.", "type": "text/plain" }, "url": { "path": [ "v1", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": true, "description": { "content": "This parameter searches for a match in citizenship. The value has to be a single country code in ISO 3166-1 alpha-2 format (e.g. 'DE' for Germany). The value is case-insensitive.\n\nIndividuals that have the given citizenship as well as individuals that have no citizenship value set are returned. If the value is not a two-letter country code, the API call will return a 400 HTTP error code.", "type": "text/plain" }, "key": "citizenship", "value": "string" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "dilisense_pep" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "19b32189-5c86-48cd-834c-d8de519dbb59", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "This parameter searches for a match in citizenship. The value has to be a single country code in ISO 3166-1 alpha-2 format (e.g. 'DE' for Germany). The value is case-insensitive.\n\nIndividuals that have the given citizenship as well as individuals that have no citizenship value set are returned. If the value is not a two-letter country code, the API call will return a 400 HTTP error code.", "type": "text/plain" }, "key": "citizenship", "value": "string" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "dilisense_pep" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"timestamp\": \"2024-09-24T19:16:00Z\",\n \"total_hits\": 1,\n \"found_records\": [\n {\n \"id\": \"c438b18a93cd3c13\",\n \"entity_type\": \"INDIVIDUAL\",\n \"children\": [\n \"Cassia Peaches Johnson\",\n \"Frank Alfred Odysseus Johnson\",\n \"Lara Lettice Johnson\",\n \"Milo Arthur Johnson\",\n \"Romy Iris Charlotte Johnson\",\n \"Stephanie Macintyre Johnson\",\n \"Theodore Apollo Johnson\",\n \"Wilfred Johnson\"\n ],\n \"name\": \"Boris Johnson\",\n \"address\": [\n \"GB\"\n ],\n \"last_names\": [\n \"Johnson\",\n \"Pfeffel\"\n ],\n \"alias_names\": [\n \"Alexander Boris de Pfeffel Johnson\",\n \"Boris\",\n \"BoJo\",\n \"Bo Jo\"\n ],\n \"given_names\": [\n \"Alexander\",\n \"Boris\"\n ],\n \"date_of_birth\": [\n \"19/06/1964\"\n ],\n \"place_of_birth\": [\n \"New York City\"\n ],\n \"citizenship\": [\n \"GB\",\n \"US\"\n ],\n \"occupations\": [\n \"journalist\",\n \"politician\"\n ],\n \"positions\": [\n \"2001-06-07 - 2005-04-11 Member of the 53rd Parliament of the United Kingdom\",\n \"2005-05-05 - 2008-06-04 Member of the 54th Parliament of the United Kingdom\",\n \"2008-05-04 - 2016-05-07 Mayor of London\",\n \"2015-05-07 - 2017-05-03 Member of the 56th Parliament of the United Kingdom\",\n \"2016-07-13 - 2018-07-09 Secretary of State for Foreign and Commonwealth Affairs\",\n \"2017-06-08 - 2019-11-06 Member of the 57th Parliament of the United Kingdom\",\n \"Since 2016-01-01 Member of the Privy Council of the United Kingdom\",\n \"Since 2019-07-23 Leader of the Conservative Party\",\n \"Since 2019-07-24 First Lord of the Treasury\",\n \"Since 2019-07-24 Minister for the Civil Service\",\n \"Since 2019-07-24 Prime Minister of the United Kingdom\",\n \"Since 2019-07-26 Minister for the Union\",\n \"Since 2019-12-12 Member of the 58th Parliament of the United Kingdom\"\n ],\n \"political_parties\": [\n \"Conservative Party\"\n ],\n \"links\": [\n \"https://www.gov.uk/government/people/boris-johnson\",\n \"https://members.parliament.uk/member/1423/contact\",\n \"Facebook: borisjohnson\",\n \"https://members.parliament.uk\",\n \"https://www.gov.uk/government/people\"\n ],\n \"source_id\": \"dilisense_pep\",\n \"source_type\": \"PEP\",\n \"pep_type\": \"POLITICIAN\",\n \"gender\": \"MALE\",\n \"spouse\": [\n \"Allegra Mostyn-Owen\",\n \"Carrie Johnson\",\n \"Marina Wheeler\"\n ],\n \"siblings\": [\n \"Jo Johnson\",\n \"Leo Johnson\",\n \"Rachel Johnson\"\n ],\n \"list_date\": \"0\",\n \"parents\": [\n \"Charlotte Johnson Wahl\",\n \"Stanley Johnson\"\n ],\n \"description\": [\n \"Prime Minister of the United Kingdom from 2019 to 2022\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "60cb1d81-6888-4e38-b379-627c9e4718fb", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "This parameter searches for a match in citizenship. The value has to be a single country code in ISO 3166-1 alpha-2 format (e.g. 'DE' for Germany). The value is case-insensitive.\n\nIndividuals that have the given citizenship as well as individuals that have no citizenship value set are returned. If the value is not a two-letter country code, the API call will return a 400 HTTP error code.", "type": "text/plain" }, "key": "citizenship", "value": "string" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "dilisense_pep" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f9b0c7a2-7921-4bcd-80c9-7c5d59ed690e", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "This parameter searches for a match in citizenship. The value has to be a single country code in ISO 3166-1 alpha-2 format (e.g. 'DE' for Germany). The value is case-insensitive.\n\nIndividuals that have the given citizenship as well as individuals that have no citizenship value set are returned. If the value is not a two-letter country code, the API call will return a 400 HTTP error code.", "type": "text/plain" }, "key": "citizenship", "value": "string" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "dilisense_pep" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76d60579-ffcc-4ceb-9207-a893cec58da9", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "This parameter searches for a match in citizenship. The value has to be a single country code in ISO 3166-1 alpha-2 format (e.g. 'DE' for Germany). The value is case-insensitive.\n\nIndividuals that have the given citizenship as well as individuals that have no citizenship value set are returned. If the value is not a two-letter country code, the API call will return a 400 HTTP error code.", "type": "text/plain" }, "key": "citizenship", "value": "string" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "dilisense_pep" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e46c906d-6889-4810-a5c2-5e94019eb74f", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "This parameter searches for a match in citizenship. The value has to be a single country code in ISO 3166-1 alpha-2 format (e.g. 'DE' for Germany). The value is case-insensitive.\n\nIndividuals that have the given citizenship as well as individuals that have no citizenship value set are returned. If the value is not a two-letter country code, the API call will return a 400 HTTP error code.", "type": "text/plain" }, "key": "citizenship", "value": "string" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "dilisense_pep" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "57e73454-d45a-4849-843d-4b0c9e6f5d9f", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "This parameter searches for a match in citizenship. The value has to be a single country code in ISO 3166-1 alpha-2 format (e.g. 'DE' for Germany). The value is case-insensitive.\n\nIndividuals that have the given citizenship as well as individuals that have no citizenship value set are returned. If the value is not a two-letter country code, the API call will return a 400 HTTP error code.", "type": "text/plain" }, "key": "citizenship", "value": "string" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "dilisense_pep" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7bf6f426-1314-45a4-99fe-ad938dbc53e8", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "This parameter searches for a match in citizenship. The value has to be a single country code in ISO 3166-1 alpha-2 format (e.g. 'DE' for Germany). The value is case-insensitive.\n\nIndividuals that have the given citizenship as well as individuals that have no citizenship value set are returned. If the value is not a two-letter country code, the API call will return a 400 HTTP error code.", "type": "text/plain" }, "key": "citizenship", "value": "string" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "dilisense_pep" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "d0abb8c7-7187-439b-95c4-3237a28d2130", "name": "Screen a name across all entity types", "request": { "name": "Screen a name across all entity types", "description": { "content": "The checkName API method returns all entity types instead of only INDIVIDUALS or ENTITIES. The available `entity_types` are\n\n- INDIVIDUAL\n- ENTITY\n- VESSEL\n- AIRCRAFT\n- JURISDICTION\n- OBJECT\n- UNKNOWN\n\nThe response attributes are the same as for the `checkIndividual` and `checkEntity` endpoints.", "type": "text/plain" }, "url": { "path": [ "v1", "checkName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": true, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": true, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "ee30ea88-e852-462e-bc29-4de2f7740314", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "checkName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"timestamp\": \"2024-09-24T19:16:00Z\",\n \"total_hits\": 1,\n \"found_records\": [\n {\n \"id\": \"c438b18a93cd3c13\",\n \"entity_type\": \"INDIVIDUAL\",\n \"children\": [\n \"Cassia Peaches Johnson\",\n \"Frank Alfred Odysseus Johnson\",\n \"Lara Lettice Johnson\",\n \"Milo Arthur Johnson\",\n \"Romy Iris Charlotte Johnson\",\n \"Stephanie Macintyre Johnson\",\n \"Theodore Apollo Johnson\",\n \"Wilfred Johnson\"\n ],\n \"name\": \"Boris Johnson\",\n \"address\": [\n \"GB\"\n ],\n \"last_names\": [\n \"Johnson\",\n \"Pfeffel\"\n ],\n \"alias_names\": [\n \"Alexander Boris de Pfeffel Johnson\",\n \"Boris\",\n \"BoJo\",\n \"Bo Jo\"\n ],\n \"given_names\": [\n \"Alexander\",\n \"Boris\"\n ],\n \"date_of_birth\": [\n \"19/06/1964\"\n ],\n \"place_of_birth\": [\n \"New York City\"\n ],\n \"citizenship\": [\n \"GB\",\n \"US\"\n ],\n \"occupations\": [\n \"journalist\",\n \"politician\"\n ],\n \"positions\": [\n \"2001-06-07 - 2005-04-11 Member of the 53rd Parliament of the United Kingdom\",\n \"2005-05-05 - 2008-06-04 Member of the 54th Parliament of the United Kingdom\",\n \"2008-05-04 - 2016-05-07 Mayor of London\",\n \"2015-05-07 - 2017-05-03 Member of the 56th Parliament of the United Kingdom\",\n \"2016-07-13 - 2018-07-09 Secretary of State for Foreign and Commonwealth Affairs\",\n \"2017-06-08 - 2019-11-06 Member of the 57th Parliament of the United Kingdom\",\n \"Since 2016-01-01 Member of the Privy Council of the United Kingdom\",\n \"Since 2019-07-23 Leader of the Conservative Party\",\n \"Since 2019-07-24 First Lord of the Treasury\",\n \"Since 2019-07-24 Minister for the Civil Service\",\n \"Since 2019-07-24 Prime Minister of the United Kingdom\",\n \"Since 2019-07-26 Minister for the Union\",\n \"Since 2019-12-12 Member of the 58th Parliament of the United Kingdom\"\n ],\n \"political_parties\": [\n \"Conservative Party\"\n ],\n \"links\": [\n \"https://www.gov.uk/government/people/boris-johnson\",\n \"https://members.parliament.uk/member/1423/contact\",\n \"Facebook: borisjohnson\",\n \"https://members.parliament.uk\",\n \"https://www.gov.uk/government/people\"\n ],\n \"source_id\": \"dilisense_pep\",\n \"source_type\": \"PEP\",\n \"pep_type\": \"POLITICIAN\",\n \"gender\": \"MALE\",\n \"spouse\": [\n \"Allegra Mostyn-Owen\",\n \"Carrie Johnson\",\n \"Marina Wheeler\"\n ],\n \"siblings\": [\n \"Jo Johnson\",\n \"Leo Johnson\",\n \"Rachel Johnson\"\n ],\n \"list_date\": \"0\",\n \"parents\": [\n \"Charlotte Johnson Wahl\",\n \"Stanley Johnson\"\n ],\n \"description\": [\n \"Prime Minister of the United Kingdom from 2019 to 2022\"\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fab9b39a-ab03-43e2-b0d8-ce8572929bac", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "checkName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38983e27-03ba-4ee0-8a73-6782258ddb55", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "checkName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "894b218f-a9fa-41b3-bf1e-03fa92f3116c", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "checkName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "413da334-a76f-4573-8492-863ad95ac0c9", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "checkName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a9ace2f2-bd4c-466a-8e0a-b7d35991d2c6", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "checkName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "343264c7-5de4-48eb-b138-0250256aeac3", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "checkName" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "40e27e3e-97dd-49bd-8c9a-36518d8db4cd", "name": "Generate a screening report for an entity", "request": { "name": "Generate a screening report for an entity", "description": { "content": "The generateEntityReport API method searches for entities and provides back a pdf-report that shows in which lists the search algorithm found hits based on the entered criteria. The report is only supported for the source_type SANCTION, PEP and CRIMINAL.\n\nThe response provided back is a Base64 encoded String that can be decoded to a pdf file.", "type": "text/plain" }, "url": { "path": [ "v1", "generateEntityReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": true, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": true, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "c7ddacf8-ff95-42d8-b176-ebc41c582173", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "generateEntityReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0787a9c7-82d5-49b8-bd94-4f09a3d3bdc2", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "generateEntityReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a2b38932-63f6-46d0-8672-6cd334290e3b", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "generateEntityReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "fbd040cf-0ac3-49de-84d2-1e97f2cb79e2", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "generateEntityReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7b213371-fe52-4a89-a18b-9f8e0b7b9943", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "generateEntityReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cbdff08d-9906-467e-aa43-4fa15df3d93e", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "generateEntityReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0e3ab590-f9b1-4aa4-a336-d81bdd62a75d", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "generateEntityReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "52ddc031-f5fe-4ae8-85bf-24232e2db807", "name": "Generate a screening report for an individual", "request": { "name": "Generate a screening report for an individual", "description": { "content": "The generateIndividualReport API method searches for individuals and provides back a pdf-report that shows in which lists the search algorithm found hits based on the entered criteria. The report is only supported for the source_type SANCTION, PEP and CRIMINAL.\n\nThe response provided back is a Base64 encoded String that can be decoded to a pdf file.", "type": "text/plain" }, "url": { "path": [ "v1", "generateIndividualReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": true, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5487d092-47f0-4b82-926b-297acfa2e2aa", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "generateIndividualReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "string", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "da1bbe84-913b-4ca3-a3db-400cb2bee922", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "generateIndividualReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6fe952de-2f85-41a1-99c6-88a3a301c0bc", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "generateIndividualReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f26b823b-1953-4e9e-8dd4-bf7cf5340ce2", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "generateIndividualReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "965c3f80-f55a-4f04-ba3f-17f93388c99c", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "generateIndividualReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00b08cdc-24d6-4a70-a891-2aafb213358f", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "generateIndividualReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2799176-f987-44f5-97a9-57e38f80cc62", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "generateIndividualReport" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" }, { "disabled": false, "description": { "content": "Defines which sources are searched. If the `includes` parameter is not specified, the sources included for your API key are searched.\n\nThe value is a comma-separated list of source IDs and/or the selector `included`. The searched sources are the union of all entries.\n\n- `included`: the sources that are included for your API key.\n- source IDs: exactly those sources, for example \"us_department_of_treasury_non_sdn\".\n\nFor example `includes=us_department_of_treasury_non_sdn,eu_financial_sanction_list` searches exactly those two sources, while `includes=included,br_national_registry_cnep` searches the sources included for your API key plus that one.\n\nThe source catalogue contains all screening sources available through the API. Your API key has a set of included sources, while additional sources from the catalogue can be selected individually. Use the getSourceList API call to retrieve the catalogue and source IDs.", "type": "text/plain" }, "key": "includes", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Adverse Media Screening", "description": "The dilisense API provides you with machine-to-machine access to the dilisense methods for checking individual and entity names against Adverse Media news sources.\n\nScreening calls count towards your monthly quota of billed requests, which the AML Screening API and the Adverse Media Screening API share.", "item": [ { "id": "b07bb681-c202-46bd-a75e-3efe51c6adb7", "name": "Screen an entity against adverse media", "request": { "name": "Screen an entity against adverse media", "description": { "content": "The checkEntity API method searches for entities that match certain criteria. All categories are returned, even if they contain 0 hits.", "type": "text/plain" }, "url": { "path": [ "v1", "media", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Deutsche Bank" }, { "disabled": true, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of entities within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": true, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": true, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": true, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "2c5465f7-a379-43e2-bc41-4c68b71c0768", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "media", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Deutsche Bank" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of entities within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"timestamp\": \"2024-12-20T14:17:16.843Z\",\n \"total_hits\": 3508683,\n \"news_exposures\": {\n \"violent_crime\": {\n \"category\": \"violent_crime\",\n \"hits\": 28466\n },\n \"terrorism\": {\n \"category\": \"terrorism\",\n \"hits\": 796691\n },\n \"regulatory\": {\n \"category\": \"regulatory\",\n \"hits\": 984492\n },\n \"financial_crime\": {\n \"category\": \"financial_crime\",\n \"hits\": 26088\n },\n \"political\": {\n \"category\": \"political\",\n \"hits\": 1649400\n },\n \"organized_crime\": {\n \"category\": \"organized_crime\",\n \"hits\": 23546\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "3483a211-34f1-42ed-85d1-a807eb22a16d", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "media", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Deutsche Bank" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of entities within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "78c8c085-620c-4ed7-8950-1258b2be1bc9", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "media", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Deutsche Bank" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of entities within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ec69d16d-5775-49cb-b25b-a46ec282df4c", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "media", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Deutsche Bank" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of entities within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "688f07a4-00f0-438d-b46d-d55eda59a14d", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "media", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Deutsche Bank" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of entities within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4195c324-43dc-4b75-828b-119ac07eeadb", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "media", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Deutsche Bank" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of entities within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80251e4e-ad68-4258-aa3f-0177e26ff878", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "media", "checkEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Deutsche Bank" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of entities within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "9e3a0ae4-5ed2-494b-8f89-14278b855999", "name": "Screen an individual against adverse media", "request": { "name": "Screen an individual against adverse media", "description": { "content": "The checkIndividual API method searches for individuals that match certain criteria. All categories are returned, even if they contain 0 hits.", "type": "text/plain" }, "url": { "path": [ "v1", "media", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Boris Johnson" }, { "disabled": true, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of natural persons within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": true, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": true, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": true, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "0e6fb984-8cbf-4ae5-a7d2-30ae94ce076f", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "media", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of natural persons within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"timestamp\": \"2024-12-20T14:17:16.843Z\",\n \"total_hits\": 3508683,\n \"news_exposures\": {\n \"violent_crime\": {\n \"category\": \"violent_crime\",\n \"hits\": 28466\n },\n \"terrorism\": {\n \"category\": \"terrorism\",\n \"hits\": 796691\n },\n \"regulatory\": {\n \"category\": \"regulatory\",\n \"hits\": 984492\n },\n \"financial_crime\": {\n \"category\": \"financial_crime\",\n \"hits\": 26088\n },\n \"political\": {\n \"category\": \"political\",\n \"hits\": 1649400\n },\n \"organized_crime\": {\n \"category\": \"organized_crime\",\n \"hits\": 23546\n }\n }\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "e7b3c7f5-50a9-4da6-b0dd-37aeb57eec06", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "media", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of natural persons within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "67a11a70-65a5-414e-9c0d-3061b3fdfeee", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "media", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of natural persons within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "2b2df09f-46a3-4eed-bfa6-c8a258bb38df", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "media", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of natural persons within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "480b86ae-4100-4c5c-bacd-723aaefcae54", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "media", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of natural persons within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f2c908fc-481d-4a53-81f6-af80ee55dfc0", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "media", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of natural persons within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "00721b0a-ed27-45e1-b517-c14fee28c3ce", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "media", "checkIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names of natural persons within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Determines if detailed articles are included in the response. Defaults to `false`.\n\nThe number of articles per `category` is limited to 10 items. The limit can be increased per API key if required.", "type": "text/plain" }, "key": "fetch_articles", "value": "false" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "73dba8fb-d676-4165-b1ca-f912da83a5c9", "name": "Search adverse media articles", "request": { "name": "Search adverse media articles", "description": { "content": "The search API method returns the matching articles themselves instead of a category breakdown. It is the endpoint to use when you need every article that matches your query, because the results can be paged through with the `cursor` parameter.\n\nIn contrast to `checkIndividual` and `checkEntity`, the articles are returned as a flat `articles` array without the `news_exposures` category breakdown.", "type": "text/plain" }, "url": { "path": [ "v1", "media", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Example Holding" }, { "disabled": true, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "Comma-separated list of terms that all have to appear in the body of the article, in addition to the `names` / `search_all` matching. An article is only returned if every term is present.\n\nFor example `term_filter=fraud,money laundering` returns only those articles that contain both \"fraud\" and \"money laundering\".", "type": "text/plain" }, "key": "term_filter", "value": "fraud,money laundering" }, { "disabled": true, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": true, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": true, "description": { "content": "Pages through all matching articles. Leave the parameter out for the first page. Every response contains a `next_cursor` value, which has to be passed back as `cursor` to retrieve the next page. On the last page `next_cursor` is absent.\n\nThe `cursor` value is opaque and must neither be constructed nor parsed on your side. There is no parameter to change the page size, and `total_hits` stays constant while you page through the results.", "type": "text/plain" }, "key": "cursor", "value": "string" }, { "disabled": true, "description": { "content": "If set, considers only articles of the given category. Possible values are\n\n- political\n- regulatory\n- terrorism\n- financial_crime\n- organized_crime\n- violent_crime", "type": "text/plain" }, "key": "category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "86cb702b-1db2-4560-9641-277ac0fc43be", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "media", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Example Holding" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "Comma-separated list of terms that all have to appear in the body of the article, in addition to the `names` / `search_all` matching. An article is only returned if every term is present.\n\nFor example `term_filter=fraud,money laundering` returns only those articles that contain both \"fraud\" and \"money laundering\".", "type": "text/plain" }, "key": "term_filter", "value": "fraud,money laundering" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Pages through all matching articles. Leave the parameter out for the first page. Every response contains a `next_cursor` value, which has to be passed back as `cursor` to retrieve the next page. On the last page `next_cursor` is absent.\n\nThe `cursor` value is opaque and must neither be constructed nor parsed on your side. There is no parameter to change the page size, and `total_hits` stays constant while you page through the results.", "type": "text/plain" }, "key": "cursor", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles of the given category. Possible values are\n\n- political\n- regulatory\n- terrorism\n- financial_crime\n- organized_crime\n- violent_crime", "type": "text/plain" }, "key": "category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"timestamp\": \"2026-08-21T08:52:27.399Z\",\n \"total_hits\": 1,\n \"articles\": [\n {\n \"timestamp\": \"2026-06-27T19:44:50Z\",\n \"id\": \"219938:26776\",\n \"language\": \"en\",\n \"headline\": \"Regulator fines Example Holding over money laundering controls\",\n \"body\": \"

The financial regulator has imposed a fine on Example Holding following an investigation into the company's anti-money laundering controls.

According to the regulator, the company failed to monitor a number of high-risk client relationships over a period of three years, and suspicious transaction reports were not escalated in time.

Example Holding stated that it has since strengthened its compliance function and will not appeal the decision. Two former board members are subject to separate proceedings on suspicion of fraud.

\",\n \"source_link\": \"https://www.example.com/regulator-fines-example-holding\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "15c8f3df-caa5-4535-93de-0bdb0b4e5645", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "media", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Example Holding" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "Comma-separated list of terms that all have to appear in the body of the article, in addition to the `names` / `search_all` matching. An article is only returned if every term is present.\n\nFor example `term_filter=fraud,money laundering` returns only those articles that contain both \"fraud\" and \"money laundering\".", "type": "text/plain" }, "key": "term_filter", "value": "fraud,money laundering" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Pages through all matching articles. Leave the parameter out for the first page. Every response contains a `next_cursor` value, which has to be passed back as `cursor` to retrieve the next page. On the last page `next_cursor` is absent.\n\nThe `cursor` value is opaque and must neither be constructed nor parsed on your side. There is no parameter to change the page size, and `total_hits` stays constant while you page through the results.", "type": "text/plain" }, "key": "cursor", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles of the given category. Possible values are\n\n- political\n- regulatory\n- terrorism\n- financial_crime\n- organized_crime\n- violent_crime", "type": "text/plain" }, "key": "category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ad04070-6c75-400b-9bd4-d890d1168ced", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "media", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Example Holding" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "Comma-separated list of terms that all have to appear in the body of the article, in addition to the `names` / `search_all` matching. An article is only returned if every term is present.\n\nFor example `term_filter=fraud,money laundering` returns only those articles that contain both \"fraud\" and \"money laundering\".", "type": "text/plain" }, "key": "term_filter", "value": "fraud,money laundering" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Pages through all matching articles. Leave the parameter out for the first page. Every response contains a `next_cursor` value, which has to be passed back as `cursor` to retrieve the next page. On the last page `next_cursor` is absent.\n\nThe `cursor` value is opaque and must neither be constructed nor parsed on your side. There is no parameter to change the page size, and `total_hits` stays constant while you page through the results.", "type": "text/plain" }, "key": "cursor", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles of the given category. Possible values are\n\n- political\n- regulatory\n- terrorism\n- financial_crime\n- organized_crime\n- violent_crime", "type": "text/plain" }, "key": "category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1cff5b1f-3d53-4ece-8eab-728f13b67e7d", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "media", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Example Holding" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "Comma-separated list of terms that all have to appear in the body of the article, in addition to the `names` / `search_all` matching. An article is only returned if every term is present.\n\nFor example `term_filter=fraud,money laundering` returns only those articles that contain both \"fraud\" and \"money laundering\".", "type": "text/plain" }, "key": "term_filter", "value": "fraud,money laundering" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Pages through all matching articles. Leave the parameter out for the first page. Every response contains a `next_cursor` value, which has to be passed back as `cursor` to retrieve the next page. On the last page `next_cursor` is absent.\n\nThe `cursor` value is opaque and must neither be constructed nor parsed on your side. There is no parameter to change the page size, and `total_hits` stays constant while you page through the results.", "type": "text/plain" }, "key": "cursor", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles of the given category. Possible values are\n\n- political\n- regulatory\n- terrorism\n- financial_crime\n- organized_crime\n- violent_crime", "type": "text/plain" }, "key": "category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "031eb6a5-d11b-49e9-a86b-15da954f88ee", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "media", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Example Holding" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "Comma-separated list of terms that all have to appear in the body of the article, in addition to the `names` / `search_all` matching. An article is only returned if every term is present.\n\nFor example `term_filter=fraud,money laundering` returns only those articles that contain both \"fraud\" and \"money laundering\".", "type": "text/plain" }, "key": "term_filter", "value": "fraud,money laundering" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Pages through all matching articles. Leave the parameter out for the first page. Every response contains a `next_cursor` value, which has to be passed back as `cursor` to retrieve the next page. On the last page `next_cursor` is absent.\n\nThe `cursor` value is opaque and must neither be constructed nor parsed on your side. There is no parameter to change the page size, and `total_hits` stays constant while you page through the results.", "type": "text/plain" }, "key": "cursor", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles of the given category. Possible values are\n\n- political\n- regulatory\n- terrorism\n- financial_crime\n- organized_crime\n- violent_crime", "type": "text/plain" }, "key": "category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "f33b07ae-d1ea-4e9c-a3b5-cefb53f271a4", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "media", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Example Holding" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "Comma-separated list of terms that all have to appear in the body of the article, in addition to the `names` / `search_all` matching. An article is only returned if every term is present.\n\nFor example `term_filter=fraud,money laundering` returns only those articles that contain both \"fraud\" and \"money laundering\".", "type": "text/plain" }, "key": "term_filter", "value": "fraud,money laundering" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Pages through all matching articles. Leave the parameter out for the first page. Every response contains a `next_cursor` value, which has to be passed back as `cursor` to retrieve the next page. On the last page `next_cursor` is absent.\n\nThe `cursor` value is opaque and must neither be constructed nor parsed on your side. There is no parameter to change the page size, and `total_hits` stays constant while you page through the results.", "type": "text/plain" }, "key": "cursor", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles of the given category. Possible values are\n\n- political\n- regulatory\n- terrorism\n- financial_crime\n- organized_crime\n- violent_crime", "type": "text/plain" }, "key": "category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c46a3046-ac22-446f-b5d7-fd2463b21d2c", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "media", "search" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. All matches are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "Example Holding" }, { "disabled": false, "description": { "content": "Search string that is screened against Adverse Media news sources. Only names within the articles are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "string" }, { "disabled": false, "description": { "content": "Comma-separated list of terms that all have to appear in the body of the article, in addition to the `names` / `search_all` matching. An article is only returned if every term is present.\n\nFor example `term_filter=fraud,money laundering` returns only those articles that contain both \"fraud\" and \"money laundering\".", "type": "text/plain" }, "key": "term_filter", "value": "fraud,money laundering" }, { "disabled": false, "description": { "content": "If set, considers only articles from the start_date until \"today\". The format is yyyy-mm-dd (inclusive), for example 2023-10-23.", "type": "text/plain" }, "key": "start_date", "value": "2022-03-10" }, { "disabled": false, "description": { "content": "Comma-separated ISO 3166-1 alpha-2 codes of the countries the articles are published in. A code prefixed with `-` excludes that country, e.g. `de,at` or `-br`.", "type": "text/plain" }, "key": "publication_country", "value": "string" }, { "disabled": false, "description": { "content": "Pages through all matching articles. Leave the parameter out for the first page. Every response contains a `next_cursor` value, which has to be passed back as `cursor` to retrieve the next page. On the last page `next_cursor` is absent.\n\nThe `cursor` value is opaque and must neither be constructed nor parsed on your side. There is no parameter to change the page size, and `total_hits` stays constant while you page through the results.", "type": "text/plain" }, "key": "cursor", "value": "string" }, { "disabled": false, "description": { "content": "If set, considers only articles of the given category. Possible values are\n\n- political\n- regulatory\n- terrorism\n- financial_crime\n- organized_crime\n- violent_crime", "type": "text/plain" }, "key": "category", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Ongoing Monitoring", "description": "The Ongoing Monitoring API is a comprehensive solution that enables businesses to proactively monitor their customers against dilisense's sanction, PEP, and criminal watchlist databases. This API provides a convenient and efficient way to register names of individuals and entities and receive real-time notifications if there are changes to the risk profiles (e.g., a name was found, removed or any attributes associated with that name were updated).\n\n**Usage.** The registerIndividual, registerEntity and removeSearchProfile calls are free of charge and do not count towards the usage of the AML Screening API. Ongoing Monitoring is billed based on the average number of active search profiles during a month.", "item": [ { "id": "5edd4183-259c-49be-8744-c05af2d9ba07", "name": "Register an entity for monitoring", "request": { "name": "Register an entity for monitoring", "description": { "content": "The registerEntity endpoint allows clients to register an entity's name to be monitored against dilisense's database, and receive notifications if any matches are found from that point in time onwards.\n\nRegistration does not perform an initial screening, and matches that already exist at the time of registration will not trigger a webhook. Therefore, first register the search profile and screen the name with checkEntity afterwards.", "type": "text/plain" }, "url": { "path": [ "v1", "registerEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": true, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": true, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "f2de9815-4633-484c-9692-ca81bdb88ca6", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "registerEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "93778055-89f4-461d-b0ec-afc81829656d", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "registerEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ab64b281-9d55-4ba0-89cd-1b45589d1bdb", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "registerEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "bddc34c0-7f26-4089-ac85-68ccf488c354", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "registerEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "1ac152d0-5e6b-4a95-947d-8d37d49ab140", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "registerEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "38e4edb3-b9af-4f3c-915e-7b5fb9d98230", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "registerEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ff24271-6e25-4102-8509-efc0596d81cf", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "registerEntity" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "REYCO GMBH GERMANY" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. \"business\" will also match for \"busines\") for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. \"business\" will also match for \"bisines\") for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "7271" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "2b948f53-8b7b-4bc0-a5a3-0dc0385db6c6", "name": "Register an individual for monitoring", "request": { "name": "Register an individual for monitoring", "description": { "content": "The registerIndividual endpoint allows clients to register an individual's name to be monitored against dilisense's database, and receive notifications if any matches are found from that point in time onwards.\n\nRegistration does not perform an initial screening, and matches that already exist at the time of registration will not trigger a webhook. Therefore, first register the search profile and screen the name with checkIndividual afterwards.", "type": "text/plain" }, "url": { "path": [ "v1", "registerIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": true, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "65db06c5-2d46-48a0-bb87-2893b9fd3b3f", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "registerIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "76011660-57ca-4ada-9167-fa8865252892", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "registerIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "0219cd88-7a84-4310-83d9-c05a62684609", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "registerIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "cf7f8e74-a174-48cf-b49d-9ccedf64f418", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "registerIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "12696c18-1a6c-4d53-bb5c-0186b74f58e5", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "registerIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "29866692-d10c-4197-a56f-95b182928c97", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "registerIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7079b2e4-6114-4e15-a8cb-c9ddf7631e29", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "registerIndividual" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the search profile that you want to associate with this request. If a search profile with this profile_id is already registered, the existing profile is updated with the parameters of the new request.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "type": "text/plain" }, "key": "search_all", "value": "string" }, { "disabled": false, "description": { "content": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered. Cannot be combined with 'search_all' parameter.", "type": "text/plain" }, "key": "names", "value": "Boris Johnson" }, { "disabled": false, "description": { "content": "This parameter defines if spelling differences need to be considered for the search string.\n\n- 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the \"names\" parameter.\n- 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the \"names\" parameter.", "type": "text/plain" }, "key": "fuzzy_search", "value": "1" }, { "disabled": false, "description": { "content": "This parameter searches for a match in the date of birth. Possible variations are\n\n- dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).\n- 00/00/yyyy if only the year is known (e.g. 00/00/1990).\n- 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).\n- dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).\n\nIndividuals that match the given date of birth as well as individuals that have no date of birth value set are returned. For safety, records without a date of birth are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "dob", "value": "19/06/1964" }, { "disabled": false, "description": { "content": "This parameter searches for a match in gender. Possible values are\n\n- `male` - For searching for individuals that are \"male\" or that have the gender value not set.\n- `female` - For searching for individuals that are \"female\" or that have the gender value not set.\n\nIndividuals that have the given gender as well as individuals that have no gender value set are returned. For safety, records without a gender are not excluded, so that a potential match is not missed.", "type": "text/plain" }, "key": "gender", "value": "male" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "0c594f15-98d4-4641-b4eb-a8555c72dccb", "name": "Remove a search profile", "request": { "name": "Remove a search profile", "description": { "content": "The removeSearchProfile endpoint allows clients to remove a search profile that was previously registered with the Ongoing Monitoring API, based on the profile_id provided in the request parameters.\n\nThe endpoint is idempotent. Removing a profile_id that is unknown or that has already been removed also succeeds, so that a request can safely be retried if a previous response did not reach your system.", "type": "text/plain" }, "url": { "path": [ "v1", "removeSearchProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the profile to be removed.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4cbc6c73-4fb9-4cfb-acb1-5bceb8c8b019", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "removeSearchProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the profile to be removed.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "95b2b87b-5df2-42d8-91e4-603871b369ed", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "removeSearchProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the profile to be removed.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b40e23b8-353e-4b21-96a8-a241e63e991b", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "removeSearchProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the profile to be removed.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d395a595-cc7d-4343-9162-a1871bb4e648", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "removeSearchProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the profile to be removed.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "19ad35a3-39ff-4f48-9a6e-cb0473cc7efe", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "removeSearchProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the profile to be removed.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "a72e16a8-c946-454a-ac07-53a4878b1aa2", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "removeSearchProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the profile to be removed.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8c34d01a-d088-4f33-a963-89e63e02d912", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "removeSearchProfile" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The unique identifier of the profile to be removed.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } }, { "id": "95a067ca-7056-418f-9543-d9287cff99bb", "name": "Send a test webhook notification", "request": { "name": "Send a test webhook notification", "description": { "content": "Once the webhook is configured, you can trigger a test notification to your configured webhook URL at any time in order to verify your integration. A sample ADD notification with the given profile_id is sent.\n\nA separate sandbox environment is not required. If you would like us to verify the integration together with you, please send us your webhook URL and we will send a test notification from our side.", "type": "text/plain" }, "url": { "path": [ "v1", "testWebhookDelivery" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The profile_id that is set in the test notification. It does not have to be registered.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "a1511817-24c2-41cc-b41d-e8f8bb612771", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "testWebhookDelivery" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The profile_id that is set in the test notification. It does not have to be registered.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"success\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8fa476b0-e228-47da-ad79-6ddfbbc7550f", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "testWebhookDelivery" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The profile_id that is set in the test notification. It does not have to be registered.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "43be97f4-7333-4c7b-a452-2aab30879ed7", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "testWebhookDelivery" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The profile_id that is set in the test notification. It does not have to be registered.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "66c36000-078b-46d5-8a60-f45aa6cdb0a1", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "testWebhookDelivery" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The profile_id that is set in the test notification. It does not have to be registered.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "ac8a5b71-58bf-42b0-b28e-81c6ef2b3ea1", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "testWebhookDelivery" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The profile_id that is set in the test notification. It does not have to be registered.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "68f65de7-86e0-43e6-8097-29351306790a", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "testWebhookDelivery" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The profile_id that is set in the test notification. It does not have to be registered.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "754a0f03-081c-4ffa-9653-aec523dcdc74", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "testWebhookDelivery" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The profile_id that is set in the test notification. It does not have to be registered.", "type": "text/plain" }, "key": "profile_id", "value": "abcdefg-1234" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Signing Keys", "description": "A signed HTTP message from dilisense carries an `x-dilisense-signature` header next to its unchanged JSON body. The signature lets you verify that the body originates from dilisense and was not altered on its way to you, for example by a proxy, and it lets you prove later, for example in an audit, what dilisense sent. Verification is optional, clients that ignore the header keep working unchanged.\n\nThe header value consists of comma-separated parts: `v1,kid=,sig=`\n\n- `v1`: the version of the signature scheme.\n- `kid`: the ID of the key that created the signature. Use it to fetch the public key from the keys endpoint.\n- `sig`: the signature, base64url-encoded without padding (RFC 4648 section 5).\n\nSignatures are created with **ES256**, i.e. ECDSA on the NIST P-256 curve (also known as secp256r1 or prime256v1) with SHA-256 as the hash function. The signed data are the exact UTF-8 bytes of the HTTP body as transmitted.", "item": [ { "id": "6a676e2e-1dae-4eac-8b9e-8ab3a384b8c6", "name": "Get a signing key", "request": { "name": "Get a signing key", "description": { "content": "The keys API method returns the public key for a key ID as a JSON Web Key.\n\n**Key rotation.** The signing key is rotated regularly, every key is used for signing for a limited period and is then retired. Keys stay retrievable by their ID after their retirement, so that you can verify a stored body at any later point in time. Follow these rules in your implementation:\n\n- Look up the key by the `kid` of the signature header, never rely on `current` for verification. The current key can change between the moment a body is signed and the moment you fetch the key.\n- Do not hardcode a key. Fetch a key the first time you see its ID and cache it by ID. The key material of a key document never changes, only its `status` does, so refresh cached keys from time to time to notice a revocation.\n- Accept the statuses ACTIVE and RETIRED, reject REVOKED.", "type": "text/plain" }, "url": { "path": [ "v1", "keys", ":kid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "type": "any", "value": "current", "key": "kid", "disabled": false, "description": { "content": "(Required) The key ID taken from the `x-dilisense-signature` header, e.g. `6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f`. Two aliases are available in addition:\n\n- `current`: the key that is currently used for signing.\n- `previous`: the key that was replaced by the last rotation.\n\nFor verifying a signature always use the `kid` of the header. The aliases are meant for monitoring and for fetching the keys ahead of time.\n\nA `kid` that is longer than 128 characters or contains other characters than letters, digits, `.`, `_`, `:` and `-` returns a 400 HTTP error code.", "type": "text/plain" } } ] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "47bd5ae5-016f-417a-8aec-c6968ec033ce", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "keys", ":kid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The key ID taken from the `x-dilisense-signature` header, e.g. `6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f`. Two aliases are available in addition:\n\n- `current`: the key that is currently used for signing.\n- `previous`: the key that was replaced by the last rotation.\n\nFor verifying a signature always use the `kid` of the header. The aliases are meant for monitoring and for fetching the keys ahead of time.\n\nA `kid` that is longer than 128 characters or contains other characters than letters, digits, `.`, `_`, `:` and `-` returns a 400 HTTP error code.", "type": "text/plain" }, "type": "any", "value": "current", "key": "kid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"status\": \"ACTIVE\",\n \"not_before\": \"2026-09-07T03:00:12.482Z\",\n \"not_after\": \"2026-09-21T03:00:12.482Z\",\n \"keys\": [\n {\n \"kty\": \"EC\",\n \"crv\": \"P-256\",\n \"alg\": \"ES256\",\n \"kid\": \"6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f\",\n \"x\": \"bKTx6DOR16BCmP_2pCIzfjjIuegFlS6Y3wsWH12Wr8o\",\n \"y\": \"stY6VDFgVicJQnpBn763CwilIJBbDoy4sLg7Hsq1vP0\"\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "6d5f641d-ac9a-40cd-8bd8-7659384c0da3", "name": "The kid is not a valid key ID.", "originalRequest": { "url": { "path": [ "v1", "keys", ":kid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The key ID taken from the `x-dilisense-signature` header, e.g. `6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f`. Two aliases are available in addition:\n\n- `current`: the key that is currently used for signing.\n- `previous`: the key that was replaced by the last rotation.\n\nFor verifying a signature always use the `kid` of the header. The aliases are meant for monitoring and for fetching the keys ahead of time.\n\nA `kid` that is longer than 128 characters or contains other characters than letters, digits, `.`, `_`, `:` and `-` returns a 400 HTTP error code.", "type": "text/plain" }, "type": "any", "value": "current", "key": "kid" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "9a50c929-e76c-4790-b507-c1081dfa97a6", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "keys", ":kid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The key ID taken from the `x-dilisense-signature` header, e.g. `6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f`. Two aliases are available in addition:\n\n- `current`: the key that is currently used for signing.\n- `previous`: the key that was replaced by the last rotation.\n\nFor verifying a signature always use the `kid` of the header. The aliases are meant for monitoring and for fetching the keys ahead of time.\n\nA `kid` that is longer than 128 characters or contains other characters than letters, digits, `.`, `_`, `:` and `-` returns a 400 HTTP error code.", "type": "text/plain" }, "type": "any", "value": "current", "key": "kid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5e494bb0-cc16-472d-9ca0-9fe99ddcff8e", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "keys", ":kid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The key ID taken from the `x-dilisense-signature` header, e.g. `6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f`. Two aliases are available in addition:\n\n- `current`: the key that is currently used for signing.\n- `previous`: the key that was replaced by the last rotation.\n\nFor verifying a signature always use the `kid` of the header. The aliases are meant for monitoring and for fetching the keys ahead of time.\n\nA `kid` that is longer than 128 characters or contains other characters than letters, digits, `.`, `_`, `:` and `-` returns a 400 HTTP error code.", "type": "text/plain" }, "type": "any", "value": "current", "key": "kid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "98ecdbbc-0a81-42e0-b5f9-e10a7e40f4dd", "name": "No key with this kid exists.", "originalRequest": { "url": { "path": [ "v1", "keys", ":kid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The key ID taken from the `x-dilisense-signature` header, e.g. `6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f`. Two aliases are available in addition:\n\n- `current`: the key that is currently used for signing.\n- `previous`: the key that was replaced by the last rotation.\n\nFor verifying a signature always use the `kid` of the header. The aliases are meant for monitoring and for fetching the keys ahead of time.\n\nA `kid` that is longer than 128 characters or contains other characters than letters, digits, `.`, `_`, `:` and `-` returns a 400 HTTP error code.", "type": "text/plain" }, "type": "any", "value": "current", "key": "kid" } ] }, "header": [ { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Not Found", "code": 404, "header": [], "cookie": [], "_postman_previewlanguage": "text" }, { "id": "de6122b4-b25a-4a2a-8037-c5fd7b001746", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "keys", ":kid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The key ID taken from the `x-dilisense-signature` header, e.g. `6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f`. Two aliases are available in addition:\n\n- `current`: the key that is currently used for signing.\n- `previous`: the key that was replaced by the last rotation.\n\nFor verifying a signature always use the `kid` of the header. The aliases are meant for monitoring and for fetching the keys ahead of time.\n\nA `kid` that is longer than 128 characters or contains other characters than letters, digits, `.`, `_`, `:` and `-` returns a 400 HTTP error code.", "type": "text/plain" }, "type": "any", "value": "current", "key": "kid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c13abfe2-d95f-48bc-b7a1-be0d71066aaf", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "keys", ":kid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The key ID taken from the `x-dilisense-signature` header, e.g. `6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f`. Two aliases are available in addition:\n\n- `current`: the key that is currently used for signing.\n- `previous`: the key that was replaced by the last rotation.\n\nFor verifying a signature always use the `kid` of the header. The aliases are meant for monitoring and for fetching the keys ahead of time.\n\nA `kid` that is longer than 128 characters or contains other characters than letters, digits, `.`, `_`, `:` and `-` returns a 400 HTTP error code.", "type": "text/plain" }, "type": "any", "value": "current", "key": "kid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "8f349fe4-096e-4e61-81e4-7649e9a53e96", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "keys", ":kid" ], "host": [ "{{baseUrl}}" ], "query": [], "variable": [ { "disabled": false, "description": { "content": "(Required) The key ID taken from the `x-dilisense-signature` header, e.g. `6f1c2d3e-4a5b-4c6d-8e9f-0a1b2c3d4e5f`. Two aliases are available in addition:\n\n- `current`: the key that is currently used for signing.\n- `previous`: the key that was replaced by the last rotation.\n\nFor verifying a signature always use the `kid` of the header. The aliases are meant for monitoring and for fetching the keys ahead of time.\n\nA `kid` that is longer than 128 characters or contains other characters than letters, digits, `.`, `_`, `:` and `-` returns a 400 HTTP error code.", "type": "text/plain" }, "type": "any", "value": "current", "key": "kid" } ] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Sources", "description": "The source lists that are part of the dilisense database. Use them to identify the relevant lists that should be passed in the `includes` parameter of the other API method calls.", "item": [ { "id": "417cf820-b46b-45eb-a0c0-3c1acef42a7f", "name": "List the source lists", "request": { "name": "List the source lists", "description": { "content": "The getSourceList API method returns all lists that are part of the dilisense database. This call can be used to identify the relevant lists that should be passed in the `includes` parameter for the other API method calls.\n\nBy default you will get the sources that are included for your API key, which are the default sources plus the additional ones for which your key was enabled. Call the endpoint with `scope=all` to see the full catalogue and which of its sources your key includes. Please check https://dilisense.com/en/sources/additional-sources for the list of non-default sources and send us a request to get them enabled.\n\nThe response is signed, see the `x-dilisense-signature` header.", "type": "text/plain" }, "url": { "path": [ "v1", "getSourceList" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": true, "description": { "content": "Defines which sources are returned. Possible values are\n\n- `included` (default): only the sources that are included for your API key.\n- `all`: the full source catalogue, including the sources that are not included for your API key.", "type": "text/plain" }, "key": "scope", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "5d6255b8-022c-434a-88b6-5ecfb121104c", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "getSourceList" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources are returned. Possible values are\n\n- `included` (default): only the sources that are included for your API key.\n- `all`: the full source catalogue, including the sources that are not included for your API key.", "type": "text/plain" }, "key": "scope", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "[\n {\n \"source\": \"af_african_development_bank_debarred_entities\",\n \"name\": \"Debarred Entities\",\n \"description\": \"The African Development Bank Group have imposed sanctions on entities found to have participated in fraudulent practices and are therefore ineligible to participate in contracts financed or administered by the African Development Bank Group.\",\n \"link\": \"https://www.afdb.org/en/projects-operations/debarment-and-sanctions-procedures\",\n \"source_type\": \"sanction\",\n \"region\": \"international\",\n \"country_code\": \"xx\",\n \"country_name\": \"Africa\",\n \"issuer_name\": \"African Development Bank\",\n \"size\": 1013\n },\n {\n \"source\": \"na_sa_idb_sanctioned_firms_and_individuals\",\n \"name\": \"Sanctioned Firms and Individuals\",\n \"description\": \"The Inter-American Development Bank have sanctioned firms and individuals for engaging in fraudulent, corrupt, collusive, coercive or obstructive practices, in violation of the IDB Group’s Sanctions Procedures and anti-corruption policies.\",\n \"link\": \"https://www.iadb.org/en/transparency/sanctioned-firms-and-individuals\",\n \"source_type\": \"sanction\",\n \"region\": \"international\",\n \"country_code\": \"xx\",\n \"country_name\": \"America\",\n \"issuer_name\": \"Inter-American Development Bank\",\n \"size\": 1007\n },\n {\n \"source\": \"as_asia_development_bank\",\n \"name\": \"Sanction List\",\n \"description\": \"The Asian Development Bank have imposed sanctions on entities who violated the sanctions while ineligible; entities who committed second and subsequent violations; debarred entities who are uncontactable; and cross debarred entities.\",\n \"link\": \"http://lnadbg4.adb.org/oga0009p.nsf/sancALLPublic?OpenView&count=999\",\n \"source_type\": \"sanction\",\n \"region\": \"international\",\n \"country_code\": \"xx\",\n \"country_name\": \"Asia\",\n \"issuer_name\": \"Asian Development Bank\",\n \"size\": 1282\n },\n {\n \"source\": \"ar_repet_personas_y_entidades\",\n \"name\": \"Registro Público de Personas y Entidades\",\n \"description\": \"The Argentine Ministry of Justice and Human Rights publishes a list of people and organizations related to terrorist attacks and their funding, also known as Registro Público de Personas y Entidades vinculadas a actos de Terrorismo y su Financiamiento.\",\n \"link\": \"https://repet.jus.gob.ar/\",\n \"source_type\": \"sanction\",\n \"region\": \"americas\",\n \"country_code\": \"ar\",\n \"country_name\": \"Argentina\",\n \"issuer_name\": \"RePET\",\n \"size\": 578\n },\n {\n \"source\": \"au_australian_department_of_foreign_affairs_and_trade_sanction_list\",\n \"name\": \"Consolidated List\",\n \"description\": \"The Department of Foreign Affairs and Trade of Australia (DFAT) have imposed financial sanctions and travel bans on persons and entities to which the Charter of the United Nations Act 1945 and the Autonomous Sanctions Act 2011 currently applies.\",\n \"link\": \"https://www.dfat.gov.au/international-relations/security/sanctions/consolidated-list\",\n \"source_type\": \"sanction\",\n \"region\": \"apac\",\n \"country_code\": \"au\",\n \"country_name\": \"Australia\",\n \"issuer_name\": \"Department of Foreign Affairs and Trade\",\n \"size\": 3214\n }\n]", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "80667b2f-e07b-472f-a429-e9f58b91726a", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "getSourceList" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources are returned. Possible values are\n\n- `included` (default): only the sources that are included for your API key.\n- `all`: the full source catalogue, including the sources that are not included for your API key.", "type": "text/plain" }, "key": "scope", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "aea3e54c-05f2-4b34-afbd-2e6a3c5b0e70", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "getSourceList" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources are returned. Possible values are\n\n- `included` (default): only the sources that are included for your API key.\n- `all`: the full source catalogue, including the sources that are not included for your API key.", "type": "text/plain" }, "key": "scope", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "48c32cb8-f8ed-4b29-bb2d-8f5b313a4097", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "getSourceList" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources are returned. Possible values are\n\n- `included` (default): only the sources that are included for your API key.\n- `all`: the full source catalogue, including the sources that are not included for your API key.", "type": "text/plain" }, "key": "scope", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "03c4391a-3606-4650-a7cd-040182366032", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "getSourceList" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources are returned. Possible values are\n\n- `included` (default): only the sources that are included for your API key.\n- `all`: the full source catalogue, including the sources that are not included for your API key.", "type": "text/plain" }, "key": "scope", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "d4f5600c-924f-4c1d-9d00-e8368c137b91", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "getSourceList" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources are returned. Possible values are\n\n- `included` (default): only the sources that are included for your API key.\n- `all`: the full source catalogue, including the sources that are not included for your API key.", "type": "text/plain" }, "key": "scope", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "4da896b1-dddb-416c-9b76-877fe4a2cd64", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "getSourceList" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "Defines which sources are returned. Possible values are\n\n- `included` (default): only the sources that are included for your API key.\n- `all`: the full source catalogue, including the sources that are not included for your API key.", "type": "text/plain" }, "key": "scope", "value": "string" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] }, { "name": "Usage", "description": "How many API calls your API key made, broken down by endpoint and day, together with your quotas. The quotas themselves are described in [Quotas](https://developers.dilisense.com/using-the-api/quotas).", "item": [ { "id": "3c393df3-0301-48e6-947f-6a51d97c3aaf", "name": "Get the usage of your API key", "request": { "name": "Get the usage of your API key", "description": { "content": "The usage endpoint returns how many API calls your API key made in a month, broken down by endpoint and day, together with your quotas and the number of registered Ongoing Monitoring search profiles. Use it to track your consumption against your quota, to reconcile your invoice or to reconcile the search profiles tracked in your own system. The endpoint is available for every API key and covers all dilisense APIs.\n\nThe call is free of charge and does not count towards your billed requests. Calls are counted almost in real time, a call shows up in the usage after a few seconds.", "type": "text/plain" }, "url": { "path": [ "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The month for which the usage is returned, in the format yyyy-mm (e.g. 2026-08). Defaults to the current month. Months are calendar months in UTC.\n\nIf the value is not in the format yyyy-mm, the API call will return a 400 HTTP error code. Any other parameter is rejected with a 400 HTTP error code as well.", "type": "text/plain" }, "key": "month", "value": "2026-09" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" } ], "method": "GET", "body": {}, "auth": { "type": "apikey", "apikey": [ { "key": "key", "value": "x-api-key" }, { "key": "value", "value": "{{apiKey}}" }, { "key": "in", "value": "header" } ] } }, "response": [ { "id": "4ac64e79-7820-4511-ada3-8be959b473f5", "name": "OK", "originalRequest": { "url": { "path": [ "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The month for which the usage is returned, in the format yyyy-mm (e.g. 2026-08). Defaults to the current month. Months are calendar months in UTC.\n\nIf the value is not in the format yyyy-mm, the API call will return a 400 HTTP error code. Any other parameter is rejected with a 400 HTTP error code as well.", "type": "text/plain" }, "key": "month", "value": "2026-09" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "OK", "code": 200, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"month\": \"2026-09\",\n \"timezone\": \"UTC\",\n \"summary\": {\n \"billed_requests_monthly_used\": 132,\n \"billed_requests_quota\": 10000,\n \"ongoing_monitoring_profiles_registered\": 250,\n \"ongoing_monitoring_profiles_quota\": 1000\n },\n \"endpoints\": [\n {\n \"path\": \"/v1/checkIndividual\",\n \"monthly_used\": 120,\n \"daily\": [\n {\n \"date\": \"2026-09-01\",\n \"used\": 45\n },\n {\n \"date\": \"2026-09-02\",\n \"used\": 75\n }\n ]\n },\n {\n \"path\": \"/v1/media/checkEntity\",\n \"monthly_used\": 12,\n \"daily\": [\n {\n \"date\": \"2026-09-02\",\n \"used\": 12\n }\n ]\n },\n {\n \"path\": \"/v1/getSourceList\",\n \"monthly_used\": 3,\n \"daily\": [\n {\n \"date\": \"2026-09-01\",\n \"used\": 3\n }\n ]\n },\n {\n \"path\": \"/v1/usage\",\n \"monthly_used\": 2,\n \"daily\": [\n {\n \"date\": \"2026-09-02\",\n \"used\": 2\n }\n ]\n }\n ]\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "402d0250-fb0a-409a-96f3-4c243570a50d", "name": "A parameter is missing, unknown or invalid, or the operation is not enabled for your account. The error_message says which.", "originalRequest": { "url": { "path": [ "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The month for which the usage is returned, in the format yyyy-mm (e.g. 2026-08). Defaults to the current month. Months are calendar months in UTC.\n\nIf the value is not in the format yyyy-mm, the API call will return a 400 HTTP error code. Any other parameter is rejected with a 400 HTTP error code as well.", "type": "text/plain" }, "key": "month", "value": "2026-09" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Bad Request", "code": 400, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"Either the 'names' or 'search_all' parameter is mandatory.\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "7ddc688a-d905-48ee-8a48-34d273580487", "name": "The x-api-key header is missing or the API key is invalid.", "originalRequest": { "url": { "path": [ "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The month for which the usage is returned, in the format yyyy-mm (e.g. 2026-08). Defaults to the current month. Months are calendar months in UTC.\n\nIf the value is not in the format yyyy-mm, the API call will return a 400 HTTP error code. Any other parameter is rejected with a 400 HTTP error code as well.", "type": "text/plain" }, "key": "month", "value": "2026-09" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Unauthorized", "code": 401, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "5d28233e-152d-40c1-b0be-7ee4c7007d37", "name": "The API key has been revoked or the account is suspended.", "originalRequest": { "url": { "path": [ "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The month for which the usage is returned, in the format yyyy-mm (e.g. 2026-08). Defaults to the current month. Months are calendar months in UTC.\n\nIf the value is not in the format yyyy-mm, the API call will return a 400 HTTP error code. Any other parameter is rejected with a 400 HTTP error code as well.", "type": "text/plain" }, "key": "month", "value": "2026-09" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Forbidden", "code": 403, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "c415ba52-9b67-4d99-878e-f2cbc3ccd8d0", "name": "The request was throttled or the quota of your account is used up. A throttled request can be retried after the Retry-After seconds. Without a Retry-After header the quota is used up, and requests fail until it is increased or renewed.", "originalRequest": { "url": { "path": [ "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The month for which the usage is returned, in the format yyyy-mm (e.g. 2026-08). Defaults to the current month. Months are calendar months in UTC.\n\nIf the value is not in the format yyyy-mm, the API call will return a 400 HTTP error code. Any other parameter is rejected with a 400 HTTP error code as well.", "type": "text/plain" }, "key": "month", "value": "2026-09" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Too Many Requests", "code": 429, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "01cd144d-adb9-43a4-adc6-dfc51801e832", "name": "An unexpected error occurred. Retry the request, and contact support@dilisense.com if it keeps failing. The body may be empty.", "originalRequest": { "url": { "path": [ "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The month for which the usage is returned, in the format yyyy-mm (e.g. 2026-08). Defaults to the current month. Months are calendar months in UTC.\n\nIf the value is not in the format yyyy-mm, the API call will return a 400 HTTP error code. Any other parameter is rejected with a 400 HTTP error code as well.", "type": "text/plain" }, "key": "month", "value": "2026-09" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Internal Server Error", "code": 500, "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" }, { "id": "b356b73f-a8ad-49c5-aaee-c2aa1f5bd5be", "name": "The server is temporarily overloaded or not ready yet. Retry the request, after the Retry-After seconds if the header is set. The body may be empty. A 502, 503 or 504 can also come from the load balancer, with a non-JSON body.", "originalRequest": { "url": { "path": [ "v1", "usage" ], "host": [ "{{baseUrl}}" ], "query": [ { "disabled": false, "description": { "content": "The month for which the usage is returned, in the format yyyy-mm (e.g. 2026-08). Defaults to the current month. Months are calendar months in UTC.\n\nIf the value is not in the format yyyy-mm, the API call will return a 400 HTTP error code. Any other parameter is rejected with a 400 HTTP error code as well.", "type": "text/plain" }, "key": "month", "value": "2026-09" } ], "variable": [] }, "header": [ { "key": "Accept", "value": "application/json" }, { "description": { "content": "Added as a part of security scheme: apikey", "type": "text/plain" }, "key": "x-api-key", "value": "" } ], "method": "GET", "body": {} }, "status": "Service Unavailable", "code": 503, "header": [ { "key": "Content-Type", "value": "application/json" }, { "disabled": false, "description": { "content": "", "type": "text/plain" }, "key": "Retry-After", "value": "" } ], "body": "{\n \"error_message\": \"string\"\n}", "cookie": [], "_postman_previewlanguage": "json" } ], "event": [], "protocolProfileBehavior": { "disableBodyPruning": true } } ] } ], "event": [], "variable": [ { "key": "baseUrl", "value": "https://api.dilisense.com" }, { "key": "apiKey", "value": "", "type": "string" } ], "info": { "_postman_id": "eecb2dbd-f0c1-4e03-bdcf-9409ba0941e9", "name": "dilisense API", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "description": { "content": "dilisense provides REST APIs for screening individuals and entities against sanction, PEP and criminal watchlists and against adverse media. All APIs are served from `https://api.dilisense.com/v1/`, accept GET requests over HTTPS and answer in JSON, successes as well as errors.\n\nThese guides apply to all APIs:\n\n- [Authentication](https://developers.dilisense.com/using-the-api/authentication) with the x-api-key header\n- [Errors](https://developers.dilisense.com/using-the-api/errors), including throttling and retries\n- [Quotas](https://developers.dilisense.com/using-the-api/quotas), and the usage endpoint that shows where you stand\n- [Versioning](https://developers.dilisense.com/using-the-api/versioning)\n", "type": "text/plain" } } }