API Status

KYC - Retrieve search

Retrieve full search results

Example Response

{
  "criteria": {
    "exactMatch": false,
    "filters": {
      "amlTypes": [
        "sanction"
      ],
      "birthYear": 1800,
      "countryCodes": [],
      "entityType": "person",
      "removeDeceased": false
    },
    "fuzziness": 0.5,
    "searchTerm": "string"
  },
  "created": "2019-08-24T14:15:22Z",
  "searchHits": [
    {
      "matchTypesAll": [
        {
          "amlTypes": [
            "sanction"
          ],
          "matchingName": "string",
          "searchTermMatches": [
            {
              "matchTypes": [
                "exact_match"
              ],
              "word": "string"
            }
          ],
          "secondaryCriteriaMatches": [
            {
              "criteria": "string",
              "matchTypes": [
                "name_variations_removal"
              ]
            }
          ],
          "sources": [
            "string"
          ]
        }
      ],
      "matchTypesPrimary": [
        "name_variations_removal"
      ],
      "score": 0,
      "searchHit": {
        "aka": [
          {
            "name": "string"
          }
        ],
        "amlTypes": [
          "sanction"
        ],
        "associates": [
          {
            "association": "string",
            "name": "string"
          }
        ],
        "entityType": "person",
        "lastUpdated": "2019-08-24T14:15:22Z",
        "media": [
          {
            "date": "2019-08-24T14:15:22Z",
            "snippet": "string",
            "title": "string",
            "url": "string"
          }
        ],
        "name": "string",
        "sourceInformation": {
          "sources": [
            {
              "amlTypes": [
                "sanction"
              ],
              "key": "string",
              "listingEnded": "2019-08-24T14:15:22Z",
              "listingStarted": "2019-08-24T14:15:22Z",
              "name": "string",
              "sourceNotes": [
                {
                  "name": "string",
                  "source": "string",
                  "value": "string"
                }
              ],
              "url": "string"
            }
          ],
          "unlinkedSourceNotes": [
            {
              "name": "string",
              "source": "string",
              "value": "string"
            }
          ]
        }
      },
      "searchId": "9b1a67f9-9477-48e5-8a6c-11b70245e1d9",
      "totalHits": 0,
      "totalMatches": 0,
      "updated": "2019-08-24T14:15:22Z"
    }
  ]
}

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!