Skip to main content
GET
curl

Overview

Returns an AML ongoing monitoring job started from Toggle AML Monitoring for Users or Toggle AML Monitoring for Businesses: its status, the per-outcome counters and one results entry per processed user or business. Selections of more than 20 profiles run in the background and the toggle call returns 202 with a PENDING job. Poll this endpoint every couple of seconds until status is COMPLETED or FAILED. results fills in as profiles are processed, in processing order, and is complete once the job is COMPLETED. Per-record results are recorded for jobs started through the API; a job started from the Business Console reports counters only.

Job status

The per-record outcome values are documented on the toggle pages.

Permissions

Any active API key of the application can call this endpoint. A job is only visible to the application that created it; any other job_id returns 404.

Authorizations

x-api-key
string
header
required

Path Parameters

job_id
string<uuid>
required

The job_id returned by the toggle endpoint.

Response

The job.

job_id
string<uuid>
status
enum<string>
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
is_enabled
boolean

true when the job enables monitoring, false when it disables it.

target_type
enum<string>

Which profile family the job toggles.

Available options:
user,
business
total
integer

Profiles the job processes.

processed
integer

Profiles processed so far.

outcomes
object

Per-record outcome counters. Every selected profile resolves to exactly one counter; nothing is silently skipped.

results
object[]

One entry per processed profile, in processing order. Grows while the job runs; complete once status is COMPLETED. Recorded for jobs started through the API; a job started from the Business Console reports counters only.

error
string | null

Generic failure message when status is FAILED; the detailed cause is kept on the platform side.

created_at
string<date-time>
completed_at
string<date-time> | null