Check PEP (Instant)

cURL

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>"
        }
      ],
      "tags": [
        "<string>"
      ],
      "searchScore": 123,
      "confidenceScore": 123
    }
  ]
}

POST

aml

pep

instant

cURL

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>"
        }
      ],
      "tags": [
        "<string>"
      ],
      "searchScore": 123,
      "confidenceScore": 123
    }
  ]
}

Authorizations

apiKey

string

header

required

apiSecret

string

header

required

Body

application/json

Pep request payload

name

string

required

Full name of the individual to be screened

threshold

number

required

Matching threshold for screening (e.g. similarity score)

country

string

Country code (e.g., 'ru' for Russia)

Response

Request was successful

message

string

A message indicating the status of the sanctions list fetch operation

count

integer

The total number of matching records found

pageNumber

integer

The current page number of the results

data

object[]

List of matched individuals/entities from the sanctions or PEP lists

Show child attributes

data._id

string

Unique identifier for the matched entity

data.type

string

Type of match (e.g., 'pep', 'sanction')

data.externalId

string

External identifier for the entity, if available

data.__v

integer

Version key used internally

data.addresses

string[]

List of known addresses associated with the entity

data.aliases

string[]

List of known aliases or alternative names for the entity

data.birth_date

string<date>

Date of birth of the entity

data.countries

string[]

Countries associated with the entity

data.createdAt

string<date-time>

Date when the record was created

data.updatedAt

string<date-time>

Date when the record was last updated

data.dataset

object[]

Sources or datasets where this match was found

Show child attributes

data.dataset.name

string

Name of the dataset

data.dataset.url

string

URL to the dataset source

data.entityType

string

Type of entity matched (e.g., 'Person', 'Organization')

data.name

string

Full name of the matched entity

data.sanctions

string[]

Sanctions associated with the entity, if any

data.photo

string

URL to a photo of the matched entity

data.politicalParty

string[]

List of political parties the person is affiliated with

data.gender

string

Gender of the matched entity

data.positions

object[]

List of positions or roles held by the entity

Show child attributes

data.positions.title

string

Title of the position

data.positions.startDate

string | null

Start date of the position

data.positions.endDate

string | null

End date of the position

data.positions._id

string

Unique identifier for the position

data.education

object[]

List of educational institutions attended

Show child attributes

data.education.title

string

Name of the institution

data.education.startDate

string | null

Start date of education

data.education.endDate

string | null

End date of education

data.education._id

string

Unique identifier for the education entry

data.tags

string[]

Tags associated with the record

data.searchScore

number

Score indicating how closely the entity matches the search criteria

data.confidenceScore

number

Confidence score of the match

Blacklist VAS Receiver Check PEP (Webhook)

⌘I

Getting Started

API

Authorizations

Body

Response