Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 15 Next »

Table of Contents


🔎 Search for a business

POST /v2/legal-entities/search endpoint will search for business profile.


1️⃣ Request data

Name

Description

Mandatory/Optional

1

name

Business name.

MANDATORY

2

datasets

Datasets to search against.

MANDATORY

3

threshold

Minimum matching score.

Results with lower score than the entered threshold will not be returned in the response.

Default value: 85.

OPTIONAL

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.

OPTIONAL

5

countryRequired

Tells if profiles with unknown country should be filtered out of the search results when countries parameter is defined.
Values (boolean): True/False
Default value: False

OPTIONAL

🗒️ Example

 Example
{
  "name": "IBM Corporation",
  "threshold": 75,
  "datasets": [
    "All",
      "GeneralPep",
      "GeneralSanctions",
      "ExternalAll",
      "ExternalPep",
      "ExternalPepLinked",
      "ExternalSanctions",
      "ExternalSanctionsCurrent",
      "ExternalSanctionsFormer",
      "ExternalAdverseMedia",
      "ExternalRegulatoryEnforcementList",
      "ExternalInsolvencyRegister",
      "ExternalStateOwnedEnterprise",
      "ExternalStateOwnedEnterpriseCurrent",
      "ExternalStateOwnedEnterpriseFormer"
  ],
  "countries": [
    "US", "DE", "GB"
  ],
  "countryRequired": false
}

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. "score": 100 means that the found business is the exact match to the provided in the search.

Possible values from 75 to 100

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

 Example
{
  "matchCount": 1,
  "matches": [
    {
      "resourceId": "2F3360D3-BE0B-4F94-BBFC-C3452015D914374075EB-5CA6-4C50-9FEC-CC93E37E33B4",
      "score": 100,
      "match": "Gazprom",
      "name": "Gazprom Mezhregiongaz Maykop OOO",
      "countries": [
        "RU"
      ],
      "dataSets": [
        "ExternalPepLinked",
        "ExternalSanctions"
      ]
    }
  ],
  "resourceId": "db56b8018a6c4d099d346418b4183dccda5ac9ad11aa4d148c432e659dfee16a"
}

🏢 Get business details by id

After accessing a business profile with the basic information you can use its resourceId to access the business’es details.

You can do this by calling business details endpoint:

GET /v2/legal-entities/{resourceId}


1️⃣ Request data

In the request provide the resourceId of the business’es profile.

🗒️ Example

 Example
{
  "resourceId": "f48f946857281571f7254d8fa51a7f9da0b75e9728c5ab16acace934c08b93d8"
}

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:

  1. Original Script Name

  2. Name Spelling Variation

  3. Name Abbreviation

  4. Previous Name

  5. Brand Name

  6. Fake Name

11

addresses

List of business addresses.

12

addresses.addressType

One of the enum values:

  1. Registered

  2. Operating

  3. Previous

  4. Branch Office

  5. Representative Office

  6. Headquarters

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:

  1. Telephone

  2. Fax

  3. Website

24

contactEntries.value

The contact itself.

25

businessTypes

Type of business.

Possible enum values:

  1. Vessel

  2. Aircraft

  3. Terrorist Organisation

  4. Organised Crime Group

  5. Militant Group

  6. Shell Corporation

  7. Sovereign Wealth Fund

  8. Government Body

  9. Political Party

  10. Civic Movement

  11. International Organisation

  12. Other International Organisations

  13. Non-Government Organisation

  14. Charitable Organisation

  15. Professional Organisation

  16. Privately-Held Company

  17. Publicly-Traded Company

  18. Trust Fund

  19. Bank

  20. Cryptocurrency Business

  21. Gaming Business

  22. Non-Bank Financial Institution

  23. Designated Professional (Gatekeeper) Organisation

  24. Website

  25. Fake Entity/Clone Company

  26. Apps/Applications

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.

Additionally these values may be returned:

ID - if evidence relates to person

CORP - if evidence relates to corporation or business

32

evidences.evidenceId

The unique id of the evidence to link with Entries lists.

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:

  1. Low

  2. Medium

  3. High

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 isCopyrighted is false.

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:

  1. Counter Narcotics

  2. Human Rights

  3. Non-Proliferation

  4. Territorial Violation

  5. Terrorism

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:

  1. Added

  2. Amended

  3. Removed

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:

  1. Financial Regulator

  2. Law Enforcement

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.

In Acuris it’s called rreEntries (Reputational Risk Exposure)

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 1 to 100.

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:

  1. National;

  2. Local.

111

stateOwnedEnterpriseEntry.status

Indicates is it current or former state owned business.

  1. Current;

  2. Former.

112

stateOwnedEnterpriseEntry.evidenceIds

The list of evidence Ids associated with the state owned business entry.

🗒️ Example

 Example
{
  "resourceId": "14cd74d2421d222cc4eba069a482f114f26246d1493eb098d22992b83f679fe4",
  "name": "Govprom Ltd",
  "description": "Fake Representative cold calling.",
  "isDeleted": false,
  "deletionReason": {
    "reason": "Duplicate profile",
    "otherReason": "Should not have been there in the first place."
  },
  "aliases": [
    {
      "alias": "Govprom",
      "type": "Original Script Name"
    }
  ],
  "addresses": [
    {
      "addressType": "Registered",
      "line1": "17 Cobble Drive",
      "line2": "Manhattan",
      "postcode": "RE11 66G",
      "city": "Katowice",
      "county": "Countyville",
      "countryIsoCode": "PL"
    }
  ],
  "profileImages": [
    "https://www.acurisriskintelligence.com/cdn/content/0024300000/0024297990.jpg",
    "https://www.acurisriskintelligence.com/cdn/content/ari0202121/GhauDR89m.png"
  ],
  "notes": [
    {
      "value": "A sample note"
    }
  ],
  "contactEntries": [
    {
      "category": "Email",
      "value": "https://www.example.com"
    }
  ],
  "businessTypes": [
    "Bank"
  ],
  "activities": [
    "Securities broker",
    "Electric car manufacturer"
  ],
  "identifiers": [
    {
      "category": "VAT/Tax Number",
      "value": 463336244428
    }
  ],
  "evidences": [
    {
      "datasets": [
        "ExternalAdverseMedia"
      ],
      "evidenceId": "22420651",
      "originalUrl": "https://www.example.com",
      "title": "Example Arrested for Money Laundering",
      "credibility": "Medium",
      "language": "eng",
      "summary": "Snippet....",
      "keywords": "Money Laundering, AML",
      "publicationDateIso": "2020-01-11",
      "assetUrl": "https://www.acurisriskintelligence.com/cdn/content/ari0202122/zA3sQ28zw.pdf"
    }
  ],
  "sanctionEntries": {
    "current": [
      {
        "sanctionId": 124122,
        "measures": [
          "Travel Ban"
        ],
        "regime": {
          "body": "United Nations Security Council (UNSC)",
          "name": "Iranian Sanctions List",
          "origin": "United Nations",
          "types": [
            "Non-Proliferation",
            "Human Rights"
          ]
        },
        "events": [
          {
            "type": "Added"
            "evidenceIds": [
              "12422"
            ]
          }
        ]
      }
    ],
    "former": [
      {
        "sanctionId": 124122,
        "measures": [
          "Travel Ban"
        ],
        "regime": {
          "body": "United Nations Security Council (UNSC)",
          "name": "Iranian Sanctions List",
          "origin": "United Nations",
          "types": [
            "Non-Proliferation",
            "Human Rights"
          ]
        },
        "events": [
          {
            "type": "Added"
            "evidenceIds": [
              "12422"
            ]
          }
        ]
      }
    ]
  },
  "regulatoryEnforcementListEntries": [
    {
      "category": "Law Enforcement",
      "subcategory": "Police - Avon and Somerset Police - Wanted & In Court - United Kingdom",
      "events": [
        {
          "type": "Arrest",
          "currencyCode": "USD",
          "amount": 1000,
          "period": {
            "days": 0,
            "years": 0,
            "months": 0
          },
          "evidenceIds": [
            "354363"
          ]
        }
      ]
    }
  ],
  "adverseMediaEntries": [
    {
      "category": "Cybercrime",
      "subcategory": "Identity Theft",
      "events": [
        {
          "type": "Court Proceedings in Progress: Remand"
          "evidenceIds": [
            "542622"
          ]
        }
      ]
    }
  ],
  "insolvencyRegisterEntries": [
    {
      "type": "Individual Voluntary Arrangement",
      "insolvencyIdNumber": "string",
      "solicitor": "HM Revenue and Customs,, Solicitor's Office & Legal Services, South West Wing, Bush House, Strand, London, WC2B 4RD",
      "court": "Voluntary Liquidation Cases",
      "petitioner": "Commissioners For Hm Revenue And Customs",
      "debt": "GBP 5,748",
      "accountantInBankruptcyCaseNumber": "2020/601289",
      "insolvencyStartDateIso": "2020-10-05",
      "insolvencyEndDateIso": "2024-10-05",
      "evidenceIds": [
        "252231"
      ]
    }
  ],
  "individualLinks": [
    {
      "firstName": "Jason",
      "middleName": "Christopher",
      "lastName": "Daniel",
      "relationship": "Boyko Metodiev is the brother of Jason Christopher Daniel.",
      "ownershipPercentage": 75,
      "resourceId": "14cd74d2421d222cc4eba069a482f114f26246d1493eb098d22992b83f679fe4",
      "datasets": [
        "OndatoPepCurrent",
        "ExternalPepFormer",
        "ExternalPepLinked",
        "ExternalRegulatoryEnforcementList",
        "ExternalAdverseMedia",
        "ExternalSanctionsCurrent",
        "ExternalSanctionsFormer"
      ]
    }
  ],
  "businessLinks": [
    {
      "name": "IM Systems Limited",
      "resourceId": "2d21438f6da5b12ad44baf1ef0ee8ae320ff53ec8e0346a3bf0e1bf96ed07ff8",
      "relationship": "Boyko Metodiev Borisov is a board member of IM Systems Limited",
      "ownershipPercentage": 75,
      "datasets": [
        "ExternalInsolvencyRegister",
        "ExternalPepLinked",
        "ExternalRegulatoryEnforcementList",
        "ExternalAdverseMedia",
        "ExternalSanctionsCurrent",
        "ExternalSanctionsFormer"
      ]
    }
  ],
  "datasets": [
    "ExternalInsolvencyRegister",
    "ExternalPepLinked",
    "ExternalRegulatoryEnforcementList",
    "ExternalAdverseMedia",
    "ExternalSanctionsCurrent",
    "ExternalSanctionsFormer"
  ],
  "stateOwnedEnterpriseEntry": {
    "level": "National",
    "status": "Current",
    "evidenceIds": [
      "526342",
      "125113"
    ]
  }
}

🥫 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:

GET /v2/legal-entities/search/{resourceId}

All the data in the request and response is the same as described in the section - 🔎 🏛️ Search for business.


  • No labels

0 Comments

You are not logged in. Any changes you make will be marked as anonymous. You may want to Log In if you already have an account.