List ACAM Invalid Customers

Introduction

When an ACAM_FAILED webhook is sent, it indicates that a customer is either DEAD (for individuals) or DEACTIVATED (for companies).

How to List ACAM Invalid Customers

To get ACAM Invalid Customers, you need to call the List ACAM Customers:

curl --request GET \
     --url 'https://faas.sandbox.tracefinance.io/customerCompliance/api/acams/{{acamId}}/customers?filters=currentStatus[in]%3DDEAD%7CDEACTIVATED' \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --header 'authorization: Bearer {accessToken}' \

Parameters:

{acamId}: This is the id of the ACAM.
?filters=currentStatus[in]=DEAD|DEACTIVATED: This is the filter to get the customers with DEAD or DEACTIVATED status (see more about filtering).

Resulting Status:

The endpoint will respond with a status code of 201 with the response below:

{
    "data": [
        {
            "id": "ff9bab39-0514-4828-b9e6-3611bfd12f81",
            "name": "Invalid User",
            "taxId": "12345678909",
            "type": "PERSON",
            "currentStatus": "DEAD",
            "reason": "Test - TITULAR FALECIDO",
            "createdAt": "2024-06-06T20:46:01.3100Z",
            "updatedAt": "2024-06-06T20:46:01.3100Z"
        }
    ],
    "meta": {
        "previousCursor": null,
        "nextCursor": null,
        "total": 1
    }
}