Skip to main content

Accessing Our Postman Collection

  • Updated

The Castellum.AI Postman Collection provides a comprehensive set of pre-configured API requests that allow you to quickly test and integrate with our financial crime screening API. This collection includes example queries for all major endpoints including entity screening, monitoring, list management, and notification services.

You can find the full collection here: https://www.postman.com/castellum-ai/castellum-ai-rest-api/collection/i2tgdxa/rest-api-endpoints

You can find our API documentation here: https://app.swaggerhub.com/apis-docs/castellum.ai/Search/1.0.0#/ 

 

The collection includes example requests for all major API categories:

Informational Endpoints

  • GET /countries - Retrieve available countries
  • GET /entity_types - Get supported entity types
  • GET /list_sources - View available data sources and categories

Entity Screening

  • POST /screen_entity - Single entity screening with various search parameters
  • POST /screen_entities - Batch entity screening for multiple entities

Real-Time Monitoring System

  • Monitors Management:
    • GET /monitoring/monitors - List all monitors
    • POST /monitoring/monitor - Create new monitor
    • PUT /monitoring/monitor/{slug} - Update monitor
    • DELETE /monitoring/monitor/{slug} - Delete monitor
  • Entity Management:
    • GET /monitoring/monitor/{slug}/screen_entities - List entities in a monitor
    • POST /monitoring/monitor/{slug}/screen_entities - Add entities to monitor
    • PUT /monitoring/monitor/{slug}/screen_entity/{id} - Update specific entity
    • DELETE /monitoring/monitor/{slug}/screen_entities/{ids} - Remove entities
  • Hit Management:
    • GET /monitoring/monitor/{slug}/screen_entity/{id}/hits - Get all hits for entity
    • GET /monitoring/monitor/{slug}/screen_entity/{id}/hit/{ref} - Get specific hit details

Notifications

  • Notifier Management:
    • GET /monitoring/notifiers - List all notifiers
    • POST /monitoring/notifier - Create webhook notifier
    • PUT /monitoring/notifier/{slug} - Update notifier
    • DELETE /monitoring/notifier/{slug} - Delete notifier
  • Notification History:
    • GET /monitoring/{slug}/notifications - Query notifications by time range
    • GET /monitoring/{slug}/receipts - Get notification delivery receipts

List Management

  • GET /list_entries/{source} - View entries in a specific watchlist
  • POST /list_entries - Add custom entries to watchlists
  • DELETE /list_entries/{source} - Remove watchlist entries

Related articles