AML - Create Check

Requirements

• API key pair
• Services enabled on your environment (done by iDenfy's staff)
• Credits for each service used

---

AML check flow

Have question?

You can find more explanation in Help center

---

Create AML check

https://ivs.idenfy.com/aml/checks/

Authorizations:

API key pair

Request Body schema: application/json

clientId required	string [ 1 .. 100 ] characters A unique string identifying a client on your side.
userType required	string (UserMonitoringTypeEnum) COMPANYPERSONPERSON
services required	Array of strings (AmlCheckServiceEnum) Items Enum: "AML_CHECK" "ADVERSE_MEDIA"
required	object (PersonAmlCheckInputRequest)
required	object (PersonAmlCheckFilterRequest)

Responses

Request samples

• Payload

Content type

application/json

Example

PERSONCOMPANYPERSON

{

• "clientId": "string",
• "userType": "PERSON",
• "services": [

  • "AML_CHECK"

  ],
• "input": {

  • "fullName": "string",
  • "nationality": "AF",
  • "dateOfBirth": "2019-08-24",
  • "sex": "MALE"

  },
• "filter": {

  • "threshold": 85,
  • "datasets": [

    • "PEP_CURRENT"

    ],
  • "sanctionBodies": [

    • 1

    ],
  • "dateOfBirthMatching": "EXACT",
  • "pepTiers": [

    • "PEP_TIER_1"

    ]

  }

}

Response samples

• 201

Content type

application/json

Example

PERSONCOMPANYPERSON

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "clientId": "string",
• "checkedAt": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "userType": "PERSON",
• "services": [

  • "AML_CHECK"

  ],
• "input": {

  • "fullName": "string",
  • "nationality": "AF",
  • "dateOfBirth": "2019-08-24",
  • "sex": "MALE"

  },
• "filter": {

  • "threshold": 85,
  • "datasets": [

    • "PEP_CURRENT"

    ],
  • "sanctionBodies": [

    • 1

    ],
  • "dateOfBirthMatching": "EXACT",
  • "pepTiers": [

    • "PEP_TIER_1"

    ]

  },
• "amlCheck": [

  • {

    • "version": 0,
    • "resourceId": "string",
    • "score": 0,
    • "match": "string",
    • "name": "string",
    • "addresses": [

      • {

        • "geography": "string",
        • "city": "string"

        }

      ],
    • "nationalities": [

      • "AF"

      ],
    • "datesOfBirth": [

      • "string"

      ],
    • "gender": "MALE",
    • "profileImage": "string",
    • "datasets": [

      • "PEP_CURRENT"

      ],
    • "currentSanBodyIds": [

      • 0

      ],
    • "formerSanBodyIds": [

      • 0

      ],
    • "pepTier": "PEP_TIER_1"

    }

  ],
• "adverseMedia": [

  • {

    • "title": "string",
    • "url": "http://example.com",
    • "text": "string",
    • "score": 0,
    • "type": "NEGATIVE",
    • "publishDate": "2019-08-24"

    }

  ],
• "overallStatus": "NOT_CHECKED"

}

---

Generate AML check PDF

https://ivs.idenfy.com/aml/checks/{id}/pdf/

Authorizations:

API key pair

path Parameters

id required

string <uuid> A UUID string identifying this AML check.

Request Body schema: application/json

password

string non-empty

Responses

Request samples

• Payload

Content type

application/json

{

• "password": "string"

}