Versions

This is to search the profile of the business that contains any information in the "political exposed person" database in OkayDB.

Version 2

To search for business profile

POST https://okaydbdemo.innov8tif.com/ekyc/api/aml/v2/business

This operation will search for business profiles using the parameters provided.

Request Body

Name	Type	Description
name*	string	Searched business name. Example: IBM Corporation
threshold*	integer	Minimum score to filter matched profiles. Minimum: 50 Maximum: 100 Default: 85
countries*	string	Searched country. Two-letter country code ISO-3166-2
datasets*	string	Specifies which datasets will be searched: PEP - Politically Exposed Persons PEP-LINKED - Only linked PEPs SAN - Sanctioned SAN-CURRENT - Only current Sanctions SAN-FORMER - Only former Sanctions INS - Insolvency RRE - Reputational Risk Exposure POI - Profile of Interest REL - Regulatory Enforcement List SOE - State Owned Enterprises SOE-CURRENT - Only current SOE SOE-FORMER - Only former SOE
countryRequired	boolean	Default: false

200: OK

{
    "status": "success",
    "messageCode": null,
    "message": null,
    "matchCount": 1,
    "matches": [
        {
            "qrCode": "579097",
            "version": 1624863452516,
            "resourceUri": "/businesses/87de83780bd8a599f6ed55c629374cf60616f5fe47fec8c75e9b35aec5d36676",
            "resourceId": "87de83780bd8a599f6ed55c629374cf60616f5fe47fec8c75e9b35aec5d36676",
            "name": "Tesla, Inc.",
            "description": "Electric car manufacturer",
            "deletionReason": null,
            "aliases": [
                {
                    "firstName": null,
                    "middleName": null,
                    "lastName": null,
                    "type": "Name Spelling Variation",
                    "alias": "Tesla"
                },
                {
                    "firstName": null,
                    "middleName": null,
                    "lastName": null,
                    "type": "Name Spelling Variation",
                    "alias": "Tesla Inc"
                },
                {
                    "firstName": null,
                    "middleName": null,
                    "lastName": null,
                    "type": "Name Spelling Variation",
                    "alias": "Tesla Motors"
                },
                {
                    "firstName": null,
                    "middleName": null,
                    "lastName": null,
                    "type": "Name Spelling Variation",
                    "alias": "Tesla Incorporated"
                }
            ],
            ......
}

Version 1 (Deprecated)

POST https://okaydbdemo.innov8tif.com/ekyc/api/aml/v1/business

Request Body

Name	Type	Description
BusinessName*	string	Searched business name.
apiKey*	string	To be assigned by Innov8tif.
Threshold	string	Minimum score to filter matched profiles.
PEP	string	Return PEP profiles. If not provided, then default value is "false" and matched PEP profiles will not be returned.
PreviousSanctions	string	Return previously sanctioned profiles. if not provided, then default value is "false" and matched profiles will not be returned.
CurrentSanctions	string	Return currently sanctioned profiles. If not provided, then default value is "false" and matched profiles will not be returned.
LawEnforcement	string	Return profiles from "Law Enforcement" dataset. If not provided, then default value s "false" and matched profiles will not be returned.
FinancialRegulator	string	Return profiles from "Financial regulator" dataset. If not provided, ten default value is "false" and matched profiles will not be returned.
Insolvency	string	Return profiles from "Insolvency" dataset. If not provided, then default value is "false" and matched profiles will not be returned.
DisqualifiedDirector	string	Return profiles from "Disqualified Director" dataset. If not provided, then default value is "false" and matched disqualified directors will not be returned.
AdverseMedia	string	Return profiles from "Adverse Media" dataset. If not provided, then default value is "false" and matched disqualified directors will not be returned.
Address	string	Searched address. This field should not contain city, county/state/postcode/country name.
City*	string	Searched city
County*	string	Searched county
Postcode*	string	Searched postcode
Country*	string	Searched country

200

{
  "recordsFound": 1,
  "matches": [
    {
      "score": 100,
      "business": {
        "id": 579097,
        "businessName": "Tesla, Inc.",
        "telephoneNumber": "[phone]",
        "faxNumber": "[phone]",
        "website": "https://www.tesla.com",
        "isPEP": true,
        "isSanctionsCurrent": false,
        "isSanctionsPrevious": false,
        "isLawEnforcement": true,
        "isFinancialregulator": false,
        "isDisqualifiedDirector": false,
        "isInsolvent": false,
        "isAdverseMedia": true,
        "addresses": [
          {
            "address1": "Tesla Headquarters",
            "address2": "3500 Deer Creek Road",
            "address3": "",
            "address4": "",
            "city": "Palo Alto",
            "county": "California",
            "postcode": "CA 94304",
            "country": {
              "name": "United States of America"
            }
          },
          {
            "address1": "901 Page Avenue",
            "address2": "",
            "address3": "",
            "address4": "",
            "city": "Freemont",
            "county": "California",
            "postcode": "94538",
            "country": {
              "name": "United States of America"
            }
          },
          {
            "address1": "45500 Fremont Boulevard",
            "address2": "",
            "address3": "",
            "address4": "",
            "city": "Fremont",
            "county": "California",
            "postcode": "94538",
            "country": {
              "name": "United States of America"
            }
          }
        ],
        ............
        
}

400: Bad Request

{
    // Response
}

500: Internal Server Error

{
    // Response
}