AML (Anti-Money Laundering)

Anti-Money Laundering (AML) compliance is a crucial aspect of financial services. It involves monitoring, detecting, and reporting suspicious activities to prevent financial crimes. On this page, we’ll dive into the different AML endpoints you can use to manage AML compliance programmatically. We'll look at how to query, create, update, and delete AML records.

The AML model

The AML model contains all the information related to AML compliance, including customer due diligence, transaction monitoring, and reporting of suspicious activities.

Properties

Name
id
Type
string
Description
Unique identifier for the AML record.
Name
customer_id
Type
string
Description
Unique identifier for the customer.
Name
risk_level
Type
string
Description
Risk level assigned to the customer (e.g., low, medium, high).
Name
status
Type
string
Description
Current status of the AML record (e.g., active, pending, closed).
Name
created_at
Type
timestamp
Description
Timestamp of when the AML record was created.
Name
updated_at
Type
timestamp
Description
Timestamp of when the AML record was last updated.

GET/v1/aml

List all AML records

This endpoint allows you to retrieve a paginated list of all your AML records. By default, a maximum of ten records are shown per page.

Optional attributes

Name
limit
Type
integer
Description
Limit the number of AML records returned.
Name
risk_level
Type
string
Description
Only show records with the specified risk level.
Name
status
Type
string
Description
Only show records with the specified status.
Name
customer_id
Type
string
Description
Only show records for the specified customer.

Request

GET

/v1/aml

curl -G https://api.finx.ai/v1/aml \
  -H "Authorization: Bearer {token}" \
  -d limit=10

Response

{
  "has_more": false,
  "data": [
    {
      "id": "xgQQXg3hrtjh7AvZ",
      "customer_id": "WAz8eIbvDR60rouK",
      "risk_level": "high",
      "status": "active",
      "created_at": 705103200,
      "updated_at": 705103200
    },
    {
      "id": "hSIhXBhNe8X1d8Et"
      // ...
    }
  ]
}

POST/v1/aml

Create an AML record

This endpoint allows you to add a new AML record. You need to provide the customer ID, risk level, and status to create an AML record.

Required attributes

Name
customer_id
Type
string
Description
Unique identifier for the customer.
Name
risk_level
Type
string
Description
Risk level assigned to the customer (e.g., low, medium, high).
Name
status
Type
string
Description
Current status of the AML record (e.g., active, pending, closed).

Request

POST

/v1/aml'

curl https://api.finx.ai/v1/aml \
  -H "Authorization: Bearer {token}" \
  -d 'customer_id'="WAz8eIbvDR60rouK" \
  -d 'risk_level'="high" \
  -d 'status'="active"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "customer_id": "WAz8eIbvDR60rouK",
  "risk_level": "high",
  "status": "active",
  "created_at": 705103200,
  "updated_at": 705103200
}

GET/v1/aml/:id

Retrieve an AML record

This endpoint allows you to retrieve an AML record by providing the record id. Refer to the list at the top of this page to see which properties are included with AML objects.

Request

GET

/v1/aml/xgQQXg3hrtjh7AvZ

curl https://api.finx.ai/v1/aml/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "customer_id": "WAz8eIbvDR60rouK",
  "risk_level": "high",
  "status": "active",
  "created_at": 705103200,
  "updated_at": 705103200
}

PUT/v1/aml/:id

Update an AML record

This endpoint allows you to perform an update on an AML record. Examples of updates are changing the risk level, updating the status, or modifying the customer information.

Optional attributes

Name
risk_level
Type
string
Description
Updated risk level assigned to the customer.
Name
status
Type
string
Description
Updated status of the AML record.

Request

PUT

/v1/aml/xgQQXg3hrtjh7AvZ

curl -X PUT https://api.finx.ai/v1/aml/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}" \
  -d 'status'="closed"

Response

{
  "id": "xgQQXg3hrtjh7AvZ",
  "customer_id": "WAz8eIbvDR60rouK",
  "risk_level": "high",
  "status": "closed",
  "created_at": 705103200,
  "updated_at": 705103200
}

DELETE/v1/aml/:id

Delete an AML record

This endpoint allows you to delete your AML records in Fin X. Note: This will permanently delete the record and all its data — ensure this is the desired action before proceeding.

Request

DELETE

/v1/aml/xgQQXg3hrtjh7AvZ

curl -X DELETE https://api.finx.ai/v1/aml/xgQQXg3hrtjh7AvZ \
  -H "Authorization: Bearer {token}"