/
Retrieve AML inherited-ma...

Retrieve AML inherited-match report
Experimental

Request

Retrieves a summary of AML checks that inherit status from another check, grouped by provenance reason, for the selected period.

Each category row contains the number of checks. This value is used to calculate the percentage of all inherited checks in the period. Propagated checks, which are reviewed without a human reviewer, are included in the total.

Use the collection filter to filter results by AML check fields from the AML checks report.

Security
SecretApiKey or JWT
Query
periodStartstring, (date-time)

Date and time when the report starts. If this value is not provided or is null, the report starts on the first day of the current month.

periodEndstring, (date-time)

Date and time when the report ends. If this value is not provided or is null, the report ends on the last day of the current month.

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.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/experimental/reports/aml-checks-inherited-summary?periodStart=2019-08-24T14%3A15%3A22Z&periodEnd=2019-08-24T14%3A15%3A22Z&filter=string' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

Report retrieved.

Bodyapplication/json
totalInheritedintegerrequired

Number of AML checks in the period that have inherited status.

categoriesArray of objectsrequired

Categories of inherited checks, grouped by provenance reason.

Response
{
  "totalInherited": 0,
  "categories": [
    { … }
  ]
}