Create Monitoring

Create AML monitoring

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

Authorizations:

API key pair

Request Body schema: application/json

required

isSubscribed required	boolean Should the expiration of this AML monitoring be automatically extended or not.
required	any (AmlMonitoringAmlCheckRequest)
tags	Array of strings <= 5 items [ items [ 1 .. 32 ] characters ^[^,]+$ ] Default: [] List of case-sensitive strings. Each tag can not be longer than 32 characters.

Responses

Request samples

• Payload

Content type

application/json

{

• "isSubscribed": true,
• "amlCheck": {

  • "clientId": "string",
  • "userType": "COMPANY",
  • "input": {

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

    }

  },
• "tags": [ ]

}

Response samples

• 201

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "isSubscribed": true,
• "status": "ACTIVE",
• "expiration": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "amlCheck": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "string",
  • "checkedAt": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "userType": "COMPANY",
  • "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"

  },
• "tags": [ ]

}

---

Update

Patch method allowes to add monitoring extention (yearly) and add tags for better sorting

Partially update AML monitoring

https://ivs.idenfy.com/aml/monitorings/{id}/

Authorizations:

API key pair

path Parameters

id required

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

Request Body schema: application/json

isSubscribed	boolean Should the expiration of this AML monitoring be automatically extended or not.
tags	Array of strings <= 5 items [ items [ 1 .. 32 ] characters ^[^,]+$ ] Default: [] List of case-sensitive strings. Each tag can not be longer than 32 characters.

Responses

Request samples

• Payload

Content type

application/json

{

• "isSubscribed": true,
• "tags": [ ]

}

Response samples

• 200

Content type

application/json

{

• "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
• "isSubscribed": true,
• "status": "ACTIVE",
• "expiration": "2019-08-24T14:15:22Z",
• "created": "2019-08-24T14:15:22Z",
• "amlCheck": {

  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "clientId": "string",
  • "checkedAt": "2019-08-24T14:15:22Z",
  • "created": "2019-08-24T14:15:22Z",
  • "userType": "COMPANY",
  • "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"

  },
• "tags": [ ]

}