Search by Business Name

Overview

📘
The PEP and Sanctions Screening API enables your application to screen individuals and entities against comprehensive databases of politically exposed persons (PEPs) and sanctioned entities. This service helps ensure compliance with international and national regulations and mitigates risks associated with financial crimes, such as money laundering and terrorism financing.

🚧
Important!
Before you proceed, ensure you review the prerequisites for integrating to our APIs for a more detailed guide.

API Endpoint

{{Prod}}/sfx-v4-verify/v4/id-service/

Headers

Our service accepts headers for authentication. See below the headers to pass to the API

Header	Type	Description
userId	String	This is your user id retrieved from the portal. Check the getting started article to understand how to retrieve your userId
apiKey	String	This is your apikey retrieved from the portal. Check the getting started article to understand how to retrieve your apiKey

Request

Request Parameter	Status	Description	Test Data
verificationType	Required	This field is used to identify the service being called. Ensure to use the value provided exactly as provided	BASIC-COMPANY-SEARCH
countryCode	Optional	The countryCode is passed in this field	NG
Params	Required	This contains the parameters required for verification.

{
  "verificationType": "PEP-AND-SANCTION-SCREENING",
  "mode": "test",
  "countryCode": "NG",
  "params": {
    "type": "business",
    "name": "John Doe PLC",
    "country": "",
    "incorporationDate": ""
  }
}

Response

{
  "responseCode": "00",
  "description": "Successful",
  "verificationType": "PEP-AND-SANCTION-SCREENING",
  "verificationStatus": "VERIFIED",
  "transactionStatus": "SUCCESSFUL",
  "transactionReference": "1630321373727-STYI4U51-1721743615267-78789f58-c094-4f5e-8048-f006f1de33e4",
  "transactionDate": "1721743616638",
  "searchParameter": null,
  "callBackUrl": null,
  "livenessScore": null,
  "paymentRef": null,
  "response": {
    "success": true,
    "statusCode": 200,
    "message": "success",
    "data": {
      "status": "cleared",
      "parentId": null,
      "isSubjectConsent": true,
      "type": "business",
      "sanctions": [],
      "pep": [],
      "crime": [],
      "debarment": [],
      "financial_services": [],
      "government": [],
      "role": [],
      "religion": [],
      "military": [],
      "frozen_asset": [],
      "personOfInterest": [],
      "watchLists": [],
      "totalEntity": 0,
      "categoryCount": {
        "sanctions": 0,
        "pep": 0,
        "crime": 0,
        "debarment": 0,
        "financial_services": 0,
        "government": 0,
        "role": 0,
        "religion": 0,
        "military": 0,
        "frozen_asset": 0,
        "personOfInterest": 0
      },
      "queriedWith": "Identity Number",
      "query": "John Doe PLC",
      "businessId": "62c2a4868d319373a6280152",
      "requestedAt": "2024-01-24T13:25:09.093Z",
      "requestedById": "62c2a4868d3193700828014e",
      "createdAt": "2024-01-24T13:25:09.119Z",
      "lastModifiedAt": "2024-01-24T13:25:09.119Z",
      "_createdAt": "2024-01-24T13:25:099+00:00",
      "_lastModifiedAt": "2024-01-24T13:25:099+00:00",
      "id": "65b10fb4ed1bba156400f3e9",
      "requestedBy": {
        "firstName": "API",
        "lastName": "User",
        "middleName": "",
        "id": "62c2a4868d3193700828014e"
      }
    },
    "links": []
  },
  "faceMatch": null,
  "licenseSessionId": null,
  "remainingLicenseSessionRound": null
}

Updated about 21 hours ago