Skip to content

Async AML

Endpoints to return asynchronous AML jobs, such as bulk screenings or monitoring tasks.

Return All Async AML Jobs

Request

Gets a list of async aml jobs for user.

Security
bearerToken
Query
pageinteger

Starting page number.

Default:1
pageSizeinteger

Specifies the number of items to be displayed per page. Allowed values are between 1 and 100.

statusesArray of strings

The async job statuses. It can be the collection of created, processing, completed

targetTypestring

The async job's target type. It can be either Profile or KeyParty

Enum:"profile""keyParty"
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/asyncAmlJobs?page=1&pageSize=0&statuses=string&targetType=profile' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success

Bodyapplication/json
itemsArray of objects(GetKycProtectAsyncAmlJobItemResponse)
totalSizeinteger

Total number of items available.

correlationIdstring

Correlation ID for tracking the request.

Response
{ "items": [ {} ], "totalSize": 0, "correlationId": "string" }