Marble API v1
GET /batch-executions
List batch executions
List scheduled, ongoing and finished batch executions
GET /decisions
List decisions
List decisions according to a filter set. Listing decisions is always time-boxed between the provided `start` and `end` dates. If those parameters are omitted, it defaults to the past 30 days. If the parameters are provided, their range cannot exceed 90 days.
POST /decisions
Create decision
Create a decision by running a trigger object through a scenario
POST /decisions/all
Create all decisions
Create decisions by running a trigger object through all eligible scenarios
GET /decisions/{decisionId}
Get a decision
Retrieve a decision by ID.
GET /decisions/{decisionId}/screenings
Get screening results
Retrieve screening result details for decision
POST /decisions/{decisionId}/snooze
Snooze a rule
Snooze a rule for a pivot value. Snooze a rule for the provided duration, for the pivot value the decision pertains to. The given decision must be part of a case for its rules to be snoozed.
GET /screening/entities/{entityId}
Get an OpenSanctions entity
Retrieve a raw OpenSanctions entity from its ID.
POST /screening/matches/{matchId}
Review a screening match
Set the review status of a screening match
POST /screening/search
Perform a free-form screening search
Search for sanctioned entities outside of the context of a decision.
POST /screening/whitelists
Whitelist an entity
Add a set of search term and entity ID that will not set off a screening alert in the future. This endpoint does not verify that the provided entity ID matches an **actual** entity on an OpenSanctions list. It is the responsibility of the caller to make sure they whitelist the correct entity ID for their needs.
DELETE /screening/whitelists
Remove an entity whitelist
Delete a previously whitelisted entity, a match from the search term to the entity ID will subsequently trigger alerts. If only `entity_id` is provided, all whitelist entries for that entity will be removed, regardless of which counterparty term triggers it.
POST /screening/whitelists/search
Search whitelisted entities
Search for whitelisted entities by OpenSanctions entity ID and/or unique counterparty identifier. At least one of `counterparty` or `entity_id` is required to perform a search.
POST /screening/{screeningId}/refine
Refine a screening result
Replace a screening result with refined results. This endpoint will replace the provided screening result with one containing the result of the included query.
POST /screening/{screeningId}/search
Perform a screening search
Retrieve screening result without persisting them. This endpoint will **not** replace the provided screening result, but allow to preview the results as executed in the original decision's context (using its unique counterparty ID and eligible whitelisted entries).