Getting Started
API
- Transaction Monitoring
- Anti Monitoring Laundering
Check PEP (Instant)
POST api/v1/aml/pep/instant
curl --request POST \
--url https://sigmaaml.sabipay.com/api/v1/aml/pep/instant \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--header 'apiSecret: <api-key>' \
--data '{
"name": "<string>",
"threshold": 123,
"country": "<string>"
}'
{
"message": "<string>",
"count": 123,
"pageNumber": 123,
"data": [
{
"_id": "<string>",
"type": "<string>",
"externalId": "<string>",
"__v": 123,
"addresses": [
"<string>"
],
"aliases": [
"<string>"
],
"birth_date": "2023-12-25",
"countries": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"dataset": [
{
"name": "<string>",
"url": "<string>"
}
],
"entityType": "<string>",
"name": "<string>",
"sanctions": [
"<string>"
],
"photo": "<string>",
"politicalParty": [
"<string>"
],
"gender": "<string>",
"positions": [
{
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"_id": "<string>"
}
],
"education": [
{
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"_id": "<string>"
}
],
"updatedBy": "<string>",
"updateComplete": true,
"updateCompleteDate": "2023-11-07T05:31:56Z",
"assignedDate": "2023-11-07T05:31:56Z",
"deceased": true,
"tags": [
"<string>"
],
"searchScore": 123,
"confidenceScore": 123
}
]
}
Body
Full name of the individual to be screened
Matching threshold for screening (e.g. similarity score)
Country code (e.g., 'ru' for Russia)
Response
A message indicating the status of the sanctions list fetch operation
The total number of matching records found
The current page number of the results
List of matched individuals/entities from the sanctions or PEP lists
Unique identifier for the matched entity
Type of match (e.g., 'pep', 'sanction')
External identifier for the entity, if available
Version key used internally
List of known addresses associated with the entity
List of known aliases or alternative names for the entity
Date of birth of the entity
Countries associated with the entity
Date when the record was created
Date when the record was last updated
Type of entity matched (e.g., 'Person', 'Organization')
Full name of the matched entity
Sanctions associated with the entity, if any
URL to a photo of the matched entity
List of political parties the person is affiliated with
Gender of the matched entity
ID of the user or system that last updated the record
Flag indicating whether the record update is complete
Date when the record update was marked complete
Date when the record was assigned for review or update
Flag indicating if the individual is deceased
Tags associated with the record
Score indicating how closely the entity matches the search criteria
Confidence score of the match
curl --request POST \
--url https://sigmaaml.sabipay.com/api/v1/aml/pep/instant \
--header 'Content-Type: application/json' \
--header 'apiKey: <api-key>' \
--header 'apiSecret: <api-key>' \
--data '{
"name": "<string>",
"threshold": 123,
"country": "<string>"
}'
{
"message": "<string>",
"count": 123,
"pageNumber": 123,
"data": [
{
"_id": "<string>",
"type": "<string>",
"externalId": "<string>",
"__v": 123,
"addresses": [
"<string>"
],
"aliases": [
"<string>"
],
"birth_date": "2023-12-25",
"countries": [
"<string>"
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"dataset": [
{
"name": "<string>",
"url": "<string>"
}
],
"entityType": "<string>",
"name": "<string>",
"sanctions": [
"<string>"
],
"photo": "<string>",
"politicalParty": [
"<string>"
],
"gender": "<string>",
"positions": [
{
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"_id": "<string>"
}
],
"education": [
{
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"_id": "<string>"
}
],
"updatedBy": "<string>",
"updateComplete": true,
"updateCompleteDate": "2023-11-07T05:31:56Z",
"assignedDate": "2023-11-07T05:31:56Z",
"deceased": true,
"tags": [
"<string>"
],
"searchScore": 123,
"confidenceScore": 123
}
]
}