> ## 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.

# Blacklist

> A blacklist record is created with the name of the subject and the reference_id, We check for a whitelist record with the blacklist name before adding to blacklist

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


## OpenAPI

````yaml post /api/blacklist
openapi: 3.0.3
info:
  title: Athena API
  version: v3
  x-logo:
    url: https://cynopsis.co/wp-content/uploads/2021/03/logo-2.png
    altText: Cynopsis Solutions
  description: >-
    ATHENA is an advanced real-time transaction monitoring solution designed to
    detect and prevent money laundering, fraud, and terrorism financing. Powered
    by proprietary AML rules, ATHENA analyzes transactions in real time,
    providing clear, intuitive visual insights to streamline compliance
    processes.
        
        ✅ Real-Time Monitoring – Instantly analyzes transaction data to detect anomalies and potential compliance risks.
        ✅ Visualized Insights – Converts complex data into easy-to-understand charts, aiding faster decision-making.
        ✅ Seamless Integration – Easily integrates with existing financial and compliance systems.
        
        Ideal for financial institutions, fintech companies, and regulated businesses, ATHENA enhances risk management and ensures regulatory compliance with ease.
  contact:
    email: tech@cynopsis.co
servers:
  - url: http://localhost/api
    description: Local development server
security: []
paths:
  /api/blacklist:
    post:
      tags:
        - Blacklist
      summary: Create a Blacklist record
      description: >-
        A blacklist record is created with the name of the subject and the
        reference_id, We check for a whitelist record with the blacklist name
        before adding to blacklist
      operationId: blacklist_create
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                  description: Blacklist name.
                reference_id:
                  type: string
                  description: Reference ID.
                list_name:
                  type: string
                  description: List name.
                  enum:
                    - HIGH RISK
                    - RESTRICTED
              required:
                - name
                - reference_id
                - list_name
      responses:
        '201':
          content:
            application/json:
              schema:
                type: object
                description: Blacklist object
          description: Blacklist record created successfully
        '400':
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
                    description: Error message
                  code:
                    type: string
                    description: Error code (optional)
                  field_errors:
                    type: object
                    additionalProperties:
                      type: array
                      items:
                        type: string
                    description: Field-specific validation errors (optional)
                required:
                  - detail
                description: Standard error response
          description: Invalid request data or subject already in whitelist
      security:
        - CustomAuthentication: []
        - cookieAuth: []
        - BearerAuth: []
components:
  securitySchemes:
    CustomAuthentication:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: JWT token obtained from AWS Cognito or custom authentication service
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid

````