Skip to content
Connect API Catalog/Creditsafe Connect/
/Async AML

Async AML

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

Operations

Return All Async AML Jobs

Request

Gets a list of async aml jobs for user.

Security
bearerToken
Query
pageinteger

Starting page number.

Default:1
Example:page=1
pageSizeinteger

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

Example:pageSize=10
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"
Headers
X-Team-Idstring, (uuid)

Optional. The team to work in, using a team id from List Teams. If left out, the default team is used. Records created in a team can only be seen by sending that team's id. A team id that doesn't exist, or a team being deleted, is rejected with 404 Team Not Found.

Example:6b78aed4-9ba6-441b-80b9-df9bea3b7c97
curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/asyncAmlJobs?page=1&pageSize=10&statuses=string&targetType=profile' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-Team-Id: 6b78aed4-9ba6-441b-80b9-df9bea3b7c97'

Responses

Success

Bodyapplication/json
itemsArray of objects(GetKycProtectAsyncAmlJobItemResponse)

The async AML jobs on this page.

totalSizeinteger

Total number of items available.

correlationIdstring

Correlation ID for tracking the request.

Response
{
  "items": [],
  "totalSize": 0,
  "correlationId": "6d7047dd-2ebc-434d-a4a3-ca79ceaa53cf"
}