{ "openapi": "3.0.1", "info": { "title": "dilisense", "description": "This is the documentation for the dilisense API. You can find out more about **dilisense** at [https://dilisense.com/](https://dilisense.com/).\n\nYou can request an API key to try out our methods for free. Just send us an email: `support@dilisense.com`\n\nYou can generate your API code with this [.yaml](https://api-doc.dilisense.com/openapi.yaml) file.", "termsOfService": "https://www.dilisense.com/en_US/terms", "contact": { "email": "info@dilisense.com" }, "license": { "name": "Apache 2.0", "url": "http://www.apache.org/licenses/LICENSE-2.0.html" }, "version": "1.0.1" }, "servers": [ { "url": "https://api.dilisense.com/v1" } ], "paths": { "/checkEntity": { "get": { "summary": "Search for an entity name", "tags": [ "Methods" ], "description": "Check if a search string relates to an entity (e.g. name, alias name, partial name) on a sanction, PEP and / or criminal list.", "operationId": "checkEntity", "parameters": [ { "name": "search_all", "in": "query", "description": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "required": false, "style": "form", "schema": { "type": "string" } }, { "name": "names", "in": "query", "description": "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.", "required": false, "style": "form", "schema": { "type": "string" } }, { "name": "fuzzy_search", "in": "query", "description": "This parameter defines if spelling differences need to be considered for the search string (e.g. if 'business' should be matched in case 'busines' has been provided). The example signifies a search distance of '1'. Available search distances are '1' and '2'.", "required": false, "style": "form", "schema": { "type": "integer", "enum": [ 1, 2 ] } }, { "name": "includes", "in": "query", "description": "List of sources (separated by \",\") that are relevant for the search (see getSourceList method).", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK - The request was successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckEntityResponse" } } } }, "400": { "description": "Bad Request - The request was incorrect.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized - The API key was not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden - The URL is not accessible.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error - An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/checkIndividual": { "get": { "summary": "Search for an individual name", "tags": [ "Methods" ], "description": "Check if a search string relates to an individual (e.g. last name, first name, alias last name, alias first name, partial name) on a sanction, PEP and / or criminal list.", "operationId": "checkIndividual", "parameters": [ { "name": "search_all", "in": "query", "description": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "required": false, "style": "form", "schema": { "type": "string" } }, { "name": "names", "in": "query", "description": "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.", "required": false, "style": "form", "schema": { "type": "string" } }, { "name": "fuzzy_search", "in": "query", "description": "This parameter defines if spelling differences need to be considered for the search string (e.g. if 'Angelo' should be matched in case 'Angela' has been provided). The example signifies a search distance of '1'. Available search distances are '1' and '2'.", "required": false, "style": "form", "schema": { "type": "integer", "enum": [ 1, 2 ] } }, { "name": "dob", "in": "query", "description": "This parameter searches for a match in the date of birth. Possible variations are\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).", "required": false, "style": "form", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "This parameter searches for a match in the gender.", "required": false, "style": "form", "schema": { "type": "string", "enum": [ "female", "male" ] } }, { "name": "includes", "in": "query", "description": "List of sources (separated by \",\") that are relevant for the search (see getSourceList method).", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK - The request was successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckIndividualResponse" } } } }, "400": { "description": "Bad Request - The request was incorrect.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized - The API key was not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden - The URL is not accessible.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error - An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/checkName": { "get": { "summary": "Search for a name", "tags": [ "Methods" ], "description": "Check if a search string relates to an INDIVIDUAL, ENTITY, VESSEL, AIRCRAFT, OBJECT or UNKNOWN.", "operationId": "checkName", "parameters": [ { "name": "search_all", "in": "query", "description": "Search string that is checked against sanction, PEP and criminal lists. All fields are considered. Cannot be combined with 'names' parameter.", "required": false, "style": "form", "schema": { "type": "string" } }, { "name": "names", "in": "query", "description": "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.", "required": false, "style": "form", "schema": { "type": "string" } }, { "name": "fuzzy_search", "in": "query", "description": "This parameter defines if spelling differences need to be considered for the search string (e.g. if 'Angelo' should be matched in case 'Angela' has been provided). The example signifies a search distance of '1'. Available search distances are '1' and '2'.", "required": false, "style": "form", "schema": { "type": "integer", "enum": [ 1, 2 ] } }, { "name": "dob", "in": "query", "description": "This parameter searches for a match in the date of birth. Possible variations are\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).", "required": false, "style": "form", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "This parameter searches for a match in the gender.", "required": false, "style": "form", "schema": { "type": "string", "enum": [ "female", "male" ] } }, { "name": "includes", "in": "query", "description": "List of sources (separated by \",\") that are relevant for the search (see getSourceList method).", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK - The request was successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CheckIndividualResponse" } } } }, "400": { "description": "Bad Request - The request was incorrect.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized - The API key was not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden - The URL is not accessible.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error - An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/generateEntityReport": { "get": { "summary": "Search for an entity name and generate a report", "tags": [ "Methods" ], "description": "Check if a search string relates to an entity (e.g. name, alias name, partial name) on a sanction, PEP and / or criminal list and generate a report with the results.", "operationId": "generateEntityReport", "parameters": [ { "name": "names", "in": "query", "description": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered.", "required": true, "style": "form", "schema": { "type": "string" } }, { "name": "includes", "in": "query", "description": "List of sources (separated by \",\") that are relevant for the search (see getSourceList method).", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK - The request was successful and a Base64 encoded String is provided back.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } }, "400": { "description": "Bad Request - The request was incorrect.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized - The API key was not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden - The URL is not accessible.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error - An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/generateIndividualReport": { "get": { "summary": "Search for an individual name and generate a report", "tags": [ "Methods" ], "description": "Check if a search string relates to an individual (e.g. last name, first name, alias last name, alias first name, partial name) on a sanction, PEP and / or criminal list and generate a report with the results.", "operationId": "generateIndividualReport", "parameters": [ { "name": "names", "in": "query", "description": "Search string that is checked against sanction, PEP and criminal lists. Only name fields (e.g. 'name', 'alias_names' etc.) are considered.", "required": true, "style": "form", "schema": { "type": "string" } }, { "name": "dob", "in": "query", "description": "This parameter searches for a match in the date of birth. Possible variations are\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).", "required": false, "style": "form", "schema": { "type": "string" } }, { "name": "gender", "in": "query", "description": "This parameter searches for a match in the gender.", "required": false, "style": "form", "schema": { "type": "string", "enum": [ "female", "male" ] } }, { "name": "includes", "in": "query", "description": "List of sources (separated by \",\") that are relevant for the search (see getSourceList method).", "required": false, "schema": { "type": "array", "items": { "type": "string" } } } ], "responses": { "200": { "description": "OK - The request was successful and a Base64 encoded String is provided back.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Report" } } } }, "400": { "description": "Bad Request - The request was incorrect.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized - The API key was not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden - The URL is not accessible.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error - An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } }, "/getSourceList": { "get": { "summary": "Get list of all available sources", "tags": [ "Methods" ], "description": "The source list can be retrieved in English only.", "operationId": "getSourceList", "responses": { "200": { "description": "OK - The request was successful.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetSourceListResponse" } } } }, "400": { "description": "Bad Request - The request was incorrect.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "401": { "description": "Unauthorized - The API key was not valid.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "403": { "description": "Forbidden - The URL is not accessible.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Internal Server Error - An internal error occurred.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } }, "security": [ { "ApiKeyAuth": [] } ] } } }, "components": { "schemas": { "Entity": { "type": "object", "properties": { "source_type": { "type": "string", "enum": [ "SANCTION", "PEP", "CRIMINAL", "OTHER" ] }, "pep_type": { "type": "string", "enum": [ "STATE_OWNED_ENTERPRISE" ] }, "source_id": { "type": "string" }, "entity_type": { "type": "string", "enum": [ "ENTITY", "OBJECT", "UNKNOWN" ] }, "list_date": { "type": "number", "format": "double" }, "company_number": { "type": "array", "items": { "type": "string" } }, "name": { "type": "string" }, "tl_name": { "type": "string" }, "alias_names": { "type": "array", "items": { "type": "string" } }, "name_remarks": { "type": "array", "items": { "type": "string" } }, "jurisdiction": { "type": "array", "items": { "type": "string" } }, "address": { "type": "array", "items": { "type": "string" } }, "address_remarks": { "type": "array", "items": { "type": "string" } }, "sanction_details": { "type": "array", "items": { "type": "string" } }, "links": { "type": "array", "items": { "type": "string" } }, "other_information": { "type": "array", "items": { "type": "string" } }, "source_country": { "type": "array", "items": { "type": "string" } } } }, "Individual": { "type": "object", "properties": { "source_type": { "type": "string", "enum": [ "SANCTION", "PEP", "CRIMINAL", "OTHER" ] }, "pep_type": { "type": "string", "enum": [ "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" ] }, "pep_level": { "type": "number", "format": "integer" }, "source_id": { "type": "string" }, "entity_type": { "type": "string", "enum": [ "INDIVIDUAL", "OBJECT", "UNKNOWN" ] }, "list_date": { "type": "number", "format": "long" }, "gender": { "type": "string", "enum": [ "FEMALE", "MALE", "UNKNOWN" ] }, "name": { "type": "string" }, "tl_name": { "type": "string" }, "last_names": { "type": "array", "items": { "type": "string" } }, "alias_names": { "type": "array", "items": { "type": "string" } }, "given_names": { "type": "array", "items": { "type": "string" } }, "alias_given_names": { "type": "array", "items": { "type": "string" } }, "name_remarks": { "type": "array", "items": { "type": "string" } }, "spouse": { "type": "array", "items": { "type": "string" } }, "parents": { "type": "array", "items": { "type": "string" } }, "siblings": { "type": "array", "items": { "type": "string" } }, "children": { "type": "array", "items": { "type": "string" } }, "date_of_birth": { "type": "array", "items": { "type": "string" } }, "date_of_birth_remarks": { "type": "array", "items": { "type": "string" } }, "place_of_birth": { "type": "array", "items": { "type": "string" } }, "place_of_birth_remarks": { "type": "array", "items": { "type": "string" } }, "address": { "type": "array", "items": { "type": "string" } }, "address_remarks": { "type": "array", "items": { "type": "string" } }, "citizenship": { "type": "array", "items": { "type": "string" } }, "citizenship_remarks": { "type": "array", "items": { "type": "string" } }, "sanction_details": { "type": "array", "items": { "type": "string" } }, "description": { "type": "array", "items": { "type": "string" } }, "occupations": { "type": "array", "items": { "type": "string" } }, "positions": { "type": "array", "items": { "type": "string" } }, "political_parties": { "type": "array", "items": { "type": "string" } }, "links": { "type": "array", "items": { "type": "string" } }, "titles": { "type": "array", "items": { "type": "string" } }, "functions": { "type": "array", "items": { "type": "string" } }, "other_information": { "type": "array", "items": { "type": "string" } }, "source_country": { "type": "array", "items": { "type": "string" } } } }, "CheckEntityResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "28-09-2019 09:47:03Z" }, "total_hits": { "type": "integer" }, "found_records": { "type": "array", "items": { "$ref": "#/components/schemas/Entity" } } } }, "CheckIndividualResponse": { "type": "object", "properties": { "timestamp": { "type": "string", "example": "28-09-2019 09:47:03Z" }, "total_hits": { "type": "integer" }, "found_records": { "type": "array", "items": { "$ref": "#/components/schemas/Individual" } } } }, "GetSourceListResponse": { "type": "array", "items": { "$ref": "#/components/schemas/Source" } }, "Report": { "type": "string" }, "Source": { "type": "object", "properties": { "source": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "link": { "type": "string" }, "source_type": { "type": "string" }, "region": { "type": "string" }, "country_code": { "type": "string" }, "country_name": { "type": "string" }, "issuer_name": { "type": "string" }, "last_checked": { "type": "string", "example": "28-07-2025 09:47:03Z" }, "last_modified": { "type": "string", "example": "28-07-2025 09:47:03Z" }, "size": { "type": "number", "format": "integer" } } }, "Error": { "type": "object", "properties": { "error_message": { "type": "string" } } } }, "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-Key" } } } }