BREAGEN Logo
List Management

List Data Management

Watchlist Management offers clients the capability to curate and maintain their own lists, as well as access publicly available datasets. This feature includes APIs for seamless integration with various internal and external systems, facilitating efficient data sharing and synchronization across platforms. With Watchlist Management, clients can stay informed and proactive by monitoring specific entities enabling timely responses to emerging opportunities or threats. This functionality serves as a valuable asset for organizations seeking to optimize their screening and monitoring capabilities across various domains.

List Operations

List Operations provide comprehensive management of Lists, including creating, updating, retrieving, and deleting lists. This also includes listing all lists for easy monitoring and response.

Watchlist Management - Get Lists GET /v1/list/filter_list/{page_number}/{page_size}

Resource URL/v1/list/filter_list/{page_number}/{page_size}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

page_nopage number to get , keep default as 1
page_sizeNumber of records per page

Example Request

curl -X 'GET' \
'https://lm-gen-1.braegen.ai/v1/api/list/filter_list/1/10?query=Tra' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "Filter Process Success",
    "page_no": 1,
    "page_size": 10,
    "total_pages": 1,
    "total": 1,
    "results": [
        {
        "display_name": "EU-Travel-baned-list",
        "version": "eu-travel-baned-list-20240515",
        "credibility": "medium",
        "fetcher": 1,
        "status": "released",
        "client_id": "client_1",
        "is_active": true,
        "create_datetime": "2024-05-15T00:00:00",
        "format": "application/json",
        "id": 1,
        "schedule_frequency": "default",
        "list_type": "remote",
        "create_user": "[email protected]",
        "total_record": 3800,
        "update_datetime": null
        }
    ]
    }

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
404Invalid page number or missing
404Invalid page size or missing

Watchlist Management - Add Public Watchlist POST /v1/list/add_remote

Resource URL/v1/list/add_remote
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

$ curl --request POST
--url 'https://wl-gen-1.braegen.ai/v1/list/add_remote'
--header 'Content-Type: application/json'
--data '{
    "display_name": "wordcheck",
    "fetcher": 1,
    "credibility": "10",
    "schedule_frequency": "7",
    "list_type": "remote",
    "status": "Released",
    "client_id": "df-cli-110",
    "create_user": "df@sys",
    "is_active": true
}'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required
{
    "is_error": false,
    "message": "Crate User Fetcher Process Success",
    "results": {
        "display_name": "wordcheck",
        "version": "wordcheck-20240505",
        "credibility": "10",
        "fetcher": null,
        "status": "Released",
        "create_user": "df@sys",
        "total_record": null,
        "update_datetime": null,
        "format": "application/json",
        "id": 10,
        "schedule_frequency": "7",
        "list_type": "remote",
        "client_id": "df-cli-110",
        "is_active": true,
        "create_datetime": "2024-05-05T00:00:00"
    }
}

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input
404invalid or not founc type

Watchlist Management - Add Private Watchlist POST /v1/list/add_local

Resource URL/v1/list/add_local
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

$ curl --request POST
--url 'https://wl-gen-1.braegen.ai/v1/list/add_remote'
--header 'Content-Type: application/json'
--data '{
    "display_name": "private-clientbase-001-blacklist",
    "fetcher": 159,
    "credibility": "100",
    "schedule_frequency": "7",
    "list_type": "remote",
    "status": "Released",
    "client_id": "df-cli-110",
    "create_user": "df@sys",
    "is_active": true
}'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required
{
    "is_error": false,
    "message": "Crate User Fetcher Process Success",
    "results": {
        "display_name": "private-clientbase-blacklist",
        "version": "private-clientbase-001-blacklist-001",
        "credibility": "10",
        "fetcher": null,
        "status": "Released",
        "create_user": "df@sys",
        "total_record": null,
        "update_datetime": null,
        "format": "application/json",
        "id": 10,
        "schedule_frequency": "7",
        "list_type": "remote",
        "client_id": "df-cli-110",
        "is_active": true,
        "create_datetime": "2024-05-05T00:00:00"
    }
}

HTTP Responses

HTTP CodeMessage
200Succcess
204No Content
400Bad Request
401Unauthorized
403Invalid Input

Watchlist Management - Upload Data to Private Fetcher POST /v1list/upload/{user_fetcher_id}

Resource URL/v1list/upload/{user_fetcher_id}
Response FormatJson
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

Example Request

curl 'https://lm-gen-1.braegen.ai/v1/list/upload/11' --compressed -X POST \
--data-binary @client-list-data.csv

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required
HTTP CodeMessage
200Success
400File size too big
202Processing success
206Processing is in progress
404Missing list ID
422Invalid format
403Authentication Required

Example Response

{
    "is_error": false,
    "message": "File Upload Success",
    "status": "completed"
}

Sample Csv format for private data fetcher - (manual upload format)

address,alias,country,date,description,entity_name,entity_type,gender,position
"123 Main St, Springfield","John Doe",US,1980-05-15,"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed at aliquam justo. Integer euismod magna vel ante volutpat, nec placerat ipsum aliquet.",Acme Corporation,organisation,male,"Chief Executive Officer"
"456 Elm St, Rivertown","Jane Smith",US,1975-10-20,"Suspendisse potenti. Maecenas suscipit libero nec bibendum feugiat. Nulla facilisi. Mauris hendrerit suscipit orci, et tempus nisl ultricies id.",Tech Innovations,organisation,female,"Chief Technology Officer"
"789 Oak Ave, Lakeside","David Johnson",US,1990-03-12,"Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Donec dapibus laoreet lorem, at cursus velit efficitur id.",Global Solutions,organisation,male,"Head of Marketing"
"101 Pine St, Mountainville","Emily Brown",US,1988-08-25,"Vestibulum auctor, lectus eget ultrices malesuada, ligula lorem consequat lacus, a dignissim eros est eget ex. Duis sollicitudin vel ex sit amet ultrices.",Innovative Designs,organisation,female,"Senior Software Engineer"
"222 Cherry Ln, Hillcrest","Michael Wilson",US,1973-12-05,"Fusce vulputate odio id arcu posuere, eget lobortis justo hendrerit. Ut eget orci ac risus laoreet vulputate.",Data Solutions,organisation,male,"Data Analyst"
"333 Maple Ave, Woodville","Sarah Martinez",US,1995-06-18,"Aenean malesuada, est at fermentum congue, magna magna fringilla lorem, vitae laoreet tortor neque vel turpis. Morbi eu velit fermentum, ultrices eros id, hendrerit sapien.",Digital Innovations,organisation,female,"UX/UI Designer"
"444 Walnut St, Riverdale","James Jones",US,1982-09-30,"Maecenas interdum tincidunt tincidunt. Phasellus quis libero et metus condimentum malesuada. Nam scelerisque dapibus diam, ut convallis quam tincidunt at.",Tech Solutions,organisation,male,"Software Developer"
"555 Oak St, Forestville","Jennifer Davis",US,1979-04-17,"Sed vestibulum sollicitudin nibh, eget accumsan purus varius nec. Proin volutpat metus sit amet nulla ullamcorper interdum.",Innovative Technologies,organisation,female,"Product Manager"
"666 Cedar Ave, Pineville","Robert Garcia",US,1993-11-22,"Integer efficitur, arcu vel efficitur posuere, justo orci mattis eros, eu posuere magna ex vel lacus.",Future Solutions,organisation,male,"Data Scientist"
"777 Pine St, Springville","Laura Thompson",US,1987-07-08,"Proin nec dui vel ligula laoreet imperdiet. Cras sit amet accumsan arcu. Aliquam erat volutpat. Nulla facilisi.",Tech Innovations,organisation,female,"Senior Developer"
"888 Elm St, Riverwood","Daniel Brown",US,1976-01-14,"Duis hendrerit, turpis id mattis rhoncus, tortor orci lacinia mauris, non ultricies felis velit ac nunc.",Data Solutions,organisation,male,"Software Engineer"
"999 Cedar Ave, Hilltown","Amanda Wilson",US,1991-09-03,"Suspendisse in erat nec purus ullamcorper luctus. Cras lacinia turpis ut nibh elementum, eu venenatis sem fermentum.",Digital Innovations,organisation,female,"Project Manager"
"111 Maple Ave, Parkville","Richard Rodriguez",US,1984-03-28,"Donec faucibus, ligula non vehicula scelerisque, risus mauris interdum turpis, et ultricies odio dolor ut urna.",Global Solutions,organisation,male,"System Administrator"
"222 Walnut St, Lakewood","Jessica Martinez",US,1996-05-12,"Aliquam convallis purus vitae lectus consequat, ac ultrices purus tincidunt. Sed finibus sapien sit amet ante elementum, eu vehicula felis malesuada.",Innovative Designs,organisation,female,"Quality Assurance Analyst"
"333 Elm St, Woodland","Christopher Johnson",US,1977-10-05,"Etiam consequat vestibulum velit, vitae laoreet libero tempor ac. Phasellus sed massa eget velit ullamcorper tristique.",Tech Solutions,organisation,male,"Database Administrator"
"444 Maple Ave, Mountainview","Ashley Smith",US,1994-08-19,"Nam id placerat nulla. Sed nec justo consectetur, gravida neque ut, consequat turpis.",Innovative Technologies,organisation,female,"Network Engineer"
"555 Oak St, Riverside","Matthew Wilson",US,1978-06-24,"Pellentesque in lacus ut ligula convallis luctus eget vel ipsum. Duis ut fermentum turpis, vel fermentum justo.",Future Solutions,organisation,male,"Network Administrator"
"666 Cedar Ave, Hillside","Emily Johnson",US,1992-11-15,"Morbi nec leo nec ipsum maximus varius. Nullam dapibus sodales purus, et laoreet felis egestas ut.",Tech Innovations,organisation,female,"Technical Support Engineer"
"777 Pine St, Springdale","Joshua Garcia",US,1986-04-30,"Nulla facilisi. Nam auctor volutpat odio, vitae suscipit felis scelerisque eu.",Data Solutions,organisation,male,"Business Analyst"

Watchlist Management - Get User Fetcher By Id GET /v1/api/list/get_by_user_fetcher_id/{user_fetcher_id}

Resource URL/v1/api/list/get_by_user_fetcher_id/{user_fetcher_id}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescription
user_fetcher_idThe unique ID of the user fetcher to retrieve.

Example Request

curl -X 'GET' \
'https://lm-gen-1.braegen.ai/v1/api/list/get_by_user_fetcher_id/123' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required
404User Fetcher not found

Example Response

{
	"is_error": false,
	"message": "User Fetcher retrieved successfully",
	"user_fetcher": {
		"display_name": "Sample Fetcher",
		"version": "fetcher-version-20240515",
		"credibility": "high",
		"fetcher": 2,
		"status": "active",
		"client_id": "client_123",
		"is_active": true,
		"create_datetime": "2024-05-15T00:00:00",
		"update_datetime": null
	}
}

Watchlist Management - Get Records GET /v1/api/list/get_records

Resource URL/v1/api/list/get_records
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescription
index_nameThe name of the index to retrieve records from.
client_idClient ID to filter the records.
page_noPage number to retrieve, default is 1.
page_sizeNumber of records per page.
entity_typeOptional entity type filter.

Example Request

curl -X 'GET' \
'https://lm-gen-1.braegen.ai/v1/api/list/get_records?index_name=SampleIndex&client_id=client_123&page_no=1&page_size=10' \
-H 'accept: application/json'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required
404Records not found

Example Response

{
	"is_error": false,
	"message": "Records retrieved successfully",
	"page_no": 1,
	"page_size": 10,
	"total_pages": 3,
	"total": 25,
	"results": [
		{
			"record_id": "12345",
			"index_name": "SampleIndex",
			"client_id": "client_123",
			"entity_type": "type1",
			"data": {
				"field1": "value1",
				"field2": "value2"
			},
			"create_datetime": "2024-05-15T00:00:00",
			"update_datetime": "2024-06-20T00:00:00"
		}
	]
}

Watchlist Management - Update Record POST /v1/api/list/update_record/{record_id}

Resource URL/v1/api/list/update_record/{record_id}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescription
record_idThe unique ID of the record to update.

Request Body

FieldTypeDescription
notestringNote to be added to the record.

Example Request

curl -X 'POST' \
'https://lm-gen-1.braegen.ai/v1/api/list/update_record/12345' \
-H 'accept: application/json' \
-H 'Content-Type: application/json' \
-d '{
    "note": "Updated note for the record"
}'

HTTP Responses

HTTP CodeMessage
200Success
403Authentication Required
404Record not found
400Bad Request

Example Response

{
	"is_error": false,
	"message": "Record updated successfully",
	"record": {
		"record_id": "12345",
		"index_name": "SampleIndex",
		"client_id": "client_123",
		"note": "Updated note for the record",
		"create_datetime": "2024-05-15T00:00:00",
		"update_datetime": "2024-06-25T12:30:00"
	}
}

Watchlist Management - Activate/Deactivate User Fetcher PATCH /v1/api/list/active_deactive_user_fetcher/{user_fetcher_id}/{user_fetcher_status}

Resource URL/v1/api/list/active_deactive_user_fetcher/{user_fetcher_id}/{user_fetcher_status}
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

ParameterDescription
user_fetcher_idID of the user fetcher to activate
user_fetcher_statusBoolean status to set (true/false)

Example Request

curl -X 'PATCH' \
'https://lm-gen-1.braegen.ai/v1/api/list/active_deactive_user_fetcher/1/true' \
-H 'accept: application/json' \
-H 'Authorization: Bearer YOUR_API_KEY'

HTTP Responses

HTTP CodeMessage
200Success
400Bad Request
401Unauthorized
404User Fetcher not found
422Validation Error

Example Response

{
	"is_error": false,
	"message": "User Fetcher status updated successfully",
	"status": true,
	"user_fetcher_id": 1
}

Watchlist Management - Get Graph Data GET /v1/api/list/get_graph_data

Resource URL/v1/api/list/get_graph_data
Response FormatJSON
Requires AuthenticationYes
Rate LimitedYes
HTTPSYes

Parameters

No parameters required for this endpoint

Example Request

curl -X 'GET' \
'https://lm-gen-1.braegen.ai/v1/api/list/get_graph_data' \
-H 'accept: application/json' \
-H 'Authorization: Bearer YOUR_API_KEY'

HTTP Responses

HTTP CodeMessage
200Success
401Unauthorized
403Authentication Required
500Internal Server Error

Example Response

{
	"is_error": false,
	"message": "Graph data retrieved successfully",
	"data": {
		"monthly_stats": [
			{
				"month": "January",
				"total_records": 1200,
				"active_lists": 5
			},
			{
				"month": "February",
				"total_records": 1500,
				"active_lists": 6
			}
		],
		"list_distribution": {
			"remote": 8,
			"local": 4
		},
		"status_summary": {
			"active": 10,
			"inactive": 2
		}
	}
}

Private watchlists in Datafab are customizable lists that serve various purposes for clients, including white lists, black lists, and client databases. These lists can be tailored to specific client needs and can contain information relevant to their screening or monitoring processes.

Datafab offers the flexibility to directly ingest data from internal client data sources, ensuring that clients can seamlessly integrate their existing databases or data streams into the screening process. This direct ingestion capability streamlines the workflow, allowing clients to leverage their internal data efficiently.

Moreover, Datafab provides the functionality to configure scheduling for the ingestion process, allowing clients to set up automated data updates at their preferred intervals. This ensures that their watchlists remain up-to-date with the latest information from their internal data sources.

Overall, Datafab empowers clients to efficiently manage their private watchlists, ensuring that they have access to timely and relevant data for their screening and monitoring activities.

Previous

Fetcher Management

Next

Rule Management

On this page

List OperationsWatchlist Management - Get Lists GET /v1/list/filter_list/{page_number}/{page_size}ParametersExample RequestHTTP ResponsesExample ResponseHTTP ResponsesWatchlist Management - Add Public Watchlist POST /v1/list/add_remoteParametersExample RequestHTTP ResponsesHTTP ResponsesWatchlist Management - Add Private Watchlist POST /v1/list/add_localParametersExample RequestHTTP ResponsesHTTP ResponsesWatchlist Management - Upload Data to Private Fetcher POST /v1list/upload/{user_fetcher_id}ParametersExample RequestHTTP ResponsesExample ResponseSample Csv format for private data fetcher - (manual upload format)Watchlist Management - Get User Fetcher By Id GET /v1/api/list/get_by_user_fetcher_id/{user_fetcher_id}ParametersExample RequestHTTP ResponsesExample ResponseWatchlist Management - Get Records GET /v1/api/list/get_recordsParametersExample RequestHTTP ResponsesExample ResponseWatchlist Management - Update Record POST /v1/api/list/update_record/{record_id}ParametersRequest BodyExample RequestHTTP ResponsesExample ResponseWatchlist Management - Activate/Deactivate User Fetcher PATCH /v1/api/list/active_deactive_user_fetcher/{user_fetcher_id}/{user_fetcher_status}ParametersExample RequestHTTP ResponsesExample ResponseWatchlist Management - Get Graph Data GET /v1/api/list/get_graph_dataParametersExample RequestHTTP ResponsesExample Response