Skip to main content
POST
/
aml
/
checks
Create AML check
curl --request POST \
  --url https://api.example.com/aml/checks/ \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "clientId": "<string>",
  "userType": "COMPANY",
  "input": {
    "fullName": "<string>",
    "nationality": "AF",
    "dateOfBirth": "2023-12-25",
    "sex": "MALE"
  },
  "filter": {
    "threshold": 85,
    "datasets": [
      "PEP_CURRENT"
    ],
    "sanctionBodies": [
      40
    ],
    "dateOfBirthMatching": "EXACT",
    "pepTiers": [
      "PEP_TIER_1"
    ]
  }
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "clientId": "<string>",
  "checkedAt": "2023-11-07T05:31:56Z",
  "created": "2023-11-07T05:31:56Z",
  "userType": "COMPANY",
  "input": {
    "fullName": "<string>",
    "nationality": "AF",
    "dateOfBirth": "2023-12-25",
    "sex": "MALE"
  },
  "filter": {
    "threshold": 85,
    "datasets": [
      "PEP_CURRENT"
    ],
    "sanctionBodies": [
      40
    ],
    "dateOfBirthMatching": "EXACT",
    "pepTiers": [
      "PEP_TIER_1"
    ]
  },
  "amlCheck": [
    {
      "resourceId": "<string>",
      "score": 123,
      "match": "<string>",
      "name": "<string>",
      "addresses": [
        {
          "geography": "<string>",
          "city": "<string>"
        }
      ],
      "nationalities": [
        "AF"
      ],
      "datesOfBirth": [
        "<string>"
      ],
      "datasets": [
        "PEP_CURRENT"
      ],
      "currentSanBodyIds": [
        123
      ],
      "formerSanBodyIds": [
        123
      ],
      "version": 123,
      "gender": "MALE",
      "profileImage": "<string>",
      "pepTier": "PEP_TIER_1"
    }
  ],
  "adverseMedia": [
    {
      "title": "<string>",
      "url": "<string>",
      "text": "<string>",
      "score": 123,
      "type": "NEGATIVE",
      "publishDate": "2023-12-25"
    }
  ],
  "overallStatus": "NOT_CHECKED",
  "monitoring": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created": "2023-11-07T05:31:56Z",
    "status": "ACTIVE",
    "isSubscribed": true,
    "expiration": "2023-11-07T05:31:56Z",
    "tags": []
  }
}

Authorizations

Authorization
string
header
required

The request must contain basic auth headers where username is API key and password is API secret.
In order for you to start using our API you will need an API key and API secret.
Both can be retrieved by contacting iDenfy's support or iDenfy's sales team.

Body

application/json
clientId
string
required

A unique string identifying a client on your side.

Required string length: 1 - 100
userType
enum<string>
required
Available options:
COMPANY,
PERSON
input
object
required
filter
object
required

Response

201 - application/json
id
string<uuid>
required
clientId
string
required

A unique string identifying a client on your side.

Maximum string length: 100
checkedAt
string<date-time> | null
required
created
string<date-time>
required
userType
enum<string>
required
Available options:
COMPANY,
PERSON
input
object
required
filter
object
required
amlCheck
object[] | null
required

AML database search result.

adverseMedia
object[] | null
required

Adverse media database search result.

overallStatus
enum<string>
required
Available options:
NOT_CHECKED,
NO_FLAGS,
FALSE_POSITIVE,
TRUE_POSITIVE,
FLAGS_FOUND
monitoring
object
required