Skip to main content

All Requests

With a single endpoint, you can get results for both PEP, sanction list and adverse media checks. This eliminates the need to call all endpoints individually and you get all results in one webhook response.

The webhook for this request will be sent to the callback url you provide in your request instead of the webhook url you setup on the Sigma Dashboard. This is to ensure all results are sent to one url.

Request

Method: POST
Endpoint: api/v1/aml/risk-monitoring
Headers :

{
 	"apiKey" : [YOUR APP API_KEY],
	"apiSecret" : [YOUR APP API_SECRET],
	"Content-Type": "application/json"
}

Body :


    {
    "name": "Yahaya Bello",
    "threshold": 80,
    "limit": 20,
    "callbackUrl": "https://webhook.site/0f64b697-5b21-4365-8e86-91db609ea9e5"
  }
  

Response :


  {
    "message": "Request created successfully. Result will be sent to your webhook",
    "data": {
        "checkId": "070706fc-aa4e-468d-87f9-cb3a89408c15"
    }
  }
  

Webhook

  • The result for the check will be sent to your webhook, here is an example response
{
  "checkId": "43000234-8528-4243-9aaa-b9cd7b2ffa59",
  "adverseMedia": {
    "info": {
      "id": "673cb157d725d120abd2f46b",
      "query": "Yahaya Bello",
      "count": 7,
      "limit": 20
    },
    "result": [
      {
        "title": "HEDA Condemns Evasion of Arrest by Former Governor Yahaya ...",
        "link": "https://hedang.org/heda-condemns-evasion-of-arrest-by-former-governor-yahaya-bello-and-conspiracy-of-gov-odidi-amid-money-laundering-allegations/",
        "keyword": {
          "confidenceScore": 1
        },
        "adverseInformation": [
          {
            "keyword": "money laundering",
            "score": 1
          }
        ]
      },
      {
        "title": "Alleged money laundering: CPPM flays evasion of arrest by Yahaya ...",
        "link": "https://tribuneonlineng.com/alleged-money-laundering-cppm-flays-evasion-of-arrest-by-yahaya-bello/",
        "keyword": {
          "confidenceScore": 0.9
        },
        "adverseInformation": [
          {
            "keyword": "money laundering",
            "score": 1
          }
        ]
      },
      {
        "title": "EFCC: Yahaya Bello's September 18 Appearance Was Media Stunt ...",
        "link": "https://www.arise.tv/efcc-yahaya-bellos-september-18-appearance-was-media-stunt-not-submission-to-justice/",
        "keyword": {
          "confidenceScore": 1
        },
        "adverseInformation": [
          {
            "keyword": "corruption",
            "score": 1
          },
          {
            "keyword": "money laundering",
            "score": 0.9
          }
        ]
      },
      {
        "title": "Keyamo: Private Jet Operations Used for Drug Trafficking, Money ...",
        "link": "https://www.arise.tv/keyamo-private-jet-operations-used-for-drug-trafficking-money-laundering/",
        "keyword": {
          "confidenceScore": 0.9
        },
        "adverseInformation": [
          {
            "keyword": "money laundering",
            "score": 0.9
          }
        ]
      },
      {
        "title": "UPDATED: EFCC files fresh N110 billion corruption charges against ...",
        "link": "https://www.premiumtimesng.com/news/top-news/738849-updated-efcc-files-fresh-n110-billion-corruption-charges-against-former-kogi-governor-bello.html",
        "keyword": {
          "confidenceScore": 1
        },
        "adverseInformation": [
          {
            "keyword": "corruption",
            "score": 1
          },
          {
            "keyword": "money laundering",
            "score": 1
          }
        ]
      },
      {
        "title": "What is money laundering? - Nairametrics",
        "link": "https://nairametrics.com/2017/07/26/what-is-money-laundering/",
        "keyword": {
          "confidenceScore": 1
        },
        "adverseInformation": [
          {
            "keyword": "money laundering",
            "score": 1
          }
        ]
      },
      {
        "title": "'N80.2bn fraud': Yahaya Bello's lawyer applies to withdraw from ...",
        "link": "https://www.thecable.ng/n80-2bn-fraud-yahaya-bellos-lawyer-applies-to-withdraw-from-case/",
        "keyword": {
          "confidenceScore": 1
        },
        "adverseInformation": [
          {
            "keyword": "money laundering",
            "score": 1
          },
          {
            "keyword": "corruption",
            "score": 1
          }
        ]
      }
    ]
  },
  "pep": {
    "check_id": "43000234-8528-4243-9aaa-b9cd7b2ffa59",
    "check_creation_date": "2024-11-19T15:40:07.913Z",
    "last_screened_date": "2024-11-19T15:40:07.913Z",
    "created_by": "64a6d6446b67960f0543b301",
    "results": [
      {
        "tags": [],
        "updateComplete": false,
        "deceased": false,
        "_id": "662f9416d2b06e101bf11c67",
        "externalId": "ng-chip-pep-ng-0004064",
        "type": "pep",
        "__v": 0,
        "addresses": [
          "House of Assembly Complex, Sokoto"
        ],
        "aliases": [],
        "birth_date": "",
        "countries": [
          "ng"
        ],
        "createdAt": "2024-04-29T12:35:23.070Z",
        "entityType": "Person",
        "name": "Yahaya Bello Wurno",
        "sanctions": [],
        "updatedAt": "2024-08-27T16:37:28.444Z",
        "politicalParty": [],
        "positions": [
          {
            "startDate": "",
            "endDate": "",
            "_id": "66b3614f6b7cbfc8c603c95a"
          }
        ],
        "education": [],
        "confidenceScore": 100
      },
      {
        "tags": [],
        "updateComplete": false,
        "deceased": false,
        "_id": "662f941dd2b06e101bf1ec93",
        "type": "pep",
        "externalId": "ng-chip-pep-ng-0016055",
        "__v": 0,
        "addresses": [],
        "aliases": [],
        "birth_date": "",
        "countries": [
          "ng"
        ],
        "createdAt": "2024-04-29T12:35:23.094Z",
        "entityType": "Person",
        "name": "Yahaya Bello",
        "sanctions": [],
        "updatedAt": "2024-08-27T16:37:28.444Z",
        "politicalParty": [],
        "positions": [
          {
            "startDate": "",
            "endDate": "",
            "_id": "66b361506b7cbfc8c603f597"
          }
        ],
        "education": [],
        "confidenceScore": 100
      },
      {
        "tags": [],
        "deceased": false,
        "_id": "662f92f5d2b06e101bdc7724",
        "externalId": "Q22295109",
        "type": "pep",
        "__v": 1,
        "addresses": [],
        "aliases": [],
        "birth_date": "1975-06-18",
        "countries": [
          "ng"
        ],
        "createdAt": "2024-04-29T12:30:41.852Z",
        "entityType": "Person",
        "name": "Yahaya Adoza Bello",
        "sanctions": [],
        "updatedAt": "2024-10-11T21:00:14.869Z",
        "gender": "male",
        "politicalParty": [
          "All Progressives Congress"
        ],
        "positions": [
          {
            "title": "Governor of Kogi State",
            "startDate": "2019",
            "endDate": "2023",
            "_id": "670991c3b3165e8cfa279de2"
          },
          {
            "title": "Governor of Kogi State",
            "startDate": "2016",
            "endDate": "2019",
            "_id": "670991c3b3165e8cfa279de3"
          },
          {
            "title": "Assistant Chief Accountant Revenue Mobilization Allocation and Fiscal Commission",
            "startDate": null,
            "endDate": null,
            "_id": "670991c3b3165e8cfa279de4"
          },
          {
            "title": "head of the Account department Makurdi Zonal Office",
            "startDate": null,
            "endDate": null,
            "_id": "670991c3b3165e8cfa279de5"
          },
          {
            "title": "Senior Accountant Revenue Mobilization Allocation and Fiscal Commission",
            "startDate": null,
            "endDate": null,
            "_id": "670991c3b3165e8cfa279de6"
          },
          {
            "title": "Revenue Officer II Revenue Mobilization Allocation and Fiscal Commission",
            "startDate": null,
            "endDate": null,
            "_id": "670991c3b3165e8cfa279de7"
          }
        ],
        "education": [
          {
            "title": "Government Secondary School Suleja in Niger State",
            "startDate": "",
            "endDate": "1994",
            "_id": "670991c3b3165e8cfa279de8"
          },
          {
            "title": "Nigerian Institute of Management",
            "startDate": "",
            "endDate": "2003",
            "_id": "670991c3b3165e8cfa279de9"
          },
          {
            "title": "University of Abuja",
            "startDate": "",
            "endDate": "2004",
            "_id": "670991c3b3165e8cfa279dea"
          }
        ],
        "confidenceScore": 100
      }
    ],
    "recommendation": {
      "riskLevel": "LOW"
    }
   }
   }
  
ParameterTypeDescription
checkIdStringUnique ID of the screening check
adverseMediaObjectContains information related to adverse media findings
adverseMedia.infoObjectMeta information regarding the adverse media check (count, query, etc.)
adverseMedia.info.idStringID of the adverse media query
adverseMedia.info.queryStringQuery used to search for adverse media
adverseMedia.info.countNumberThe number of results found for the adverse media search
adverseMedia.info.limitNumberLimit for the number of results returned
adverseMedia.resultArrayList of results from the adverse media search
adverseMedia.result.titleStringTitle of the article or news related to adverse media
adverseMedia.result.linkStringURL link to the article or news
adverseMedia.result.keywordObjectContains keywords related to the adverse media
adverseMedia.result.keyword.confidenceScoreNumberConfidence score for the relevance of the keyword in the media
adverseMedia.result.adverseInformationArrayList of adverse information related to the media
adverseMedia.result.adverseInformation.keywordStringKeyword related to the adverse information
adverseMedia.result.adverseInformation.scoreNumberScore indicating the severity or relevance of the adverse information
pepObjectContains information related to the Politically Exposed Persons (PEPs)
pep.check_idStringUnique ID for the PEP check
pep.check_creation_dateStringThe date and time when the PEP check was created
pep.last_screened_dateStringThe date and time when the PEP check was last screened
pep.created_byStringThe ID of the user who created the PEP check
pep.resultsArrayList of Politically Exposed Persons found in the check
pep.results.nameStringName of the Politically Exposed Person
pep.results.externalIdStringExternal ID for the PEP entry
pep.results.entityTypeStringType of entity (e.g., Person, Organization)
pep.results.positionsArrayList of positions held by the PEP
pep.results.positions.titleStringTitle of the position held by the PEP
pep.results.positions.startDateStringStart date of the position
pep.results.positions.endDateStringEnd date of the position
pep.results.educationArrayList of educational qualifications related to the PEP
pep.results.education.titleStringTitle of the educational qualification
pep.results.education.startDateStringStart date of the educational qualification
pep.results.education.endDateStringEnd date of the educational qualification
pep.recommendationObjectRecommendation based on the PEP check results
pep.recommendation.riskLevelStringRisk level associated with the PEP (e.g., LOW, HIGH)