Skip to main content
POST
/
api
/
blacklist
Create a Blacklist record
curl --request POST \
  --url http://localhost/api/api/blacklist \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "reference_id": "<string>"
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.cynopsis.co/llms.txt

Use this file to discover all available pages before exploring further.

A blacklist can be described in general as a watch list that you may wish to monitor on a tighter scope. To do so, you will need to first register the relevant blacklist record accordingly. Permitted values for: list_name
  • Restricted
  • High Risk

Authorizations

​
Authorization
string
header
required

JWT token obtained from AWS Cognito or custom authentication service

Body

application/json
​
name
string
required

Blacklist name.

​
reference_id
string
required

Reference ID.

​
list_name
enum<string>
required

List name.

Available options:
HIGH RISK,
RESTRICTED

Response

Blacklist record created successfully

Blacklist object