This endpoint initiates a Know Your Customer (KYC) check for a specified entity. The KYC check reviews the individual against various databases and sources, such as sanctions and PEP (Politically Exposed Persons) lists, helping organizations assess potential risks.

​
Request Endpoint

POST: {{BASE_URL}}/api/v1/monitoring/kyc_search/

  • Media-Type: application/json

​
Status Codes

  • 200 OK: The request was successful, and the KYC check has been processed as expected.
  • 201 Created: The KYC check has been initiated successfully, and results are being generated.
  • 400 Bad Request: The request could not be completed due to invalid or missing parameters.

​
Payload

{
	"entity_name": "John Doe",
	"sources": "Sanctions, PEPs",
	"continous_monitoring": false
}

​
Request Body

FieldDescriptionType
entity_nameThe name of the entity to be checkedStringRequired
sourcesThe data sources for the KYC check, such as “Sanctions” or “PEPs” (comma-separated)FloatOptional
continuous_monitoringIndicates if continuous monitoring should be enabled (true or false). Defaults to “false” if not specifiedStringOptional

​
Response

​
Record not found

200 OK Response

{
    "status": "Success",
    "data": {
        "id": 287,
        "pep_result": null,
        "sanction_result": null,
        "search_term": "John Doe"
    },
    "message": "Record does not exist"
}

​
Response Fields

FieldDescriptionType
statusStatus of the request, indicating success or failureString
dataContains details of the initiated KYC checkObject
- idThe unique identifier for the KYC requestNumber
- entity_nameThe name of the entity for which the KYC check was requestedString
- branch_idThe identifier for the branch associated with this KYC checkNumber
- statusCurrent status of the KYC check; for example, “running.”String
messageDescriptive message about the status of the checkString

​
In progress Response

{
    "status": "Success",
    "data": {
        "id": 289,
        "pep_result": [
            {
                "entity_name": "ibrahim babangida adamu",
                "gender": "Not Available",
                "country": "Nigeria",
                "pep_types": [
                    "pep-class-1"
                ],
                "other_names": [
                    "ibrahim babangida adamu"
                ],
                "other_information": {
                    "recorded_date": "2023-11-23T15:52:24",
                    "political_post": [
                        "role.pep"
                    ]
                }
            },
            {
                "entity_name": "Ibrahim Babangida Adamu",
                "gender": "male",
                "country": "ng",
                "pep_types": [],
                "other_names": [],
                "other_information": {
                    "title": "Alhaji",
                    "target": true,
                    "address": null,
                    "last_seen": "2024-05-22T19:19:01",
                    "first_seen": "2023-11-23T15:52:24"
                }
            }
        ],
        "sanction_result": null,
        "search_term": "Babangida Adamu",
        "adverse_media_result": "Your Adverse media check for Babangida Adamu has commenced. You will be notified as soon as the results are available."
    },
    "message": "Success"
}

​
Response Fields

FieldDescriptionType
statusStatus of the request, indicating success or failureString
dataContains details of the initiated KYC checkObject
- idThe unique identifier for the KYC requestNumber
- pep_resultList of politically exposed person (PEP) records related to the search termArray
-- entity_nameThe name of the entity for which the KYC check was requestedString
-- genderGender of the identified entity (e.g., “male,” “female,” or “Not Available”)String
-- countryCountry associated with the PEP entityString
-- pep_typesCategories of PEP classification, such as “pep-class-1” or similar classificationsArray
-- other_namesAlternate names or aliases used by the entityArray
-- other_informationAdditional information about the PEP entityObject
--- recorded_dateDate when the entity was first recorded as a PEPString
--- political_postList of political roles or positions held by the PEP entityArray
--- titleTitle or honorific associated with the PEP entity (e.g., “Alhaji”)String
--- targetIndicates if the entity is flagged as a target for further investigation (true or false)Boolean
--- addressAddress information of the entity, if availableString
--- last_seenDate when the entity was last seen in the PEP databaseString
--- first_seenDate when the entity was first seen in the PEP databaseString
sanction_resultContains sanction records if any are associated with the search termObject/Null
search_termThe search term or entity name provided for the KYC checkString
adverse_media_resultStatus or message indicating the progress of adverse media checks for the search termString
messageDescriptive message about the status of the checkString