Skip to main content
GET
/
aml
/
monitorings
List AML monitorings
curl --request GET \
  --url https://api.example.com/aml/monitorings/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "count": 123,
  "results": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "userType": "COMPANY",
      "checkedAt": "2023-11-07T05:31:56Z",
      "created": "2023-11-07T05:31:56Z",
      "status": "ACTIVE",
      "isSubscribed": true,
      "expiration": "2023-11-07T05:31:56Z",
      "tags": []
    }
  ],
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

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.

Query Parameters

created
string<date-time>[]

Multiple values may be separated by commas.

expiration
string<date-time>[]

Multiple values may be separated by commas.

isExpired
boolean
name
string
orderBy
enum<string>[]

Ordering

Available options:
-created,
-expiration,
created,
expiration
page
integer

A page number within the paginated result set.

perPage
integer

Number of results to return per page.

status
enum<string>
Available options:
ACTIVE,
ALERT,
PENDING,
STOPPED
tags
string[][]
Minimum string length: 1
userType
enum<string>
Available options:
COMPANY,
PERSON

Response

200 - application/json
count
integer
required
Example:

123

results
object[]
required
next
string<uri> | null
Example:

"http://api.example.org/accounts/?page=4"

previous
string<uri> | null
Example:

"http://api.example.org/accounts/?page=2"