Retrieving Monitoring

Retrieve Single user

Retrieve 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.

Responses

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": [ ]

}

Retrieve All users

List AML monitorings

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

Authorizations:

API key pair

query Parameters

created	Array of strings <date-time> [ items <date-time > ] Multiple values may be separated by commas.
expiration	Array of strings <date-time> [ items <date-time > ] Multiple values may be separated by commas.
isExpired	boolean
name	string
orderBy	Array of strings Items Enum: "-created" "-expiration" "created" "expiration" Ordering
page	integer A page number within the paginated result set.
perPage	integer Number of results to return per page.
status	string Enum: "ACTIVE" "ALERT" "PENDING" "STOPPED"
tags	Array of strings[ items[ items non-empty ] ]
userType	string Enum: "COMPANY" "PERSON"

Responses

Response samples

• 200

Content type

application/json

{

• "count": 123,
• "next": "http://api.example.org/accounts/?page=4",
• "previous": "http://api.example.org/accounts/?page=2",
• "results": [

  • {

    • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    • "name": "string",
    • "status": "ACTIVE",
    • "userType": "COMPANY",
    • "isSubscribed": true,
    • "checkedAt": "2019-08-24T14:15:22Z",
    • "expiration": "2019-08-24T14:15:22Z",
    • "tags": [ ],
    • "created": "2019-08-24T14:15:22Z"

    }

  ]

}