Skip to main content
POST
/
alerts
/
{alertId}
/
transactions
List transactions linked to an alert with filtering and pagination
curl --request POST \
  --url https://api.artu.ai/alerts/{alertId}/transactions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Environment: <api-key>' \
  --data '
{
  "filter": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "search": "<string>",
    "amount": 123,
    "currency": "<string>",
    "description": "<string>",
    "externalId": "<string>",
    "timestamp": "2023-11-07T05:31:56Z",
    "relatedClientIds": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "isAlerted": true,
    "alertedAt": "2023-11-07T05:31:56Z",
    "riskAssessment": {
      "name": "<string>",
      "eq": 123,
      "gt": 123,
      "gte": 123,
      "lt": 123,
      "lte": 123,
      "levelIn": [
        "<string>"
      ],
      "levelNin": [
        "<string>"
      ]
    },
    "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "tagIds": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "metadataFilters": [
      {
        "key": "<string>",
        "value": "<string>"
      }
    ],
    "scopeData": {
      "MX": {
        "actividadVulnerable": {
          "ARI": {
            "operationType": "1501",
            "leaseStartDate": "2023-12-25",
            "leaseEndDate": "2023-12-25"
          },
          "AVI": {
            "hash": "<string>",
            "cryptoCurrency": "<string>",
            "cryptoAmount": 123
          },
          "INM": {
            "operationType": "501",
            "contractType": "<string>"
          },
          "JYS": {},
          "MJR": {
            "operationPostalCode": "<string>"
          },
          "MPC": {
            "postalCode": "<string>"
          },
          "TSC": {
            "idNumber": "<string>",
            "operationType": "211"
          },
          "VEH": {
            "postalCode": "<string>"
          }
        },
        "cnbv": {
          "TRANSMISOR": {
            "numeroCuenta": "<string>",
            "sucursal": "<string>",
            "localidad": "<string>"
          }
        }
      }
    },
    "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": [
    {
      "relatedClientIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "scopes": [],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "timestamp": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "isAlerted": true,
      "alertedAt": "2023-11-07T05:31:56Z",
      "alertItemId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "not_applicable",
      "amount": "<unknown>",
      "currency": "<unknown>",
      "exchangeRates": {},
      "externalId": "<string>",
      "description": "<string>",
      "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "metadata": {},
      "scopeData": {
        "MX": {
          "actividadVulnerable": {
            "ARI": {
              "property": {
                "leaseStartDate": "2023-12-25",
                "leaseEndDate": "2023-12-25",
                "colonia": "<string>",
                "calle": "<string>",
                "numeroExterior": "<string>",
                "postalCode": "<string>",
                "folioReal": "<string>",
                "value": "<unknown>",
                "numeroInterior": "<string>"
              },
              "payments": [
                {
                  "currency": "<string>",
                  "paymentDate": "2023-12-25",
                  "amount": "<unknown>"
                }
              ],
              "operationType": "1501"
            },
            "AVI": {
              "operationType": "<unknown>",
              "cryptoCurrency": "<string>",
              "hash": "<unknown>",
              "cryptoAmount": "<unknown>"
            },
            "INM": {
              "inmuebles": [
                {
                  "colonia": "<string>",
                  "calle": "<string>",
                  "numeroExterior": "<string>",
                  "postalCode": "<string>",
                  "folioReal": "<string>",
                  "value": "<unknown>",
                  "numeroInterior": "<string>",
                  "dimensionTerreno": "<unknown>",
                  "dimensionConstruido": "<unknown>"
                }
              ],
              "contract": {
                "type": "<unknown>",
                "instrumentNumber": "<string>",
                "instrumentDate": "2023-12-25",
                "notaryNumber": "<string>",
                "cadastralValue": "<unknown>"
              },
              "operationType": "501",
              "payments": [
                {
                  "currency": "<string>",
                  "paymentDate": "2023-12-25",
                  "amount": "<unknown>"
                }
              ]
            },
            "JYS": {
              "branchInformation": {
                "type": "<unknown>",
                "postalCode": "<unknown>"
              },
              "settlementType": "<unknown>"
            },
            "MJR": {
              "operationPostalCode": "<string>",
              "goods": [
                {
                  "quantity": "<unknown>"
                }
              ],
              "payments": [
                {
                  "currency": "<string>",
                  "paymentDate": "2023-12-25",
                  "amount": "<unknown>"
                }
              ],
              "operationType": "601"
            },
            "MPC": {
              "postalCode": "<string>",
              "disbursements": [
                {
                  "currency": "<string>",
                  "disbursementDate": "2023-12-25",
                  "amount": "<unknown>"
                }
              ],
              "collateral": [
                {
                  "bienMutuo": "<unknown>",
                  "guarantorClientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
                }
              ]
            },
            "TSC": {
              "idNumber": "<string>",
              "operationType": "211"
            },
            "VEH": {
              "postalCode": "<string>",
              "vehicles": [
                {
                  "kind": "<unknown>",
                  "marcaFabricante": "<unknown>",
                  "modelo": "<unknown>",
                  "anio": "<unknown>",
                  "vin": "<unknown>",
                  "repuve": "<unknown>",
                  "placas": "<unknown>",
                  "nivelBlindaje": "<unknown>"
                }
              ],
              "operationDate": "2023-12-25",
              "payments": [
                {
                  "currency": "<string>",
                  "paymentDate": "2023-12-25",
                  "amount": "<unknown>"
                }
              ]
            }
          },
          "cnbv": {
            "TRANSMISOR": {
              "sucursal": "<string>"
            }
          }
        },
        "US": "<unknown>"
      },
      "relatedClients": [
        {
          "clientId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "metadata": {}
        }
      ],
      "riskAssessments": {},
      "tags": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "name": "<string>",
          "color": "<string>"
        }
      ],
      "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"
    }
  ],
  "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