Sars are cases that have been investigated and turned into a Suspicious Activity report with the intent to file it to FinCen.

The /sars endpoint can get and list sars.

ENDPOINT

DESCRIPTION

POST /sars/list

Retrieves a paginated list of SARs.

GET /sars/<unit21_id>

Retrieves the details of an existing SAR.

List SARs

When listing SARs, you can use the following filter parameters:

Note that all list inputs function as an "or" filter, as in any one of the values must match the selected alert(s)

Field

Type

Description

created_after

Numeric

SARs created on or after this unix timestamp

created_before

Numeric

SARs created before this unix timestamp

tag_filters

String[]

List of string tags in the format key:value or key to associate this sars with (e.g. sars_type:high_velocity or sars_type). If only the key is provided, we will match against all tags with that key

limit

Numeric

A limit on the number of objects to be returned. Limit can range between 1 and 50, and the default is 10

offset

Numeric

The offset for pagination. Default is 1

options

Object

Options for the data included in the returned sars. Removing unneeded options can improve response speed

curl -X POST \
  https://<API_ENDPOINT>/v1/sars/list \
  -H 'Content-Type: application/json' \
  -H 'u21-key: <YOUR_API_KEY>' \
  -d '{
        "created_after": 1591992745,
        "limit": 10,
        "offset": 1
        "options": {
          "include_associations": false,
          "include_actions": false,
          "include_checklist": false
        }
    }'
HTTP/1.1 200 OK
Content-Type: application/json
{
    "response_count": 2,
    "sars": [
        {
            "amount_volume": 0,
            "created_at": 1578622336,
            "created_by": "Clarence Chio",
            "description": "",
            "entities": [],
            "events": [],
            "filing_type": "Initial report",
            "lock": "",
            "name": "",
            "report_type": "FINCEN_SAR",
            "status": "PREFILING_VALIDATION_PENDING",
            "status_updated_at": 1597948038,
            "submitted": false,
            "submitted_at": "N/A",
            "tags": [],
            "txn_count": 0,
            "unit21_id": 5,
            "updated_at": 1623283105
        },
        {
            "amount_volume": 0,
            "created_at": 1582233696,
            "created_by": "Tyler Allen",
            "description": "lkigkhjbjhbkjhbk",
            "entities": [
                {
                    "entity_id": "userA-c1e9dcca-e46a-42e9-bb9e-2208e30e49da",
                    "entity_type": "user",
                    "unit21_id": 23518
                }
            ],
            "events": [
                {
                    "event_id": "txnBulk-11-9d67f84f-f232-41ec-bf77-f37fe8adfdb0",
                    "event_type": "transaction",
                    "unit21_id": 14519
                }
            ],
            "filing_type": "Initial report",
            "lock": "False",
            "name": "jghvkjhgkv",
            "report_type": "FINCEN_SAR",
            "status": "PREFILING_VALIDATION_PENDING",
            "status_updated_at": 1585937927,
            "submitted": false,
            "submitted_at": "N/A",
            "tags": [],
            "txn_count": 0,
            "unit21_id": 93,
            "updated_at": 1623283105
        }
    ],
    "total_count": 665
}

Options for the Endpoint

curl -X POST \
  https://<API_ENDPOINT>/v1/cases/create \
  -H 'Content-Type: application/json' \
  -H 'u21-key: <YOUR_API_KEY>' \
  -d '{
    "options": {
        "include_actions": true,
        "include_associations": true,
        "include_checklist": true
    }
  }'

The following fields are options for the endpoint:

Field

Type

Description

include_associations

Boolean

If true, the response will include all entities, events & instruments associated with the case.

include_actions

Boolean

If true, the response will include actions in the response which is a list of all actions taken on the case including disposition changes, status changes, reassignments and the authors email.

include_checklist

Boolean

If true, the response will include checklists in the response which is a list of all checklist items an agent must complete for the case investigation.