Skip to main content
This endpoint retrieves the results of a completed KYC check for a specific entity, providing detailed information on the entity’s risk level and any associated findings, including sanctions, social media mentions, and adverse media.

​
Request Endpoint

GET: {{BASE_URL}}/api/v1/monitoring/kyc_search/{id}/
  • Media-Type: application/json
Path Parameter:
  • id (integer): Unique identifier for the KYC request.

​
Status Codes

  • 200 OK: The request was successful, and the KYC result data is returned as expected.
  • 400 Bad Request: The request could not be completed due to invalid or missing information.
  • 404 Not Found: No KYC result found for the specified identifier.

​
Payload Example Response

{
  "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": "Adverse Media Result(s) for ABDUL MANAN MOHAMMAD ISHAK will be available shortly if any are found"
    }
  },
  "message": "Success"
}

​
Request Body

FieldDescriptionType
idUnique identifier for each KYC search resultNumber
entity_nameName of the entity that was searchedFloat
branch_idID of the branch associated with this KYC search.Number
statusStatus of the KYC search (e.g., “completed”)String
resultKYC Results for the entityObject
- risk_levelRisk level assessed for the entity (e.g., “low”, “high”)String
- total_hitsTotal flagged hits across all categoriesNumber
- pep_resultsPEP (Politically Exposed Persons) results, detailing flagged individualsArray
- search_termTerm used to conduct the searchString
- social_mediaSocial media profiles identified for the entityArray
- sanction_resultsSanction records foundArray
- total_blacklist_hitsTotal number of blacklist flags.Number
- adverse_media_resultsRelevant adverse media articles or records.String