...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
...
Table of Contents
Table of Contents | ||||
---|---|---|---|---|
|
...
🔎
...
Search for a business
Panel | ||
---|---|---|
| ||
POST |
...
1️⃣ Request data
Results with lower score
than the entered threshold
will not be returned in the response.
Name | Description | Mandatory/Optional | |||||||
---|---|---|---|---|---|---|---|---|---|
1 | name | Business name. |
| ||||||
2 | datasets | Datasets to search against. |
| ||||||
3 | threshold | Minimum matching |
score
.
Results with lower
|
| ||||||||
4 | countries | A list of two-letter country codes ISO-3166-2. The result will be filtered based on the legal entity country. ℹ️ This parameter applies only to the results of External type datasets. |
| ||||||
5 | countryRequired | Tells if profiles with unknown country should be filtered out of the search results when |
|
🗒️ Example
Expand | |||||
---|---|---|---|---|---|
| |||||
|
...
2️⃣ Response data
In the response you can expect the following fields:
Name | Description | |
---|---|---|
1 | matchCount | Total number of found businesses. |
2 | matches | Search results. |
3 | matches.resourceId | The resource ID can be used to retrieve the detailed info or the PDF of the person. |
4 | matches.score | The match score. This means how accurate the found business match the searched business. E.g. Possible values from |
50
| ||
5 | matches.match | The business name that has been matched in the search. |
6 | matches.name | The name of the found business. |
7 | matches.countries | The list of countries from the addresses and nationalities of the profile. |
8 | matches.datasets | Active datasets where business is tagged in. Possible enum values are any of the described datasets here. |
9 | resourceId | Unique search request identifier for historical data. |
...
🗒️ Example
Expand | |||||
---|---|---|---|---|---|
| |||||
| |||||
|
...
🏛️ 📇 Get business details by id
After accessing a business profile with and retrieving the basic information, you can use utilize its resourceId
to access the business’es specific details of the business.
You can do this by calling business details endpoint:
Panel | ||
---|---|---|
| ||
GET |
...
1️⃣ Request data
In the request provide the resourceId
of the business’es profile.
🗒️ Example
Expand | |||||
---|---|---|---|---|---|
| |||||
|
...
2️⃣ Response data
Name | Description | |||
---|---|---|---|---|
1 | resourceId | The resource ID can be used to retrieve the detailed info or the PDF of the business. | ||
2 | name | Business name. | ||
3 | description | Additional information related to the nature of the business. | ||
4 | isDeleted | Boolean value which indicates if business was deleted or not. | ||
5 | deletionReason | The block with information about deletion reason. | ||
6 | deletionReason.reason | Reason why business was deleted. | ||
7 | deletionReason.otherReason | Additional info about deletion reason. | ||
8 | aliases | List of business’es aliases or Also Known As’es (AKAs). | ||
9 | aliases.alias | Alias name itself. | ||
10 | aliases.type | Type of the alias. One of the enum values:
| ||
11 | addresses | List of business addresses. | ||
12 | addresses.addressType | One of the enum values:
| ||
13 | addresses.line1 | Primary information, including the street address. | ||
14 | addresses.line2 | Detailed information of the address. May include: Apartment number, suite number, room number, floor number, box number, care-of address etc. | ||
15 | addresses.postcode | - | ||
16 | addresses.city | - | ||
17 | addresses.county | Name of the region. | ||
18 | addresses.countryIsoCode | Country ISO 3166 (alpha-2) code. | ||
19 | profileImages | List of business images URLs. | ||
20 | notes | List of notes. | ||
21 | notes.value | A particular note from the notes list. | ||
22 | contactEntries | List of business contacts. | ||
23 | contactEntries.category | Contact’s category. One of the enum values:
| ||
24 | contactEntries.value | The contact itself. | ||
25 | businessTypes | Type of business. Possible enum values:
| ||
26 | activities | The list of business activities. | ||
27 | identifiers | List of business’es identifiers. | ||
28 | identifiers.category | Identifier’s category. | ||
29 | identifiers.value | The identifier itself. | ||
30 | evidences | List of evidences of business’es entries into datasets. | ||
31 | evidences.datasets | List of evidence datasets. Active datasets where business is tagged in. Possible enum values are any of the described datasets here.
| ||
32 | evidences.evidenceId | The unique id of the evidence to link with | ||
33 | evidences.originalUrl | URL to the aticle which proves business’es political exposureness. | ||
34 | evidences.title | The title captured from the article. | ||
35 | evidences.credibility | Level of credibility of the evidence. One of the enum values:
| ||
36 | evidences.language | The ISO 639 (alpha-3) code for the language of the evidence. | ||
37 | evidences.summary | Snippet from the article. | ||
38 | evidences.keywords | Key words associated with the evidence. | ||
39 | evidences.captureDateIso | Date when evidence was captured. In ISO format: YYYY - MM - DD. | ||
40 | evidences.publicationDateIso | Date when evidence was originally published. In ISO format: YYYY - MM - DD. | ||
41 | evidences.assetUrl | The URL link to the PDF version of the evidence. This is only available if | ||
42 | sanctionEntries | List of business'es sanctions. | ||
43 | sanctionEntries.current | List of current sanctions. | ||
44 | sanctionEntries.current.sanctionId | Sanction’s unique id. | ||
45 | sanctionEntries.current.measures | The list of measures enforced by the sanctioning body. | ||
46 | sanctionEntries.current.regime | Details about sanctioning body. | ||
47 | sanctionEntries.current.regime.body | The name of the sanction issuing body. | ||
48 | sanctionEntries.current.regime.name | The name of the sanction Regime allocated by the sanctioning body. | ||
49 | sanctionEntries.current.regime.origin | Country or region issuing sanction. | ||
50 | sanctionEntries.current.regime.types | Type of the sanction by sanctioning body. One of the enum values:
| ||
51 | sanctionEntries.current.events | The list of the events related to sanctions with links to evidences. | ||
52 | sanctionEntries.current.events.type | Type of the event. One of the enum values:
| ||
53 | sanctionEntries.current.events.evidenceIds | The list of evidence Ids associated with the sanction event. | ||
54 | sanctionEntries.former | List of former sanctions. | ||
55 | sanctionEntries.former.sanctionId | Same as for sanctionEntries.current. | ||
56 | sanctionEntries.former.measures | Same as for sanctionEntries.current. | ||
57 | sanctionEntries.former.regime | Same as for sanctionEntries.current. | ||
58 | sanctionEntries.former.regime.body | Same as for sanctionEntries.current. | ||
59 | sanctionEntries.former.regime.name | Same as for sanctionEntries.current. | ||
60 | sanctionEntries.former.regime.origin | Same as for sanctionEntries.current. | ||
61 | sanctionEntries.former.regime.types | Same as for sanctionEntries.current. | ||
62 | sanctionEntries.former.events | Same as for sanctionEntries.current. | ||
63 | sanctionEntries.former.events.type | Same as for sanctionEntries.current. | ||
64 | sanctionEntries.former.events.evidenceIds | Same as for sanctionEntries.current. | ||
65 | regulatoryEnforcementListEntries |
Legal entity entries in the Regulatory Enforcement List (REL). | ||||
66 | regulatoryEnforcementListEntries.category | Category of the Regulatory Enforcement. One of the enum values:
| ||
67 | regulatoryEnforcementListEntries.subcategory | Name of the REL. | ||
68 | regulatoryEnforcementListEntries.events | The list of events related to REL with links to evidences. | ||
69 | regulatoryEnforcementListEntries.events.type | The type of the event associated with the list entry. | ||
70 | regulatoryEnforcementListEntries.events.currencyCode | For specific event types, there can be associated financial penalties. This field indicates the international currency code. | ||
71 | regulatoryEnforcementListEntries.events.amount | For specific event types, there can be associated financial penalties. This field indicates the monetary amount. | ||
72 | regulatoryEnforcementListEntries.events.period | The length of the penalty. | ||
73 | regulatoryEnforcementListEntries.events.period.days | - | ||
74 | regulatoryEnforcementListEntries.events.period.years | - | ||
75 | regulatoryEnforcementListEntries.events.period.months | - | ||
76 | regulatoryEnforcementListEntries.events.evidenceIds | The list of evidence Ids associated with the REL event. | ||
77 | adverseMediaEntries | List of business'es mentions in adverse media.
| ||
78 | adverseMediaEntries.category | Category of the adverse media. | ||
79 | adverseMediaEntries.subcategory | Subcategory of the adverse media. | ||
80 | adverseMediaEntries.events | List of the events. The list of the events related to adverse media with links to evidences. | ||
81 | adverseMediaEntries.events.type | Event type. | ||
82 | adverseMediaEntries.events.evidenceIds | The list of evidence Ids associated with the adverse media event. | ||
83 | insolvencyRegisterEntries | List of business'es entries into Insolvency Register. | ||
84 | insolvencyRegisterEntries.type | Insolvency type. | ||
85 | insolvencyRegisterEntries.insolvencyIdNumber | The unique insolvency ID number provided by the insolvency institution. | ||
86 | insolvencyRegisterEntries.solicitor | The name of the solicitor who is involved in the insolvency process. | ||
87 | insolvencyRegisterEntries.court | The name of the court before which the insolvency case is presented. | ||
88 | insolvencyRegisterEntries.petitioner | The individual/company who files the petition. | ||
89 | insolvencyRegisterEntries.debt | The amount owned by the insolvent subject. With the currency code inside string. | ||
90 | insolvencyRegisterEntries.accountantInBankruptcyCaseNumber | The unique case number provided by the Scotland's insolvency service (Accountant in Bankruptcy). | ||
91 | insolvencyRegisterEntries.insolvencyStartDateIso | The start date of the insolvency. In ISO format: YYYY - MM - DD. | ||
92 | insolvencyRegisterEntries.insolvencyEndDateIso | The end date of the insolvency. In ISO format: YYYY - MM - DD. | ||
93 | insolvencyRegisterEntries.evidenceIds | The list of evidence Ids associated with the INS entry. | ||
94 | individualLinks | List of associated persons. | ||
95 | individualLinks.firstName | - | ||
96 | individualLinks.middleName | - | ||
97 | individualLinks.lastName | - | ||
98 | individualLinks.relationship | Description of relationship with the person. | ||
99 | individualLinks.ownershipPercentage | For certain relationship type related to business ownership this value will indicate the percentage ownership when known. Values from | ||
100 | individualLinks.resourceId | The resource ID can be used to retrieve the detailed info or the PDF of the linked person. | ||
101 | individualLinks.datasets | The active datasets, where person is tagged in. Enum values are described here. | ||
102 | businessLinks | List of associated businesses. | ||
103 | businessLinks.name | The name of the linked business. | ||
104 | businessLinks.relationship | Description of relationship with the business. | ||
105 | businessLinks.ownershipPercentage | Same as for individualLinks.ownershipPercentage | ||
106 | businessLinks.resourceId | The resource ID can be used to retrieve the detailed info or the PDF of the linked business. | ||
107 | businessLinks.datasets | The active datasets, where business is tagged in. Possible enum values are any of the described datasets here. | ||
108 | datasets | The active datasets, where business is tagged in. Possible enum values are any of the described datasets here. | ||
109 | stateOwnedEnterpriseEntry | Block of information about state owned business. | ||
110 | stateOwnedEnterpriseEntry.level | Indicates is it national or local business. One of the enum values:
| ||
111 | stateOwnedEnterpriseEntry.status | Indicates is it current or former state owned business.
| ||
112 | stateOwnedEnterpriseEntry.evidenceIds | The list of evidence Ids associated with the state owned business entry. |
...
🗒️ Example
Expand | |||||
---|---|---|---|---|---|
| |||||
|
...
🥫 Retrieve the saved basic search of the business
Once the basic search for a business is performed, it can be accessed by providing its unique resourceId
in the request of the endpoint:
...
All the data in the request and response is the same as described aligns with the description provided in the section - 🔎 🏛️ Search for business.
...