Retrieve an AML audit report
Experimental

Request

Retrieves an Anti-Money Laundering (AML) audit report for a person with a specified ID. The maximum reporting period is 180 days.

The report includes linked customers, screening summary metrics, screening history, and related transactions for the selected period.

Use the Accept header to select the response format: application/json (default), application/pdf, or text/csv.

Each section of the report includes at most 10,000 records, and the truncated property is true when a section reaches that limit.

Security
SecretApiKey or JWT
Query
personIdstring, <= 50 charactersrequired
ID of the person for the report.
periodStartstring, (date-time)

Date and time when the report starts. If this value is not provided or is null, the report starts 90 days before the current date and time at midnight utc.

periodEndstring, (date-time)

Date and time when the report ends. If this value is not provided or is null, the report ends at the current date and time.

filterstring

Criteria for filtering collection items. This field requires a special format. Use , to specify multiple allowed values. Use ; to specify multiple fields.

For more information, see Search filters.

Headers
Acceptstring
Type of response media.
Default:"application/json"
Enum:"application/json""application/pdf""text/csv"
curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/aml-audit-reports?personId=string&periodStart=2019-08-24T14%3A15%3A22Z&periodEnd=2019-08-24T14%3A15%3A22Z&filter=string' \
  -H 'Accept: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.
Body
personIdstring, <= 50 charactersrequired
ID of the person associated with the report.
statusstring or nullrequired
Person-level AML screening status for the selected period.
Enum:"clear""confirmed-match""pending-review"
linkedCustomersArray of objectsrequired
Customers linked to the person.
summaryobjectrequired
Screening summary metrics for the selected period.
screeningHistoryArray of objectsrequired
AML screening history for the selected period.
transactionsArray of objectsrequired
Transactions for customers linked to the person in the selected period.
periodStartstring, (date-time)required
Start date time of the report period.
periodEndstring, (date-time)required
End date time of the report period.
truncatedbooleanrequired
Indicates whether any list within the report is truncated due to too many results.
Response
{
  "personId": "string",
  "status": "clear",
  "linkedCustomers": [
    { … }
  ],
  "summary": {
    "totalChecks": 0,
    "hitCount": 0,
    "lastCheckTime": "2019-08-24T14:15:22Z"
  },
  "screeningHistory": [
    { … }
  ],
  "transactions": [
    { … }
  ],
  "periodStart": "2019-08-24T14:15:22Z",
  "periodEnd": "2019-08-24T14:15:22Z",
  "truncated": true
}