{
    "events": [
        {
            "event": "Case created",
            "organization_id": 1,
            "case_id": 1,
            "case_uuid": "6e182844-727e-4f04-a2a1-e6096baacc1b"
        },
        {
            "event": "Case searched",
            "organization_id": 1,
            "case_id": 1,
            "case_uuid": "6e182844-727e-4f04-a2a1-e6096baacc1b"
        },
        {
            "event": "Case hits found",
            "organization_id": 1,
            "case_id": 1,
            "case_uuid": "6e182844-727e-4f04-a2a1-e6096baacc1b"
        },
        {
            "event": "Case resolved",
            "organization_id": 1,
            "case_id": 1,
            "case_uuid": "6e182844-727e-4f04-a2a1-e6096baacc1b"
        }
    ]
}

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {YOUR_AUTH_KEY}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

You can retrieve your token by visiting your personal settings page and clicking Add API token.

Getting started

Who this guide is for

This guide is intended for developers who wish to integrate Pascal into any onboarding, screening, or monitoring workflow.

Concepts

• Case. In Pascal, a case is the central record used to screen a single entity, whether a person, business, or asset. It contains all associated searches, potential matches (hits), decisions, and monitoring activity.

• Client. In Pascal, a client is a container used to group related cases. It represents an organisation-level view, for example a company that holds several directors and UBOs. Clients can be created, searched, and linked to cases, making it easier to manage relationships between multiple entities.

• Hit. Hit - A hit in Pascal is a potential match against screening categories such as sanctions, PEPs, enforcements, or media. Hits may be unresolved (awaiting review) or resolved (classified as true or false positives). Pascal tracks hit counts per source on each case.

• Unresolved hit. An unresolved hit is a potential match that still requires review, usually by a compliance officer. It indicates that further investigation is needed to determine whether it is relevant. The hits-key-information endpoint provides a compact overview of unresolved hits.

• Resolved hit. A resolved hit is one that has been reviewed and classified as either a true positive (confirmed match) or a false positive (not relevant). Resolved hits remain recorded in the case history for audit purposes.

• Monitoring. Monitoring in Pascal means automatically re-screening a case at defined intervals to detect new or updated hits. Monitoring frequency can be set per data source. Typically, a case status moves from In review during initial screening to Monitored when ongoing checks are required.

• UUID. A UUID (Universal Unique Identifier) is the unique reference Pascal assigns to a case upon creation or import. It is used in API calls for searches, updates, and filtering, ensuring consistent identification across integrations.

Important things to know early

• Everything begins with a Case - In Pascal, nearly all data, including hits, is tied to a case ID. Without a case, attempts to retrieve hits or screening results will not return anything.

• search=true on Update Case - Adding search=true will perform a new search. All unresolved hits are cleared, resolved hits are kept, and both refound and new hits can appear again as unresolved. This is typically used when you want to restart the compliance review cycle.

• Clients vs Cases - why both? - In Pascal, both clients and cases serve distinct but complementary purposes. A client provides the organisation-level view: it groups together all related cases for the same customer, such as a company with its directors and UBOs. Clients also let you link related customers and manage onboarding workflows in a structured way. A case, by contrast, is the detailed record of screening for one entity – person, business, or asset - It contains all associated searches, potential matches (hits), decisions, and monitoring activity.

Example onboarding flow

When no sanctions are found, the onboarding process might look like this:

• Create a Client - e.g. “Acme Corp”.

• Import a case for the entity you want to screen - person, business or asset. Import is asynchronous and returns UUIDs so you can track progress.

• Check search status or fetch key hit info - cases/searches for list views, or cases/{id}/hits-key-information for a concise unresolved view while the reviewer decides.

• Resolve hits in your process - once unresolved items are reviewed, set the case to Monitored and configure monitoring frequencies as needed.

• Re-check later - when you need a new search (apart from monitoring), call Update Case with search=true. This resets the unresolved set for a new cycle without losing previous resolutions.

Example interpretation of "no hits"

A newly created case might return no hits, in which situation onboarding could simply continue. If unresolved hits appear instead, a compliance officer might review them and decide to include true positives (which could block onboarding) or exclude false positives (after which onboarding could proceed).

Quick start

Below is a minimal recipe to see the flow end-to-end.

• Create a Client POST /api/v1/clients - returns the client id.

• Import a case POST /api/v1/cases/import - send up to 200 entities; you get case UUIDs back and can deduplicate or update duplicates.

• Poll for cases or search POST /api/v1/cases/searches - list cases and check source success and hit counts.

• Retrieve unresolved items GET /api/v1/cases/{id}/hits-key-information - show what needs manual review.

• Move to monitoring or re-check PATCH /api/v1/cases/{id} - set status to Monitored and monitoring frequencies; later, use search=true to start a fresh search cycle.

Webhooks

• Pascal expects any 2xx to consider delivery successful. Calls time out after 15 seconds - a 200 after 16 seconds is treated as failed and retried. Up to 10 attempts are made using increasing intervals, then Pascal stops retrying.

• You can subscribe from your organisation settings and you will receive a JSON events array per request.