# Search

Welcome to AML Search, your trusted partner tutelar is ensuring compliance with anti-money laundering regulations. Our comprehensive services focus on improving businesses’ compliance with the clients. You can look for any individual or company-related anti-money laundering compliances here.

## AML Business Risk Assessment

* We analyze your business operations to identify and assess AML risks.
* Tailored risk assessments help you understand vulnerabilities and implement effective controls.

## AML Individual Assessment

* Regular health checks ensure ongoing compliance.
* We review your AML processes, policies, and procedures to maintain robust system.

## Search

`POST` `https://secctrl.tutelar.io/api/v1/aml/search`

| Name         | Value              |
| ------------ | ------------------ |
| Content-Type | `application/json` |

## Sample Response

### 422: Unprocessable Entity

### 500: Internal Server Error

### 401: Unauthorized

```json
{
   "success": false,
   "code": 1001,
   "message": "Please provide valid Sdn Type",
   "data": {}
}
{
   "success": false,
   "code": 1001,
   "message": "Please provide valid Search Term",
   "data": {}
}
{
   "success": false,
   "code": 1001,
   "message": "Invalid characters detected in Search Term ",
   "data": {}
}
{
   "success": false,
   "code": 1001,
   "message": "Invalid data received from Mode",
   "data": {}
}
{
   "success": false,
   "code": 1001,
   "message": "Please provide Valid includes",
   "data": {}
}
{
   "success": false,
   "code": 1001,
   "message": "Please provide any search Data",
   "data": {}
}
{
   "success": false,
   "code": 1001,
   "message": "Please provide any Name",
   "data": {}
}
```

```json
{
   "success": false,
   "code": 1001,
   "message": "Unauthorized access",
   "data": {}
}
```

## Query Parameter

| Query Parameter | Type   | Is Mandatory | Description                                                                                                                                                                                                                                                                                                                                                                                             |
| --------------- | ------ | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| sdnType         | String | Yes          | sdnType ( individual, entity, vessel, security, airplane, cryptoWallet ).                                                                                                                                                                                                                                                                                                                               |
| page            | Number | No           | List based on page number.                                                                                                                                                                                                                                                                                                                                                                              |
| limit           | Number | No           | Limit how many records display on each page.                                                                                                                                                                                                                                                                                                                                                            |
| includes        | String | No           | Includes is required if need score Results for each records. includes query params value is "scores".                                                                                                                                                                                                                                                                                                   |
| level           | String | No           | Level refers to the different types of search precision used to fetch AML (Anti-Money Laundering) data. Based on the selected search type, the system will retrieve and present AML data accordingly, ensuring that the results align with the level of specificity required for your investigation or compliance check. Accept parameter **\["exact", "near", "broad"]**.Default parameter is "broad". |

## Post parameters description is given below,

| Post Parameter | Type   | is mandatory | Description                                                                                                                                   |
| -------------- | ------ | ------------ | --------------------------------------------------------------------------------------------------------------------------------------------- |
| name           | String | No           | The Primary name of the following sdnType ( individual, entity, vessel, security, airplane and cryptoWallet )                                 |
| date           | String | No           | if sdnType is **individual**, then date field searches on birthdate.if sdnType is **entity**, then date field searches on incorporation date. |
| idNumber       | String | No           | A unique idNumber is used to search records across the following sdnType individual, entity, vessel, security, and airplane                   |
| nationality    | String | No           | The nationality field is used to search records across the following sdnType: individual, entity, vessel, security, and airplane              |
| ucic           | String | No           | A unique customer identification code is used to map multiple searches to a single UCIC.                                                      |

## Sample post data format:

```json
{
   "name": "Narendra modi",
   "date": "1950-09-17",
   "idNumber": "12345",
   "nationality": "India",
   "ucic": "3405496",
}
```

## Sample Response

```json
{
   "success": true,
   "code": 200,
   "message": "Sanctions records",
   "data": {
       "searchResults": [\
           {\
               "sanctionId": "SANCL_VY2MOXJg5o",\
               "caption": "Narendra Modi",\
               "birthDate": [\
                   "1950-09-17"\
               ],\
               "gender": [\
                   "male"\
               ],\
               "idNumber": [],\
               "phone": [],\
               "address": [],\
               "country": [\
                   "India"\
               ],\
               "nationality": [\
                   "India"\
               ],\
               "sdnType": "individual",\
               "incorporationDate": [],\
               "createdAt": "2024-07-28T19:18:07.689Z",\
               "updatedAt": "2024-07-28T19:18:07.689Z",\
               "scoreResults": {\
                   "matchScore": 100,\
                   "riskScore": 75\
               },\
               "topicTags": [\
                   "Politician"\
               ],\
               "decisionStatus": false\
           }\
       ],
       "searchDate": "2024-07-29T07:57:25.820Z",
       "searchHistoryId": "SH_lVqvzwogNo",
       "noResults": {},
       "relation": {
           "decision": {
               "meta": {
                   "actionButton": [\
                       "true_match",\
                       "false_positive",\
                       "no_match"\
                   ]
               }
           }
       }
   }
}
```

## Sample post data format (Not found record search):

```json
{
   "name": "dhoni",
   "date": "1950-09-17",
   "idNumber": "12345",
   "nationality": "India",
   "ucic": "3405496",
}
```

## Success response 2:

```json
{
   "success": true,
   "code": 200,
   "message": "Sanctions not found",
   "data": {
       "searchHistoryId": "SH_1fE4v8KnOc",
       "searchResults": [],
       "searchDate": "2024-07-29T08:01:24.438Z",
       "noResults": {
          "sdnType": "individual",
           "searchData": [\
               "dhoni"\
           ],
           "mode": "advance",
           "searchBy": "Manoj",
           "searchObject": {
               "mode": "advance",
               "sdnType": "person",
               "searchParams": {
                   "name": "dhoni",
                   "date": "1950-09-17",
                   "idNumber": "12345",
                   "nationality": "India",
                   "ucic": "3405496",
               }
           },
           "scoreResults": {
               "matchScore": 0,
               "riskScore": 0,
               "custumDatasets": {
                   "pep": {
                       "dataTagCollection": [\
                           {\
                               "value": "Argentina Members of Parliament",\
                               "key": "ar_parliament",\
                               "customTag": "ARG MP",\
                               "parentTag": "pep",\
                               "status": false\
                           },\
                           {\
                               "value": "Brazil Politically Exposed Persons",\
                               "key": "br_pep",\
                               "customTag": "BR PEP",\
                               "parentTag": "pep",\
                               "status": false\
                           },\
                           {\
                               "value": "Slovenian political officials from Zvezoskop",\
                               "key": "si_zvezoskop",\
                               "customTag": "SVN Political Officials",\
                               "parentTag": "pep",\
                               "status": false\
                           }\
                       ],
                       "matched": false
                   },
                   "sanctionedSecurities": {
                       "dataTagCollection": [\
                           {\
                               "value": "Argentina RePET Sanctions",\
                               "key": "ar_repet",\
                               "customTag": "RePET - Argentina Sanctions",\
                               "parentTag": "sanctionedSecurities",\
                               "status": false\
                           },\
                           {\
                               "value": "Australian Sanctions Consolidated List",\
                               "key": "au_dfat_sanctions",\
                               "customTag": "DFAT / Australian sanction",\
                               "parentTag": "sanctionedSecurities",\
                               "status": false\
                           }\
                           {\
                               "value": "Ukraine National Security Sanctions",\
                               "key": "ua_nsdc_sanctions",\
                               "customTag": "UA Security Sanction",\
                               "parentTag": "sanctionedSecurities",\
                               "status": false\
                           }\
                       ],
                       "matched": false
                   },
                   "warrantsAndCriminalEntities": {
                       "dataTagCollection": [\
                           {\
                               "value": "African Development Bank Debarred Entities",\
                               "key": "afdb_sanctions",\
                               "customTag": "AfDB Debarred Entities",\
                               "parentTag": "warrantsAndCriminalEntities",\
                               "status": false\
                           },\
                           {\
                               "value": "Asian Development Bank Sanctions",\
                               "key": "adb_sanctions",\
                               "customTag": "ADB's",\
                               "parentTag": "warrantsAndCriminalEntities",\
                               "status": false\
                           },\
                           {\
                               "value": "Brazil BCB Register of persons disqualified from senior roles",\
                               "key": "br_bcb_disqualified_persons",\
                               "customTag": "BR BCB Disqualified person list",\
                               "parentTag": "warrantsAndCriminalEntities",\
                               "status": false\
                           }\
                       ],
                       "matched": false
                   },
                   "sanctionCountryDataSet": {
                       "dataTagCollection": {
                           "value": "Malaysian MOHA Sanctions List",
                           "key": "my_moha_sanctions",
                           "customTag": "MOHA",
                           "parentTag": "sanctionedSecurities",
                           "status": false
                       },
                       "matched": false,
				  "country": "India"
                   }
               }
           }
       }
   }
"relation": {
           "decision": {
               "meta": {
                   "actionButton": [\
                       "track",\
                       "skip"\
                   ]
               }
           }
       }
}
```

## Failure response:

```json
{
    "success": false,
    "code": 1001,
    "message": "Please provide Valid includes",
    "data": {}
}
{
  "success": false,
  "code": 1001,
  "message": "Please provide valid Sdn Type",
  "data": {}
}
{
  "success": false,
  "code": 1001,
  "message": "Please provide valid Search Term",
  "data": {}
}
{
  "success": false,
  "code": 1001,
  "message": "Invalid characters detected in Search Term ",
  "data": {}
}
{
  "success": false,
  "code": 1001,
  "message": "Invalid data received from Mode",
  "data": {}
}
{
  "success": false,
  "code": 1001,
  "message": "Please provide Valid includes",
  "data": {}
}
{
  "success": false,
  "code": 1001,
  "message": "Please provide any search Data",
  "data": {}
}
{
  "success": false,
  "code": 1001,
  "message": "Please provide any Name",
  "data": {}
}
{
   "success": false,
   "code": 1001,
   "message": "Invalid data received from level",
   "data": {}
}
{
    "success": false,
    "code": 1001,
    "message": "Invalid characters detected in UCIC",
    "data": {}
}
```

## Response Parameter description is given below,

| Response Parameter | Type    | Description                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ------------------ | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| sanctionId         | String  | sanctionId is the unique identifier for search results.                                                                                                                                                                                                                                                                                                                                                                                            |
| sdnType            | String  | The type of AML sought in SDN type will provided, whether the search term pertains to an ( individual, entity, vessel, security, airplane, cryptoWallet )                                                                                                                                                                                                                                                                                          |
| caption            | String  | The searched result name appears as the primary name in the caption string.                                                                                                                                                                                                                                                                                                                                                                        |
| country            | Array   | It provides the response of the searched belongs to the specified country.                                                                                                                                                                                                                                                                                                                                                                         |
| nationality        | Array   | It provides the nations of the Individual who were searched; the person's precise nationality will be given based on the information on the certificate.                                                                                                                                                                                                                                                                                           |
| birthDate          | Array   | It provides the response of the searched Individuals birth date in the certificates.                                                                                                                                                                                                                                                                                                                                                               |
| gender             | Array   | It provides the response of the searched Individuals gender in the certificates                                                                                                                                                                                                                                                                                                                                                                    |
| address            | Array   | It provides the response of the searched permanent address.                                                                                                                                                                                                                                                                                                                                                                                        |
| incorporationDate  | Array   | The entity's incorporation date will be provided in the response fields , It's also known as the The date the legal entity was incorporated.                                                                                                                                                                                                                                                                                                       |
| phone              | Array   | It provides the response of the individuals official phone number or the entities number legally involved.                                                                                                                                                                                                                                                                                                                                         |
| idNumber           | Array   | It provides theID number of any applicable ID such as aadhar card , pan card and driving license.                                                                                                                                                                                                                                                                                                                                                  |
| topicTags          | Array   | In topics response the details regarding the tagged list will be provided such as sanctioned list , POI ( Proof of Identity).                                                                                                                                                                                                                                                                                                                      |
| decisionStatus     | Boolean | It provides the details regarding the true or false status of the action taken . If the action is taken the results will be shown. (for internal purpose )                                                                                                                                                                                                                                                                                         |
| scoreResults       | Object  | scoreResults object has values of matchScore and riskScore.                                                                                                                                                                                                                                                                                                                                                                                        |
| searchHistoryId    | String  | searchHistoryId field represent unique search history id for each different search with 2 hours ttl expiration.                                                                                                                                                                                                                                                                                                                                    |
| searchDate         | String  | searchDate field represent utc time of when client searches.                                                                                                                                                                                                                                                                                                                                                                                       |
| noResults          | Object  | Based on advance post search data no datafound. noResults objects with below key values.                                                                                                                                                                                                                                                                                                                                                           |
| mode               | String  | mode field represent which mode queryParams are used when search.                                                                                                                                                                                                                                                                                                                                                                                  |
| sdnType            | String  | sdnType field represent which sdnType queryParams are used when search.                                                                                                                                                                                                                                                                                                                                                                            |
| searchData         | Array   | searchData field represent which post body searchDatas are used when search.                                                                                                                                                                                                                                                                                                                                                                       |
| searchObject       | Object  | searchObject field represent which post body searchDatas are used when search. searchObject object has field mode, sdnType(Type as String) and searchParams(Type as Object).                                                                                                                                                                                                                                                                       |
| searchBy           | String  | searchBy field represent name of which client are searched.                                                                                                                                                                                                                                                                                                                                                                                        |
| scoreResults       | Object  | scoreResults field represent values of matchScore and riskScore and customDatasets.                                                                                                                                                                                                                                                                                                                                                                |
| customDatasets     | Object  | customDatasets has fields **\[pep, sanctionedSecurities, warrantsAndCriminalEntities and sanctionCountryDataSet(Type as Object)]** each object has dataTagcollection **(Type as Array of Object)** field and matched **(Type as Boolean)** field and each dataTagcollection has objects with fields **(\[value, key, customTag, parentTag, status]\(Type as String)))**. Only **sanctionCountryDataSet object has country field(Type as String).** |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.v2.tutelar.io/aml-search/search.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
