AML Screening API

Automate your search.

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. Our APIs are REST based and as such accept GET requests with the parameters specified in this document. The response is always in JSON format, successes as well as errors. The API calls have to be made via HTTPS requests.

1. Authentication

All API calls to dilisense require an authentication via API key. Specifically we expect the x-api-key value to be set in the header of your API call. If the API key is not valid, the API call will return a 401 HTTP error code.

We will provide you with a private API key, which you can use for integrating with our API. The private API key is only intended for your own use, as we track the number of API calls with this key. The key has to be securely stored on your side to avoid any misuse by unauthorized parties.

---

2. checkIndividual (GET)

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.

Endpoint

https://api.dilisense.com/v1/checkIndividual

Request parameters

search_all

Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.

names

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.

fuzzy_search (optional)

This parameter defines if spelling differences need to be considered for the search string.

• 1: Fuzzy search with distance 1 (e.g. Angela will also match for Angelo) for the "names" parameter.
• 2: Fuzzy search with distance 2 (e.g. Angela will also match for Angale) for the "names" parameter.

dob (optional)

This parameter searches for a match in the date of birth. Possible variations are

• dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).
• 00/00/yyyy if only the year is known (e.g. 00/00/1990).
• 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).
• dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).

gender (optional)

This parameter searches for a match in gender. Possible values are

• ‘male’ - For searching for individuals that are “male” or that have the gender value not set.
• ‘female’ - For searching for individuals that are “female” or that have the gender value not set.

includes (optional)

List of source IDs that must be considered for the search separated by comma (“,”). You can query the source IDs with the listSources API call. An example for a source ID is “us_department_of_treasury_non_sdn”.

Response

The response provided back is formatted as JSON. A maximum of 1’000 hits are returned per call.

timestamp (string)

The timestamp of the response (ISO 8601 date time).

total_hits (number)

The total number of hits for the searched parameters.

found_records (object array)

Array with attributes of type Individual

info

Attributes which are empty are not present in the response.

Attributes of type Individual

source_type (enumeration)

• SANCTION
• PEP
• CRIMINAL
• OTHER (These sources need to be requested from clients as they are not included by default. The current list is available at https://dilisense.com/en/sources/additional-sources)

One of these values will be set.

pep_type (enumeration)

• POLITICIAN
• JUDGE
• BOARD_MEMBER_OF_CENTRAL_BANK
• EXECUTIVE_AUDITOR
• ADMINISTRATION_OFFICE_EXECUTIVE
• MILITARY_OFFICIAL
• EMBASSY_OFFICIAL
• INTERNATIONAL_ORGANIZATION_OFFICIAL
• RELATIVES_AND_CLOSE_ASSOCIATES
• STATE_OWNED_ENTERPRISE
• BOARD_MEMBER_OF_STATE_OWNED_ENTERPRISE
• PROSECUTION_OFFICIAL
• AGENCY_OFFICIAL
• OTHER

One of these values will be set only for source_type PEP.

source_id (string)

The source id of the list that can be queried by the listSources API method call.

id (string)

The unique id across the whole dataset in an alphanumeric format (e.g. 9a18cb44f9ff6af5).

entity_type (enumeration)

Enumeration: INDIVIDUAL UNKNOWN

One of these values will be set.

list_date (long)

Unix timestamp in milliseconds presenting the date of the source as provided by the source authors. If not available, this value will be “0”.

gender (enumeration)

• FEMALE
• MALE
• UNKNOWN

One of these values will be set.

name (string)

The name of the individual.

tl_name (string)

A third party tool is used for the transliteration of the name from Arabic or Chinese script into Latin script. The transliterated name is not coming from the original source.

alias_names (string array)

A list with alias names of this individual.

last_names (string array)

A list with last names of this individual.

given_names (string array)

A list with given names of this individual.

alias_given_names (string array)

A list with alias given names of this individual.

name_remarks (string array)

A list of name remarks for this individual.

spouse (string array)

A list of spouse names for this individual.

parents (string array)

A list of parent names for this individual.

children (string array)

A list of children names for this individual.

siblings (string array)

A list of sibling names for this individual.

date_of_birth (string array)

A list of date of births for this individual.

date_of_birth_remarks (string array)

A list of date of birth remarks for this individual.

place_of_birth (string array)

A list of place of births for this individual.

place_of_birth_remarks (string array)

A list of place of birth remarks for this individual.

address (string array)

A list of addresses for this individual.

address_remarks (string array)

A list of address remarks for this individual.

citizenship (string array)

A list of citizenships for this individual in ISO 3166-1 alpha-2 format.

citizenship_remarks (string array)

A list of citizenship remarks for this individual.

sanction_details (string array)

A list of sanction details for this individual.

description (string array)

A list of descriptions for this individual.

occupations (string array)

A list of occupations for this individual.

positions (string array)

A list of positions for this individual.

political_parties (string array)

A list of political parties for this individual. Usually this is only filled for source_type = PEP.

links (string array)

A list of links for this individual. This can be websites but also email addresses.

titles (string array)

A list of titles for this individual (e.g. Dr., Prof., Hon. etc.).

functions (string array)

A list of functions for this individual.

other_information (string array)

A list of other information for this individual that cannot be categorized otherwise.

Example

curl

curl --location --request GET 'https://api.dilisense.com/v1/checkIndividual?names=Boris%20Johnson&fuzzy_search=1&dob=19/06/1964&gender=male&includes=dilisense_pep' \
--header 'x-api-key: <api_key>'

Python

import requests

url = "https://api.dilisense.com/v1/checkIndividual?names=Boris Johnson&fuzzy_search=1&dob=19/06/1964&gender=male&includes=dilisense_pep"

payload={}
headers = {
  'x-api-key': '<api_key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Java

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
     .uri(URI.create("https://api.dilisense.com/v1/checkIndividual?names=Boris Johnson&fuzzy_search=1&dob=19/06/1964&gender=male&includes=dilisense_pep"))
     .header("x-api-key", "<api_key>")
     .build();
client.sendAsync(request, BodyHandlers.ofString())
     .thenApply(HttpResponse::body)
     .thenAccept(System.out::println)
     .join();

Javascript

var myHeaders = new Headers();
myHeaders.append("x-api-key", "<api_key>");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://api.dilisense.com/v1/checkIndividual?names=Boris Johnson&fuzzy_search=1&dob=19/06/1964&gender=male&includes=dilisense_pep", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

{
    "timestamp": "2024-09-24T19:16:00Z",
    "total_hits": 1,
    "found_records": [
        {
	"id": "c438b18a93cd3c13",
	"entity_type": "INDIVIDUAL",
	"children": [
		"Cassia Peaches Johnson",
		"Frank Alfred Odysseus Johnson",
		"Lara Lettice Johnson",
		"Milo Arthur Johnson",
		"Romy Iris Charlotte Johnson",
		"Stephanie Macintyre Johnson",
		"Theodore Apollo Johnson",
		"Wilfred Johnson"
	],
	"name": "Boris Johnson",
	"address": [
		"GB"
	],
	"last_names": [
		"Johnson",
		"Pfeffel"
	],
	"alias_names": [
		"Alexander Boris de Pfeffel Johnson",
		"Boris",
		"BoJo",
		"Bo Jo"
	],
	"given_names": [
		"Alexander",
		"Boris"
	],
	"date_of_birth": [
		"19/06/1964"
	],
	"place_of_birth": [
		"New York City"
	],
	"citizenship": [
		"GB",
		"US"
	],
	"occupations": [
		"journalist",
		"politician"
	],	
	"positions": [
		"2001-06-07 - 2005-04-11  Member of the 53rd Parliament of the United Kingdom",
		"2005-05-05 - 2008-06-04  Member of the 54th Parliament of the United Kingdom",
		"2008-05-04 - 2016-05-07  Mayor of London",
		"2015-05-07 - 2017-05-03  Member of the 56th Parliament of the United Kingdom",
		"2016-07-13 - 2018-07-09  Secretary of State for Foreign and Commonwealth Affairs",
		"2017-06-08 - 2019-11-06  Member of the 57th Parliament of the United Kingdom",
		"Since 2016-01-01  Member of the Privy Council of the United Kingdom",
		"Since 2019-07-23  Leader of the Conservative Party",
		"Since 2019-07-24  First Lord of the Treasury",
		"Since 2019-07-24  Minister for the Civil Service",
		"Since 2019-07-24  Prime Minister of the United Kingdom",
		"Since 2019-07-26  Minister for the Union",
		"Since 2019-12-12  Member of the 58th Parliament of the United Kingdom"
	],	
	"political_parties": [
		"Conservative Party"
	],	
	"links": [
		"https://www.gov.uk/government/people/boris-johnson",
		"https://members.parliament.uk/member/1423/contact",
		"Facebook: borisjohnson",
		"https://members.parliament.uk",
		"https://www.gov.uk/government/people"
	],
	"source_id": "dilisense_pep",
	"source_type": "PEP",
	"pep_type": "POLITICIAN",
	"gender": "MALE",
	"spouse": [
		"Allegra Mostyn-Owen",
		"Carrie Johnson",
		"Marina Wheeler"
	],
	"siblings": [
		"Jo Johnson",
		"Leo Johnson",
		"Rachel Johnson"
	],
	"list_date": "0",
	"parents": [
		"Charlotte Johnson Wahl",
		"Stanley Johnson"
	],
	"description": [
		"Prime Minister of the United Kingdom from 2019 to 2022"
	]	
        }
    ]
}

The data above is test data to illustrate the payload. Any similarity to actual individuals, existing or past, is purely coincidental.

---

3. generateIndividualReport (GET)

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.

Endpoint

https://api.dilisense.com/v1/generateIndividualReport

Request parameters

names (mandatory)

Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered.

dob (optional)

This parameter searches for a match in the date of birth. Possible variations are

• dd/mm/yyyy if the exact date is known (e.g. 01/05/1990).
• 00/00/yyyy if only the year is known (e.g. 00/00/1990).
• 00/mm/yyyy if only the month and the year are known (e.g. 00/05/1990).
• dd/00/yyyy if only the day and the year are known (e.g. 01/00/1990).

gender (optional)

This parameter searches for a match in gender. Possible values are

• ‘male’ - For searching for individuals that are “male” or that have the gender value not set.
• ‘female’ - For searching for individuals that are “female” or that have the gender value not set.

includes (optional)

List of source IDs that must be considered for the search separated by comma (“,”). You can query the source IDs with the listSources API call. An example for a source ID is “us_department_of_treasury_non_sdn”.

Response

The response provided back is a Base64 encoded String that can be decoded to a pdf file.

---

4. checkEntity (GET)

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. A maximum of 1’000 hits are returned per call.

Endpoint

https://api.dilisense.com/v1/checkEntity

Request parameters

search_all

Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.

names

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.

fuzzy_search (optional)

This parameter defines if spelling differences need to be considered for the search string.

• 1: Fuzzy search with distance 1 (e.g. “business” will also match for “busines”) for the "names" parameter.
• 2: Fuzzy search with distance 2 (e.g. “business” will also match for “bisines”) for the "names" parameter.

includes (optional)

List of source IDs that must be considered for the search. You can query the source IDs with the listSources API call. An example for a source ID is us_department_of_treasury_non_sdn.

Response

The response provided back is formatted as JSON. A maximum of 1’000 hits are returned per call.

timestamp (string)

The timestamp of the response (ISO 8601 date time).

total_hits (string)

The total number of hits for the searched parameters.

found_records (object array)

Array with attributes of type Entity

info

Attributes which are empty are not present in the response.

Attributes of type Entity

source_type (enumeration)

• SANCTION
• PEP
• CRIMINAL
• OTHER (These sources need to be requested from clients as they are not included by default. The current list is available at https://dilisense.com/en/sources/additional-sources)

One of these values will be set.

pep_type (enumeration)

• STATE_OWNED_ENTERPRISE

This is only set for source_type PEP.

source_id (string)

The source id of the list that can be queried by the listSources API method call.

id (string)

The unique id across the whole dataset in an alphanumeric format (e.g. 9a18cb44f9ff6af5).

entity_type (enumeration)

• Entity
• UNKNOWN

One of these values will be set.

list_date (long)

Unix timestamp in milliseconds presenting the date of the source as provided by the source authors. If not available, this value will be “0”.

company_number (string array)

The company number of this entity (e.g. the registration number in the respective jurisdiction).

name (string)

The name if the entity.

tl_name (string)

A third party tool is used for the transliteration of the name from Arabic or Chinese script into Latin script. The transliterated name is not coming from the original source.

alias_names (string array)

A list of alias names for this entity.

name_remarks (string array)

A list of name remarks for this entity.

jurisdiction (string array)

A list of jurisdictions for this entity in ISO 3166-1 alpha-2 format.

address (string array)

A list of addresses for this entity.

address_remarks (string array)

A list of address remarks for this entity.

sanction_details (string array)

The details of why the entity is sanctioned. Only available for source_type = SANCTION.

links (string array)

A list of links for this entity. This can be websites but also email addresses.

other_information (string array)

A list of other information for this entity that cannot be categorized otherwise.

Example

curl

curl --location --request GET 'https://api.dilisense.com/v1/checkEntity?names=REYCO%20GMBH%20GERMANY' \
--header 'x-api-key: <api_key>'

Python

import requests

url = "https://api.dilisense.com/v1/checkEntity?names=REYCO GMBH GERMANY"

payload={}
headers = {
  'x-api-key': '<api_key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Java

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
     .uri(URI.create("https://api.dilisense.com/v1/checkEntity?names=REYCO GMBH GERMANY"))
     .header("x-api-key", "<api_key>")
     .build();
client.sendAsync(request, BodyHandlers.ofString())
     .thenApply(HttpResponse::body)
     .thenAccept(System.out::println)
     .join();

Javascript

var myHeaders = new Headers();
myHeaders.append("x-api-key", "<api_key>");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://api.dilisense.com/v1/checkEntity?names=REYCO GMBH GERMANY", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

{
    "timestamp": "2024-09-24T20:29:52Z",
    "total_hits": 1,
    "found_records": [
        {
	"id": "4bae94a04647a62f",
	"entity_type": "ENTITY",
	"name": "REYCO GMBH",
	"address": [
		"Germany",
		"Nordrhein-Westfalen",
		"Dinslaken",
		"Karlstrasse 19",
		"46535"
	],
	"alias_names": [
		"REYCO GMBH GERMANY"
	],
	"sanction_details": [
		"Subject to Secondary Sanctions"
	],
	"source_id": "us_department_of_treasury_sdn",
	"source_type": "SANCTION",	
	"list_date": "1615935600000"
	}
    ]
}

The data above is test data to illustrate the payload. Any similarity to actual companies, existing or past, is purely coincidental.

---

5. generateEntityReport (GET)

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.

Endpoint

https://api.dilisense.com/v1/generateEntityReport

Request parameters

names (mandatory)

Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered.

includes (optional)

List of source IDs that must be considered for the search. You can query the source IDs with the listSources API call. An example for a source ID is us_department_of_treasury_non_sdn.

Response

The response provided back is a Base64 encoded String that can be decoded to a pdf file.

---

6. listSources (GET)

The listSources 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 checkIndividual and checkEntity API method calls.

Endpoint

https://api.dilisense.com/v1/listSources

Request parameters

None

Response

The response provided back is formatted as JSON object "sources", which includes an array with the following attributes.

info

You will get the default sources and the additional ones for which your API key was enabled. Please check https://dilisense.com/en/sources/additional-sources for the full list of non-default sources and send us a request to get them enabled.

source (string)

The unique ID of the source.

name (string)

The clear text name of the source.

description (string)

The description of the source.

link (string)

The link to the source website.

country_name (string)

The country or organization which publishes the source.

last_seen (long)

The timestamp which shows when the source was downloaded the last time. This is currently only available for beta testers.

Example

curl

curl --location --request GET 'https://api.dilisense.com/v1/listSources' \
--header 'x-api-key: <api_key>'

Python

import requests

url = "https://api.dilisense.com/v1/listSources"

payload={}
headers = {
  'x-api-key': '<api_key>'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

Java

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
     .uri(URI.create("https://api.dilisense.com/v1/listSources"))
     .header("x-api-key", "<api_key>")
     .build();
client.sendAsync(request, BodyHandlers.ofString())
     .thenApply(HttpResponse::body)
     .thenAccept(System.out::println)
     .join();

Javascript

var myHeaders = new Headers();
myHeaders.append("x-api-key", "<api_key>");

var requestOptions = {
  method: 'GET',
  headers: myHeaders,
  redirect: 'follow'
};

fetch("https://api.dilisense.com/v1/listSources", requestOptions)
  .then(response => response.text())
  .then(result => console.log(result))
  .catch(error => console.log('error', error));

{
    "sources": [
        {
            "source": "af_african_development_bank_debarred_entities",
            "name": "African Development Bank - Debarred Entities",
            "description": "The African Development Bank Group or the signatories to the Agreement for Mutual Enforcement of Debarment Decisions have imposed sanctions on entities found to have participated in coercive, collusive, corrupt, fraudulent or obstructive practices. These individuals and firms are therefore considered ineligible to participate in contracts financed or administered by the African Development Bank Group for the stipulated periods.",
            "link": "https://www.afdb.org/en/projects-operations/debarment-and-sanctions-procedures",
            "country_name": "Africa",
			"last_seen": 1644917689507
        },
        {
            "source": "ar_repet_personas_y_entidades",
            "name": "RePET - Registro Público de Personas y Entidades vinculadas a actos de Terrorismo y su Financiamiento",
            "description": "The Argentine Ministry of Justice and Human Rights publishes a list of people and organizations related to terrorist attacks and their funding.",
            "link": "https://repet.jus.gob.ar/",
            "country_name": "Argentina",
			"last_seen": 1644917689507
        },
        {
            "source": "az_financial_monitoring_service_domestic_sanction_list",
            "name": "Financial Monitoring Service Domestic Sanction List",
            "description": "Domestic List of natural and legal persons subject to sanctions based on legislation of and international instruments, which the Republic of Azerbaijan is a party to, as well as relevant resolutions of the United Nations Security Council.",
            "link": "http://www.fiu.az/eng/general-list/",
            "country_name": "Azerbaijan",
			"last_seen": 1644917689507
        },
        {
            "source": "na_sa_idb_sanctioned_firms_and_individuals",
            "name": "Inter-American Development Bank - Sanctioned firms and individuals",
            "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.",
            "link": "https://www.iadb.org/en/transparency/sanctioned-firms-and-individuals",
            "country_name": "America",
			"last_seen": 1644917689507
        },
        {
            "source": "as_asia_development_bank",
            "name": "Asian Development Bank",
            "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.",
            "link": "http://lnadbg4.adb.org/oga0009p.nsf/sancALLPublic?OpenView&count=999",
            "country_name": "Asia",
			"last_seen": 1644917689507
        },
        {
            "source": "au_australian_department_of_foreign_affairs_and_trade_sanction_list",
            "name": "DFAT - Department of Foreign Affairs and Trade",
            "description": "The Department of Foreign Affairs and Trade of Australia 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.",
            "link": "https://dfat.gov.au/international-relations/security/sanctions/Pages/consolidated-list.aspx",
            "country_name": "Australia",
			"last_seen": 1644917689507
        },
        {
            "source": "bd_bfiu_domestic_sanction_list",
            "name": "BFIU - Bangladesh Financial Intelligence Unit Sanction List",
            "description": "Bangladesh Financial Intelligence Unit (BFIU) is the central agency of Bangladesh responsible for analyzing Suspicious Transaction Reports (STRs), Cash Transaction Reports (CTRs) & information related to money laundering (ML) /financing of terrorism (TF) received from reporting agencies & other sources and disseminating information/intelligence thereon to relevant law enforcement agencies.",
            "link": "https://www.bb.org.bd/bfiu/sanction_list.php",
            "country_name": "Bangladesh",
			"last_seen": 1644917689507
        }
    ]
}

---

7. Postman Collection

A Postman collection is a group of individual API calls and organized in folders. With the attached names and descriptions, such a collection helps understanding and trying out our API with a button click.

You can use it with your API key which you receive after registration (no credit card required):

https://dilisense.com/en/register

{
	"info": {
		"_postman_id": "fef4b620-3c8f-493d-9930-f45969ffe286",
		"name": "dilisense_services",
		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
	},
	"item": [
		{
			"name": "checkIndividual",
			"event": [
				{
					"listen": "test",
					"script": {
						"exec": [
							"pm.test(\"Status code is 200\", function () {",
							"    pm.response.to.have.status(200);",
							"});"
						],
						"type": "text/javascript"
					}
				}
			],
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "https://api.dilisense.com/v1/checkIndividual?names=lasha zivzivadze\n",
					"protocol": "https",
					"host": [
						"api",
						"dilisense",
						"com"
					],
					"path": [
						"v1",
						"checkIndividual"
					],
					"query": [
						{
							"key": "search_all",
							"value": "Angel Merkel"
						},
						{
							"key": "names",
							"value": "",
                            "disabled": true
						},
						{
							"key": "fuzzy_search",
							"value": "1",
							"disabled": true
						},
						{
							"key": "dob",
							"value": "19/06/1964",
							"disabled": true
						},
						{
							"key": "gender",
							"value": "male",
							"disabled": true
						},
						{
							"key": "includes",
							"value": "dilisense_pep",
							"disabled": true
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "checkEntity",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "https://api.dilisense.com/v1/checkEntity?names= ltd ",
					"protocol": "https",
					"host": [
						"api",
						"dilisense",
						"com"
					],
					"path": [
						"v1",
						"checkEntity"
					],
					"query": [
						{
							"key": "search_all",
							"value": "gmbh",
							"disabled": true
						},
						{
							"key": "names",
							"value": " ltd "
						},
						{
							"key": "fuzzy_search",
							"value": "2",
							"disabled": true
						},
						{
							"key": "includes",
							"value": "af_african_development_bank_debarred_entities",
							"disabled": true
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "generateIndividualReport",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "https://api.dilisense.com/v1/generateIndividualReport?names=Boris Johnson",
					"protocol": "https",
					"host": [
						"api",
						"dilisense",
						"com"
					],
					"path": [
						"v1",
						"generateIndividualReport"
					],
					"query": [
						{
							"key": "search_all",
							"value": "",
							"disabled": true
						},
						{
							"key": "names",
							"value": "Boris Johnson"
						},
						{
							"key": "fuzzy_search",
							"value": "1",
							"disabled": true
						},
						{
							"key": "dob",
							"value": "01/08/1975",
							"disabled": true
						},
						{
							"key": "gender",
							"value": "male",
							"disabled": true
						},
						{
							"key": "includedList",
							"value": "",
							"disabled": true
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "generateEntityReport",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "https://api.dilisense.com/v1/generateEntityReport?names=GmbH&fuzzy_search=1",
					"protocol": "https",
					"host": [
						"api",
						"dilisense",
						"com"
					],
					"path": [
						"v1",
						"generateEntityReport"
					],
					"query": [
						{
							"key": "names",
							"value": "Rayco GmbH"
						},
						{
							"key": "fuzzy_search",
							"value": "1"
						}
					]
				}
			},
			"response": []
		},
		{
			"name": "listSources",
			"request": {
				"method": "GET",
				"header": [],
				"url": {
					"raw": "https://api.dilisense.com/v1/listSources",
					"protocol": "https",
					"host": [
						"api",
						"dilisense",
						"com"
					],
					"path": [
						"v1",
						"listSources"
					]
				}
			},
			"response": []
		}
	],
	"auth": {
		"type": "apikey",
		"apikey": [
			{
				"key": "value",
				"value": "{{auth-key}}",
				"type": "string"
			},
			{
				"key": "key",
				"value": "x-api-key",
				"type": "string"
			}
		]
	},
	"event": [
		{
			"listen": "prerequest",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		},
		{
			"listen": "test",
			"script": {
				"type": "text/javascript",
				"exec": [
					""
				]
			}
		}
	]
}

---

8. OpenAPI Documentation

The OpenAPI documentation (formerly known as swagger) can be used for automated generation of API client code. Our OpenAPI documentation is available here: https://api-doc.dilisense.com/

---

9. Versioning

The API versioning will be incremental starting from v1. Only if there are breaking changes, we will increase the version to v2 and higher. We reserve the right to introduce new functionalities at any time which are not considered breaking the current API request / response logic.

Once a new API version is available, you will be notified. However you can still use the old API version for at least 12 months before we stop support for the old version.

---

10. Usage Limits

After registration on https://dilisense.com/en/register you can find your API key with 100 free API calls per month in your dashboard. If you add your credit card, this quota limit will be increased automatically to 10.000 API calls per month. You can also contact our sales team (sales@dilisense.com) to increase you quota limit in case you want to pay via bank transfer or in case you need more than 10.000 API calls per month.

---

11. Errors

The dilisense API adheres to the regular HTTP error codes. This means that codes in the 2xx range indicate a successful API call, codes in the range of 4xx indicate an error on the client side (e.g. failed authentication, missing request parameter etc.) and codes in the 5xx range inform you about an error with the dilisense servers.

The detailed error codes are:

200 - OK - The request was successful.
400 - Bad Request - The request was incorrect.
401 - Unauthorized - The API key was not valid.
403 - Forbidden - The URL is not accessible.
500 - Internal Server Error - An internal error occurred.

There is a detailed error message (JSON) available for each of the error responses, for example:

"{"error_message": "The name parameter is mandatory, but has not been set."}"