curl --request POST \
  --url https://sigmaaml.sabipay.com/api/v1/aml/risk-monitoring \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --header 'apiSecret: <api-key>' \
  --data '{
  "name": "<string>",
  "threshold": 123,
  "limit": 123,
  "callbackUrl": "<string>"
}'
{
  "message": "Request created successfully. Result will be sent to your webhook",
  "data": {
    "id": "<string>",
    "query": "<string>",
    "businessProfile": "<string>",
    "status": "pending",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  }
}

This is an example result that will be sent to your webhook upon completion

  {
  "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/example-link",
        "keyword": {
          "confidenceScore": 1
        },
        "adverseInformation": [
          {
            "keyword": "money laundering",
            "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": [
      {
        "_id": "662f92f5d2b06e101bdc7724",
        "externalId": "Q22295109",
        "type": "pep",
        "entityType": "Person",
        "name": "Yahaya Adoza Bello",
        "countries": ["ng"],
        "confidenceScore": 100,
        "politicalParty": ["All Progressives Congress"],
        "positions": [
          {
            "title": "Governor of Kogi State",
            "startDate": "2019",
            "endDate": "2023"
          }
        ],
        "education": [
          {
            "title": "University of Abuja",
            "endDate": "2004"
          }
        ]
      }
    ],
    "recommendation": {
      "riskLevel": "LOW"
    }
  }
}

Authorizations

apiKey
string
header
required
apiSecret
string
header
required

Body

application/json
Risk monitoring request payload
name
string
required

Full name of the individual or entity to check

threshold
number
required

The severity of search result

limit
number
required

The max number of result

callbackUrl
string
required

Where we send result

Response

200
application/json
Risk monitoring result
message
string

Message after the PEP request is successfully submitted

Example:

"Request created successfully. Result will be sent to your webhook"

data
object

Details of the submitted PEP screening request