# Versions

## Version 2

## To search for individual profiles

<mark style="color:green;">`POST`</mark> `https://okaydbdemo.innov8tif.com/ekyc/api/aml/v2/person`

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

#### Request Body

| Name                                        | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                          |
| ------------------------------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| name<mark style="color:red;">\*</mark>      | string  | The full name of the individual you are searching for.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| threshold<mark style="color:red;">\*</mark> | integer | Minimum score to filter matched profiles. Minimum: 50 Maximum: 100 Default: 85                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| countries<mark style="color:red;">\*</mark> | string  | Searched country. Two-letter country code ISO-3166-2                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| datasets<mark style="color:red;">\*</mark>  | string  | <p>Specifies which datasets will be searched:<br>PEP - Politically Exposed Persons</p><p>PEP-CURRENT - Only current PEPs</p><p>PEP-FORMER - Only former PEPs</p><p>PEP-LINKED - Only linked PEPs</p><p>SAN - Sanctioned</p><p>SAN-CURRENT - Only current Sanctions</p><p>SAN-FORMER - Only former Sanctions</p><p>INS - Insolvency</p><p>RRE - Reputational Risk Exposure</p><p>DD - Disqualified Director</p><p>POI - Profile of Interest</p><p>REL - Regulatory Enforcement List</p>                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| countryRequired                             | boolean | Default: false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |
| dob                                         | string  | Example: 1958-06-13                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| dobMatching                                 | string  | <p>This feature allows more fine grain controls for the date of birth matching. The match score is reduced the further the search date of birth is from the profile’s date of birth, and will be excluded completely if the date is beyond the threshold specified.</p><p></p><p>exact – The date of birth must be a perfect match to produce a hit.</p><p></p><p>sameYear – (default) The date of birth needs to be in the same calendar year of the date specified to produce a hit.</p><p></p><p>withinOneYear – The date of birth must be within 1 year of the date specified in order to produce a hit.</p><p></p><p>withinTwoYears – The date of birth must be within 2 years of the date specified in order to produce a hit.</p><p></p><p>withinThreeYears – The date of birth must be within 3 years of the date specified in order to produce a hit.</p><p></p><p>withinFourYears – The date of birth must be within 4 years of the date specified in order to produce a hit.</p><p></p><p>withinFiveYears – The date of birth must be within 5 years of the date specified in order to produce a hit.</p> |
| gender                                      | string  | This will filter the results to either return only Male or Female profiles. Omit this field to search all profiles.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| dobRequired                                 | boolean | Default: false                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                       |

{% tabs %}
{% tab title="200: OK " %}

```javascript
{
    "status": "success",
    "messageCode": null,
    "message": null,
    "matchCount": 1,
    "matches": [
        {
            "qrCode": "873938",
            "version": 1666582026614,
            "resourceUri": "/individuals/c07699f03ed723eeb12669a681ffe269216929c2623d30ca73e63170af431fd6",
            "resourceId": "c07699f03ed723eeb12669a681ffe269216929c2623d30ca73e63170af431fd6",
            "firstName": "Mohd Najib",
            "middleName": "",
            "lastName": "Abdul Razak",
            "gender": "Male",
            "aliases": [
                {
                    "firstName": "Najib",
                    "middleName": "",
                    "lastName": "Abdul Razak",
                    "type": "Name Spelling Variation",
                    "alias": null
                },
                {
                    "firstName": "Najib",
                    "middleName": "",
                    "lastName": "Razak",
                    "type": "Name Spelling Variation",
                    "alias": null
                },
                {
                    "firstName": "Mohammad",
                    "middleName": "Najib bin Abdul",
                    "lastName": "Razak",
                    "type": "Name Spelling Variation",
                    "alias": null
                },
                {
                    "firstName": "Mohammad Najib",
                    "middleName": "bin",
                    "lastName": "Abdul Razak",
                    "type": "Name Spelling Variation",
                    "alias": null
                },
                {
                    "firstName": "Mohammad",
                    "middleName": "Najib bin",
                    "lastName": "Abdul Razak",
                    "type": "Name Spelling Variation",
                    "alias": null
                },
                {
                    "firstName": "Mohd Najib",
                    "middleName": null,
                    "lastName": "Razak",
                    "type": "Name Spelling Variation",
                    "alias": null
                },
                {
                    "firstName": "Mohammad Najib",
                    "middleName": null,
                    "lastName": "Razak",
                    "type": "Name Spelling Variation",
                    "alias": null
                },
                {
                    "firstName": "Mohd Najib",
                    "middleName": "bin",
                    "lastName": "Abdul Razak",
                    "type": "Name Spelling Variation",
                    "alias": null
                },
                {
                    "firstName": "Mohd",
                    "middleName": "Najib bin",
                    "lastName": "Abdul Razak",
                    "type": "Name Spelling Variation",
                    "alias": null
                },
                {
                    "firstName": "Mohd",
                    "middleName": "Najib bin Abdul",
                    "lastName": "Razak",
                    "type": "Name Spelling Variation",
                    "alias": null
                }
            ],
            ......
}
```

{% endtab %}
{% endtabs %}

## Version 1 *<mark style="color:orange;">(Deprecated)</mark>*

<mark style="color:green;">`POST`</mark> `https://okaydbdemo.innov8tif.com/ekyc/api/aml/v1/person`

#### Request Body

| Name                                        | Type   | Description                                                                                                                                                   |
| ------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| apiKey<mark style="color:red;">\*</mark>    | string | To be assigned by Innov8tif.                                                                                                                                  |
| Threshold<mark style="color:red;">\*</mark> | 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.         |
| Forename                                    | string | Searched forename                                                                                                                                             |
| Middlename                                  | string | Searched middlename                                                                                                                                           |
| Surname                                     | string | Searched surname                                                                                                                                              |
| DateOfBirth                                 | string | Searched date of birth                                                                                                                                        |
| YearOfBirth                                 | string | Searched year of birth                                                                                                                                        |
| 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                                                                                                                                              |

{% tabs %}
{% tab title="200 " %}

```
{
  "recordsFound": 1,
  "matches": [
    {
      "score": 100,
      "person": {
        "id": 873938,
        "title": {
          "description": "None"
        },
        "alternativeTitle": null,
        "forename": "Mohd Najib",
        "middlename": null,
        "surname": "Abdul Razak",
        "dateOfBirth": "1953-07-23",
        "yearOfBirth": 1953,
        "dateOfDeath": null,
        "yearOfDeath": null,
        "isDeceased": false,
        "gender": "Male",
        "nationality": {
          "nationality": "Malaysian"
        },
        "imageURL": "https://secure.c6-intelligence.com/c6images/ari0201950/iHdkxRN4.png",
        "telephoneNumber": "+60 3-8882 3003",
        "faxNumber": "+60 3-8882 3054",
        "mobileNumber": "",
        "email": "najib@pmo.gov.my",
        "pepLevel": 1,
        "isPEP": true,
        "isSanctionsCurrent": false,
        "isSanctionsPrevious": false,
        "isLawEnforcement": true,
        "isFinancialregulator": false,
        "isDisqualifiedDirector": false,
        "isInsolvent": false,
        "isAdverseMedia": true,
        "addresses": [
          {
            "address1": "Level 12, Centre Block",
            "address2": "Ministry of Finance Complex Precinct 2 Federal Government Administrative Center",
            "address3": "",
            "address4": "",
            "city": "Putrajaya",
            "county": null,
            "postcode": "62592",
            "country": {
              "name": "Malaysia"
            }
          },
          {
            "address1": "Pejabat Perdana Menteri",
            "address2": "Blok Utama Bangunan Perdana Putra Pusat Pentadbiran Kerajaan Persekutuan",
            "address3": "",
            "address4": "",
            "city": "Putrajaya",
            "county": null,
            "postcode": "62502",
            "country": {
              "name": "Malaysia"
            }
          },
          {
            "address1": "No. 11 Langgak Duta Street, Taman Duta",
            "address2": "",
            "address3": "",
            "address4": "",
            "city": "",
            "county": "Kuala Lumpur",
            "postcode": "50480",
            "country": {
              "name": "Malaysia"
            }
          }
        ],
        "aliases": [
          {
            "title": null,
            "alternativeTitle": "Dato",
            "forename": "Najib",
            "middlename": "Tun",
            "surname": "Razak"
          },
          {
            "title": null,
            "alternativeTitle": "Dato",
            "forename": "Mohamed",
            "middlename": "Najib bin Abdul",
            "surname": "Razak"
          },
          {
            "title": null,
            "alternativeTitle": "Dato",
            "forename": "Najib",
            "middlename": "",
            "surname": "Razak"
          },
          {
            "title": null,
            "alternativeTitle": null,
            "forename": "Mohamed",
            "middlename": "bin Abdul Razak",
            "surname": "Najib"
          },
          {
            "title": null,
            "alternativeTitle": null,
            "forename": "Mohd",
            "middlename": "",
            "surname": "Razak"
          },
          {
            "title": null,
            "alternativeTitle": null,
            "forename": "Najib Tun",
            "middlename": "",
            "surname": "Abdul Razak"
          },
          {
            "title": null,
            "alternativeTitle": "Y.B. Dato' Sri",
            "forename": "Mohd Najib",
            "middlename": "",
            "surname": "Razak"
          },
          {
            "title": null,
            "alternativeTitle": "Y.B. Dato' Sri",
            "forename": "Mohamad Najib",
            "middlename": "",
            "surname": "Razak"
          },
          {
            "title": null,
            "alternativeTitle": null,
            "forename": "Mohd",
            "middlename": "Najib",
            "surname": "Abdul Razak"
          },
          {
            "title": null,
            "alternativeTitle": null,
            "forename": "Najib",
            "middlename": "",
            "surname": "Abdul Razak"
          },
          {
            "title": null,
            "alternativeTitle": null,
            "forename": "Mohd",
            "middlename": "Najib Bin Tun Haji Abdul",
            "surname": "Razak"
          },
          {
            "title": null,
            "alternativeTitle": null,
            "forename": "Datuk",
            "middlename": "Seri Najib",
            "surname": "Tun Razak"
          }
        ],
        ........
        
  }
```

{% endtab %}
{% endtabs %}
