Skip to main content
GET
/
api
/
v1
/
monitoring
/
kyc_search
/
Get All KYC Search Results
curl --request GET \
  --url https://adhere-api.smartcomply.com/api/v1/monitoring/kyc_search/ \
  --header 'x-access-token: <api-key>'
import requests

url = "https://adhere-api.smartcomply.com/api/v1/monitoring/kyc_search/"

headers = {"x-access-token": "<api-key>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {'x-access-token': '<api-key>'}};

fetch('https://adhere-api.smartcomply.com/api/v1/monitoring/kyc_search/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://adhere-api.smartcomply.com/api/v1/monitoring/kyc_search/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-access-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://adhere-api.smartcomply.com/api/v1/monitoring/kyc_search/"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-access-token", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://adhere-api.smartcomply.com/api/v1/monitoring/kyc_search/")
  .header("x-access-token", "<api-key>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://adhere-api.smartcomply.com/api/v1/monitoring/kyc_search/")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-access-token"] = '<api-key>'

response = http.request(request)
puts response.read_body
{
  "status": "failed",
  "data": [
    "<unknown>"
  ],
  "message": "<string>"
}
{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}
The Get All KYC Search Results endpoint returns a list of every KYC check performed under your account. Each result includes the entity’s risk level, PEP status, sanctions matches, and adverse media findings.

​
Endpoint

GET /api/v1/monitoring/kyc_search/

​
Request

​
Headers

HeaderValueRequired
x-access-tokenYour API secret keyYes

​
Example

curl -X GET "https://adhere-api.smartcomply.com/api/v1/monitoring/kyc_search/" \
  -H "x-access-token: YOUR_SECRET_KEY"

​
Response

​
200 OK

FieldTypeDescription
data[].idnumberUnique identifier for the KYC search result
data[].entity_namestringName of the entity that was searched
data[].branch_idnumberBranch associated with this KYC search
data[].statusstringSearch status (e.g., "completed")
data[].result.risk_levelstringRisk level assessed: "low", "medium", or "high"
data[].result.total_hitsnumberTotal flagged hits across all categories
data[].result.pep_resultsarrayPolitically Exposed Person matches
data[].result.sanction_resultsarraySanctions list matches
data[].result.social_mediaarraySocial media profiles found
data[].result.adverse_media_resultsarrayAdverse media articles
data[].result.total_blacklist_hitsnumberTotal blacklist flags
{
  "status": "success",
  "data": [
    {
      "id": 17,
      "entity_name": "ABDUL MANAN MOHAMMAD ISHAK",
      "branch_id": 3,
      "status": "completed",
      "result": {
        "risk_level": "low",
        "total_hits": 1,
        "pep_results": [],
        "search_term": "ABDUL MANAN MOHAMMAD ISHAK",
        "social_media": [],
        "sanction_results": [
          {
            "name": "Abdul Manan Mohammad Ishak",
            "types": ["sanction", "warnings", "fitness-probity"],
            "source": "Smartcomply",
            "country": "Afghanistan",
            "recorded_date": "15 Aug. 2012"
          }
        ],
        "total_blacklist_hits": 0,
        "adverse_media_results": []
      }
    },
    {
      "id": 41,
      "entity_name": "Heritage Bank",
      "branch_id": 3,
      "status": "completed",
      "result": {
        "risk_level": "high",
        "total_hits": 5,
        "pep_results": [
          {
            "name": "Managing Director/CEO, Heritage Bank Plc",
            "gender": null,
            "source": "Smartcomply",
            "country": "Nigeria",
            "pep_types": ["pep"]
          }
        ],
        "search_term": "Heritage Bank",
        "social_media": [],
        "sanction_results": [],
        "total_blacklist_hits": 0,
        "adverse_media_results": [
          {
            "url": "https://thewillnews.com/breaking-cbn-revokes-operational-license-of-heritage-bank-plc/",
            "date": "June 5, 2024",
            "title": "CBN revokes operational license of Heritage Bank Plc",
            "types": ["adverse-media-v2-other-financial"],
            "snippet": "The Central Bank of Nigeria (CBN) has revoked the banking license of Heritage Bank Plc..."
          }
        ]
      }
    }
  ],
  "message": "Success"
}

​
400 Bad Request

{
  "status": "failed",
  "data": [],
  "message": "Sorry, your check cannot be processed at the moment. Please try again in a few minutes"
}

​
401 Unauthorized

{
  "status": "failed",
  "message": "Authentication credentials were not provided."
}

Authorizations

​
x-access-token
string
header
required

Your Adhere API secret key

Response

All KYC results retrieved