List Watchlists
curl --request GET \
--url https://api.example.com/kyc/watchlistsimport requests
url = "https://api.example.com/kyc/watchlists"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/kyc/watchlists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/kyc/watchlists",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/kyc/watchlists"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/kyc/watchlists")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/kyc/watchlists")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyWatchlists
List Watchlists
Retrieve all watchlists for your tenant
GET
/
kyc
/
watchlists
List Watchlists
curl --request GET \
--url https://api.example.com/kyc/watchlistsimport requests
url = "https://api.example.com/kyc/watchlists"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/kyc/watchlists', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/kyc/watchlists",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/kyc/watchlists"
req, _ := http.NewRequest("GET", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/kyc/watchlists")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/kyc/watchlists")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_bodyEndpoint
GET /kyc/watchlists
Authentication
Requireswatchlist:list permission.
Query Parameters
boolean
Filter to show only active watchlists. Set to
true to exclude paused watchlists.string
Comma-separated list of tags to filter by. Returns watchlists that have any of the specified tags.Example:
tags=compliance,high-priorityRequest Examples
Get All Watchlists
curl -X GET https://stg.kyc.legaltalent.ai/kyc/watchlists \
-H "Authorization: Bearer YOUR_TOKEN"
Get Only Active Watchlists
curl -X GET "https://stg.kyc.legaltalent.ai/kyc/watchlists?active=true" \
-H "Authorization: Bearer YOUR_TOKEN"
Filter by Tags
curl -X GET "https://stg.kyc.legaltalent.ai/kyc/watchlists?tags=compliance,high-priority" \
-H "Authorization: Bearer YOUR_TOKEN"
Combine Filters
curl -X GET "https://stg.kyc.legaltalent.ai/kyc/watchlists?active=true&tags=compliance" \
-H "Authorization: Bearer YOUR_TOKEN"
Response
{
"status": "success",
"data": {
"watchlists": [
{
"watchlist_id": "550e8400-e29b-41d4-a716-446655440000",
"name": "High Risk Customers",
"status": "active",
"tags": ["compliance", "high-priority"],
"last_checked_at": "2024-11-22T09:00:00Z",
"next_check_due": 1732278600000,
"check_frequency": "daily"
},
{
"watchlist_id": "660e8400-e29b-41d4-a716-446655440002",
"name": "Vendor Watchlist",
"status": "paused",
"tags": ["vendors"],
"last_checked_at": null,
"next_check_due": null,
"check_frequency": "weekly"
}
],
"count": 2
}
}
Response Fields
| Field | Type | Description |
|---|---|---|
watchlists | array | List of watchlist objects |
count | integer | Total number of watchlists returned |
Watchlist Object Fields
| Field | Type | Description |
|---|---|---|
watchlist_id | string | Unique identifier |
name | string | Watchlist name |
status | string | active or paused |
tags | array | Custom tags for categorization |
last_checked_at | string/null | Last screening timestamp (ISO 8601) |
next_check_due | number/null | Next check timestamp (Unix milliseconds) |
check_frequency | string | Screening frequency |
Status Codes
| Code | Description |
|---|---|
| 200 | Success |
| 401 | Unauthorized |
| 403 | Forbidden - Missing watchlist:list permission |
| 500 | Internal Server Error |
⌘I