Skip to main content
POST
/
alerts
/
{alertId}
/
clients
List unique clients related to an alert (direct + via transactions)
curl --request POST \
  --url https://api.artu.ai/alerts/{alertId}/clients \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Environment: <api-key>' \
  --data '
{
  "filter": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "search": "<string>",
    "isPrimary": true,
    "age": 123,
    "name": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "externalId": "<string>",
    "metadataFilters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "riskAssessment": {
      "name": "<string>",
      "eq": 123,
      "gt": 123,
      "gte": 123,
      "lt": 123,
      "lte": 123,
      "levelIn": [
        "<string>"
      ],
      "levelNin": [
        "<string>"
      ]
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "tagIds": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "scopeData": {
      "MX": {
        "rfc": "<string>",
        "curp": "<string>",
        "actividadVulnerable": {
          "ARI": {},
          "AVI": {
            "username": "<string>"
          },
          "INM": {},
          "JYS": {},
          "MJR": {},
          "MPC": {},
          "TSC": {},
          "VEH": {}
        },
        "cnbv": {
          "TRANSMISOR": {}
        }
      }
    },
    "alertItem": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "alertId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "transactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "hasErrors": true,
      "clientNames": "<string>",
      "transactionAmount": 123,
      "transactionCurrency": "<string>",
      "transactionDate": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "metadataFilters": [
        {
          "key": "<string>",
          "value": "<string>"
        }
      ],
      "scopeData": {
        "MX": {
          "actividadVulnerable": {
            "alertDescription": "<string>",
            "ARI": {},
            "AVI": {},
            "INM": {},
            "JYS": {},
            "MJR": {},
            "MPC": {},
            "TSC": {},
            "VEH": {}
          },
          "cnbv": {
            "TRANSMISOR": {}
          }
        }
      }
    },
    "alertItemHasErrors": true
  },
  "sort": [
    {}
  ],
  "cursor": "<string>",
  "offset": 4503599627370495,
  "limit": 20,
  "includeTotalCount": true
}
'
{
  "data": [
    {
      "type": "<unknown>",
      "name": "<string>",
      "scopes": [],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "isPrimary": true,
      "nationalities": "<unknown>",
      "externalId": "<string>",
      "metadata": {},
      "birthDate": "2023-12-25",
      "middleName": "<string>",
      "lastName": "<unknown>",
      "employment": {
        "isEmployee": true,
        "employeeId": "<string>",
        "position": "<string>",
        "department": "<string>",
        "startDate": "2023-12-25"
      },
      "scopeData": {
        "MX": {
          "rfc": "<string>",
          "curp": "<string>",
          "actividadVulnerable": {
            "ARI": {},
            "AVI": {
              "username": "<unknown>"
            },
            "INM": {},
            "JYS": {},
            "MJR": {},
            "MPC": {},
            "TSC": {},
            "VEH": {}
          },
          "cnbv": {
            "TRANSMISOR": {
              "numeroCuenta": "<string>",
              "claveSujetoObligado": "<string>"
            }
          }
        },
        "US": "<unknown>"
      },
      "email": "<string>",
      "phone": "<string>",
      "age": 0,
      "addresses": [
        {
          "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "isPrimary": true,
          "street": "<string>",
          "city": "<string>",
          "state": "<string>",
          "postalCode": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "type": "home",
          "country": "<unknown>",
          "externalId": "<string>",
          "metadata": {},
          "scopeData": {
            "MX": {
              "exteriorNumber": "<string>",
              "interiorNumber": "<string>",
              "neighborhood": "<string>",
              "municipality": "<string>",
              "betweenStreets": "<string>",
              "reference": "<string>",
              "cnbv": {
                "TRANSMISOR": {
                  "localidad": "<unknown>"
                }
              }
            },
            "US": "<unknown>"
          }
        }
      ],
      "contactMethods": [
        {
          "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "value": "<string>",
          "isVerified": true,
          "verifiedAt": "2023-11-07T05:31:56Z",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "isPrimary": false,
          "label": "<string>",
          "externalId": "<string>",
          "metadata": {}
        }
      ],
      "bankAccounts": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "accountNumber": "<string>",
          "bankName": "<string>",
          "country": "<unknown>",
          "currency": "<string>",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "bankCode": "<string>",
          "type": "checking",
          "isPrimary": true,
          "isActive": true,
          "label": "<string>",
          "externalId": "<string>",
          "metadata": {},
          "clabe": "<unknown>",
          "codigoBanco": "<string>",
          "codigoPlaza": "<string>"
        }
      ],
      "documents": [
        {
          "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>",
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "status": "pending_upload",
          "filename": "<string>",
          "contentType": "<string>",
          "size": 0,
          "expiresAt": "2023-12-25",
          "verifiedAt": "2023-11-07T05:31:56Z",
          "verifiedBy": "<string>",
          "rejectionReason": "<string>",
          "reviewedAt": "2023-11-07T05:31:56Z",
          "reviewedBy": "<string>",
          "externalId": "<string>",
          "fields": {},
          "metadata": {}
        }
      ],
      "linkedClients": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "client": {
            "type": "<unknown>",
            "name": "<string>",
            "scopes": [
              null
            ],
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "createdAt": "2023-11-07T05:31:56Z",
            "updatedAt": "2023-11-07T05:31:56Z",
            "nationalities": "<unknown>",
            "externalId": "<string>",
            "metadata": {},
            "birthDate": "2023-12-25",
            "middleName": "<string>",
            "lastName": "<unknown>",
            "employment": {
              "isEmployee": "<unknown>",
              "employeeId": "<unknown>",
              "position": "<unknown>",
              "department": "<unknown>",
              "startDate": "<unknown>"
            },
            "scopeData": {
              "MX": "<unknown>",
              "US": "<unknown>"
            }
          },
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "metadata": {}
        }
      ],
      "riskAssessments": {},
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "color": "<string>"
        }
      ],
      "alertItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "alertItemValidationErrors": [
        {
          "path": "<string>",
          "code": "<string>",
          "message": "<string>",
          "resourceId": "<string>",
          "label": "<string>",
          "sdkField": "<string>",
          "parentClientId": "<string>"
        }
      ],
      "alertItemScopeData": {
        "MX": {
          "actividadVulnerable": {
            "alertDescription": "<string>",
            "amendment": {
              "originalReference": "<string>",
              "reason": "<string>"
            },
            "ARI": {},
            "AVI": {},
            "INM": {},
            "JYS": {},
            "MJR": {},
            "MPC": {},
            "TSC": {},
            "VEH": {}
          },
          "cnbv": {
            "TRANSMISOR": {
              "fechaDeteccion": "2023-11-07T05:31:56Z",
              "descripcionOperacion": "<string>",
              "razones": "<string>"
            }
          }
        },
        "US": "<unknown>"
      },
      "alertItemMetadata": {},
      "alertItemCreatedAt": "2023-11-07T05:31:56Z",
      "linkedTransactionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<string>",
    "totalCount": 0
  }
}

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the dashboard.

X-Environment
string
header
required

Target environment for the request. Must be "test" or "live".

Path Parameters

alertId
string<uuid>
required

Body

application/json
filter
object
sort
object[]
cursor
string
offset
integer
Required range: 0 <= x <= 9007199254740991
limit
integer
default:20
Required range: 1 <= x <= 200
includeTotalCount
boolean

Response

200 - application/json

OK

data
object[]
required
pagination
object
required