Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Table of Contents
minLevel1
maxLevel7

...

Expand
titleClick to view/close
POST GET PUT DELETE POST

Endpoint

Description

1

Status
colourGreen
titlepost
/v1/worklists

Create a new worklist

2

Status
colourBlue
titleget
/v1/worklists/{worklistId}

Retrieve a specific worklist

3

Status
colourYellow
titleput
/v1/worklists/{worklistId}

Update an existing worklist

4

Status
colourRed
titledelete
/v1/worklists/{worklistId}

Delete a specific worklist

5

Status
colourGreen
titlepost
/v1/worklists/search

Get a list of created worklists

...

Expand
titleClick to view/close
POST POST PUT DELETE GET PUT DELETE POST GET GET POST GET POST POST GET

Endpoint

Description

1

Monitoring

2

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/natural-entity-records/search

Get all person records in the monitoring worklist

3

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/natural-entity-records/batch-async

Add multiple person records in the monitoring worklist with asynchronous operation (limit 10k records)

4

POST

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/natural-entity-records/batch

Add multiple person records in the monitoring worklist
(limit 25 records)

5

Status
colourYellow
titleput
/v1/worklists/{worklistId}/natural-entity-records/batch

Update multiple person records in the monitoring worklist (limit 25 records)

6

Status
colourRed
titledelete
/v1/worklists/{worklistId}/natural-entity-records/batch

Delete multiple person records from the monitoring worklist (limit 25 records)

7

Status
colourBlue
titleget
/v1/worklists/{worklistId}/natural-entity-records/{recordId}

Get a specific person record from the monitoring worklist

8

Status
colourYellow
titleput
/v1/worklists/{worklistId}/natural-entity-records/{recordId}

Update a specific person record in the monitoring worklist

9

Status
colourRed
titledelete
/v1/worklists/{worklistId}/natural-entity-records/{recordId}

Delete a specific person record from the monitoring worklist

10

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/natural-entity-records

Create a person record in the monitoring worklist

11

Status
colourBlue
titleget
/v1/worklists/{worklistId}/natural-entity-records/batch/{id}

Get batch-async operation results

12

Status
colourBlue
titleget
/v1/worklists/{worklistId}/natural-entity-records/batch/{id}/records

Get batch-async operation individual records and their status

13

Retrieve matches

14

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/natural-entity-records/{recordId}/search

Search for all matches of the specific person record in the monitoring worklist

15

GET

Status
colourBlue
titleget
/v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/{matchId}

Search for a particular match of the specific person record in the monitoring worklist

16

Status
colourBlue
titleget
/v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/{matchId}/reviews

Get reviews of the match of the specific person record in the monitoring worklist

17

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/{matchId}/reviews

Create a review for a specified match

18

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/natural-entity-records/{recordId}/matches/reviews

Create reviews for multiple matches

19

Get record details

20

Status
colourBlue
titleget
/v1/natural-entity-details/{resourceId}

Get the profile data of the person that was matched with a record

...

Expand
titleClick to view/close
POST POST POST PUT DELETE GET PUT DELETE POST GET GET POST GET POST POST GET

Endpoint

Description

1

Monitoring

2

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/legal-entity-records/search

Get all business records in the monitoring worklist

3

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/legal-entity-records/batch-async

Add multiple business records to the monitoring worklist with asynchronous operation (limit 10k records)

4

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/legal-entity-records/batch

Add multiple business records to the monitoring worklist (limit 25 records)

5

Status
colourYellow
titleput
/v1/worklists/{worklistId}/legal-entity-records/batch

Update multiple business records in the monitoring worklist (limit 25 records)

6

Status
colourRed
titledelete
/v1/worklists/{worklistId}/legal-entity-records/batch

Delete multiple business records from the monitoring worklist (limit 25 records)

7

Status
colourBlue
titleget
/v1/worklists/{worklistId}/legal-entity-records/{recordId}

Get a specific business record from the monitoring worklist

8

Status
colourYellow
titleput
/v1/worklists/{worklistId}/legal-entity-records/{recordId}

Update a specific business record in the monitoring worklist

9

Status
colourRed
titledelete
/v1/worklists/{worklistId}/legal-entity-records/{recordId}

Delete a specific business record from the monitoring worklist

10

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/legal-entity-records

Create a business record in the monitoring worklist

11

Status
colourBlue
titleget
/v1/worklists/{worklistId}/legal-entity-records/batch/{id}

Get batch-async operation results

12

Status
colourBlue
titleget
/v1/worklists/{worklistId}/legal-entity-records/batch/{id}/records

Get batch-async operation individual records and their status

13

Retrieve matches

14

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/legal-entity-records/{recordId}/search

Search for all matches of a specific business record in the monitoring worklist

15

Status
colourBlue
titleget
/v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/{matchId}

Search for a particular match of a specific business record in the monitoring worklist

16

GET

Status
colourBlue
titleget
/v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/{matchId}/reviews

Get reviews of the match of the specific business record in the monitoring worklist

17

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/{matchId}/reviews

Create a review for a specified match

18

Status
colourGreen
titlepost
/v1/worklists/{worklistId}/legal-entity-records/{recordId}/matches/reviews

Create reviews for multiple matches

19

Get record details

20

Status
colourBlue
titleget
/v1/legal-entity-details/{resourceId}

Get the profile data of the business that was matched with a record

...

Expand
titleClick to view/close
GET

Endpoint

Description

1

Status
colourBlue
titleget
/v1/information/screening-status

Get the global status of the AML service (screening frequency still depends on individual worklist configuration).

...