Pascal API Documentation

Base URL: https://app.pascal.vartion.com

This documentation aims to provide all the information you need to work with our API.

In this API, all datetime values are represented in Coordinated Universal Time (UTC) timezone. This ensures uniformity and accuracy across various time-related operations. Please note that regardless of the user's or system's local timezone, all datetime inputs and outputs are converted to and from UTC for consistent handling of time-related data.

Recent changes

In Pascal 6.2 we replaced the `jurisdiction` field with a `country` field in cases:

The `country` field is an ISO 3166-1 alpha-3 country code string.
The `jurisdiction` field was removed.
These changes apply to the "Import cases", "Search cases", and "Update case" endpoints.

Webhooks

You can configure webhooks in the organization settings -> integrations page. You can also see recent webhook calls and their payloads there.
Our webhooks are sent using the following IP address: 51.105.166.62
Although authenticity is commonly verified using IP addresses, we recommend against this approach. Instead we only send you an 'ID' of a resource (like a case) and you can use our authenticated API to fetch the resource. Our IP address may change in the future, if this happens we will notify you.
In response to Pascal calling your webhook, you only have to return an HTTP status of 2xx. Pascal then knows your system correctly processed the request. In case you return a different status we will keep trying for a few hours. Our webhook calls time out after 15 seconds. Even if you return a 200 HTTP status code after 16 seconds, we mark the request as failed and try again later.

In total we will call your webhook 10 times with an increasing interval. If after the 10th call we still do not get a 2xx status response, we will stop trying. We use the following intervals between attempts while trying to call your webhook:

Attempt	Interval	Time after initial call
1st	-	00:00
2nd	1 minute	00:01
3rd	2 minutes	00:03
4th	4 minutes	00:07
5th	8 minutes	00:15
6th	16 minutes	00:31
7th	29 minutes	01:00
8th	1 hour	02:00
9th	2 hours	04:00
10th	22 hours	26:00

Webhook events

Pascal sends POST requests with `Content-Type: application/json` to your configured URL. The following request body shows an example of all available webhook events that we can send:

{
    "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"
        }
    ]
}

We may or may not send multiple events in one webhook call. The `events` array contains one or more event objects. There is no guarantee that events are sent together or in order. You may use our API to fetch the updated information after receiving a webhook call.

Client errors

Our API returns 4xx status codes when there is something wrong with your request.
Common client errors are:

401 Unauthorized. You are either missing the `Authorization` header or the specified `Authorization` header is incorrect.
403 Forbidden. This usually means that your account is not allowed to access the given resource. Maybe you forgot to add the `OrganizationId` header.
404 Not Found. The resource you are trying to access does not exist.
419 Session Expired. Your session has expired. This can happen if you use a session cookie to authenticate with the API. We recommend you use `API tokens` instead as described under `Authenticating requests`.
422 Unprocessable Entity. Something in the request body is incorrect. Every endpoint has its own validation rules. This error means that the request did not comply with those rules. The response usually contains information about what fields are incorrect.
429 Too Many Requests. Our API has a global rate limit of 1.000 requests per minute per user. This error means that that limit was reached.

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.

Bank Accounts

Import bank accounts

POST

https://app.pascal.vartion.com

/api/v1/bank-accounts/import

requires authentication

Import a list of bank accounts asynchronously. You can provide up to 200 bank accounts per request. The returned id is a batch ID, which you can use to check the progress of the import using the 'Get batch' endpoint.

Note: Access to transaction monitoring is required to use this endpoint.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

bank_accounts

object[]

required

List of bank accounts to import.

name

string

required

Name or identifier for the bank account. Must not be larger than 255.

Example:

Main Business Account

account_number

string

required

Bank account number (IBAN or local format). Must not be larger than 255.

Example:

NL91ABNA0417164300

swift_code

string

SWIFT/BIC code of the bank account. Must not be larger than 255.

Example:

ABNANL2A

bank_name

string

Name of the bank. Must not be larger than 255.

Example:

ABN AMRO Bank N.V.

currency

string

required

The currency code of the bank account.

Example:

EUR

account_type

string

required

Type of bank account (e.g., current, savings, etc.). Must not be larger than 255.

Example:

current

account_creation_date

string

Date when the bank account was created. This field must be a valid date.

Example:

2024-01-15

clients

string[]

A list of client names associated with this account. Must not be larger than 255.

Example:

["Client A"]

client_identifiers

string[]

A list of identifiers of clients associated with this account. If a client with this identifier does not exist, a 422 response will be returned. You should make sure to create the clients first using the 'Create client' or 'Import clients' endpoints. Must not be larger than 255.

Example:

["ID123"]

active

boolean

Can be set to false to deactivate the account (default: true).

Example:

false

batch_id

string

Because each import request is limited to 200 items, you can use this parameter to add more items to an existing batch. If the batch does not exist or is already finished, a 404 response will be returned. This field must be a valid UUID.

Example:

99cbb5f6-49a7-492c-a1de-92ff356d98d8

count

integer

When you want to import using multiple requests in a single batch, you should provide the total number of items to import in your first request (without a batch_id). When a batch has nothing to process, it will remain active for 1 minute, allowing you to add more items to it. When the total number of items has been processed, the batch will be marked as finished. Must not be smaller than 1.

Example:

150

Response Fields

string

The unique identifier of the batch. It can be used to check the status of the import using the 'Get batch' endpoint.

created_at

string

The date and time the batch was created. An ISO 8601 date string.

finished_at

string

The date and time the batch finished. Can be null if it is still processing. An ISO 8601 date string.

Auth

Bearer

Headers

Body

{ "bank_accounts": [ { "name": "Main Business Account", "account_number": "NL91ABNA0417164300", "swift_code": "ABNANL2A", "bank_name": "ABN AMRO Bank N.V.", "currency": "EUR", "account_type": "current", "account_creation_date": "2024-01-15", "clients": [ "Client A" ], "client_identifiers": [ "ID123" ], "active": false } ], "batch_id": "99cbb5f6-49a7-492c-a1de-92ff356d98d8", "count": 150 }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/bank-accounts/import" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"bank_accounts\": [
        {
            \"name\": \"Main Business Account\",
            \"account_number\": \"NL91ABNA0417164300\",
            \"swift_code\": \"ABNANL2A\",
            \"bank_name\": \"ABN AMRO Bank N.V.\",
            \"currency\": \"EUR\",
            \"account_type\": \"current\",
            \"account_creation_date\": \"2024-01-15\",
            \"clients\": [
                \"Client A\"
            ],
            \"client_identifiers\": [
                \"ID123\"
            ],
            \"active\": false
        }
    ],
    \"batch_id\": \"99cbb5f6-49a7-492c-a1de-92ff356d98d8\",
    \"count\": 150
}"

Example response:

{
    "id": "1abd0c71-dadd-4dad-8e20-1bd83aea25b3",
    "created_at": "2024-06-10T12:00:00.000000Z",
    "finished_at": null
}

Batches

Get batch

GET

https://app.pascal.vartion.com

/api/v1/batches/{id}

requires authentication

This endpoint allows you to retrieve the status of a batch. Batches are created when importing cases, clients, transactions, or bank accounts. When a batch is finished (finished_at is not null), all jobs have been processed. This allows you to track the progress of long-running imports. A finished batch is deleted 48 hours after it is finished and can no longer be found. If a batch is not finished after 72 hours, it is also deleted and can no longer be found. You can find the batch ID in the response when starting an import.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

URL Parameters

string

required

The ID of the batch.

Example:

1abd0c71-dadd-4dad-8e20-1bd83aea25b3

Response Fields

string

The unique identifier of the resource.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

finished_at

string

The date and time the resource finished. Can be null if it is still processing. An ISO 8601 date string.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.pascal.vartion.com/api/v1/batches/1abd0c71-dadd-4dad-8e20-1bd83aea25b3" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1"

Example response:

{
    "id": "1abd0c71-dadd-4dad-8e20-1bd83aea25b3",
    "created_at": "2024-06-10T12:00:00.000000Z",
    "finished_at": null
}

Cases

Import cases

POST

https://app.pascal.vartion.com

/api/v1/cases/import

requires authentication

Import and search a list of new cases asynchronously. After making a request, a list of case UUIDs will be returned in the same order as your request. A list of "imported" case UUIDs will also be returned. This allows you to distinguish between cases that were imported and those that were deduplicated. You can use the 'Search cases' endpoint to check the status of the imported cases. The returned id is a batch ID, which you can use to check the progress of the import using the 'Get batch' endpoint.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

cases

object[]

required

An array of cases to be imported. You can import up to 200 cases per request.

type

string

required

Must be one of Person, Business, or Asset.

Example:

Person

status

string

Must be one of: Preview or In review.

Example:

In review

name

string

required

The name to be checked. Must match the regex /[^' ',-\/.]/. Must not be smaller than 2. Must not be larger than 255.

Example:

John Doe

confidence

string

required

The search confidence of the case. "Exact" will only find hits if all fields that are filled in are exact matches, while "Relative" can do partial matches. Must be one of Exact or Relative.

Example:

Relative

aliases

string[]

required

A list of additional name variations to be checked. Must match the regex /[^' ',-\/.]/. Must not be smaller than 2. Must not be larger than 255.

Example:

["J. Doe"]

additional_terms

string[]

A list of words that boost confidence if present in any visible text field. Is case-insensitive. Must not be larger than 255.

Example:

["CEO"]

description

string

Additional information to be displayed in the case.

Example:

Relation of a high risk client

clients

string[]

A list of client names that should be linked to the case. If a client with this name exists, it will be linked. If not, a new client will be created and linked. Must not be larger than 255.

Example:

["['Johns']"]

client_identifiers

string[]

A list of identifiers of clients that should be linked to the created case. If a client with this identifier does not exist, a 422 response will be returned. You should make sure to create the clients first using the 'Create client' or 'Import clients' endpoints. Must not be larger than 255.

Example:

["ID123"]

sources

string[]

If provided, will only enable these sources in the created case. Must be one or more of: sanctions, enforcements, peps, news, other. Sources that are not enabled in the organization will be skipped.

Example:

["sanctions"]

gender

string

[Person case] Must be one of Male or Female. This field is required when cases.0.passportVerificationForm is present.

Example:

Male

nationalities

string[]

required

[Person case] [Asset case] An array of max 10 nationalities. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

country_of_birth

string

[Person case]. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

NLD

country_of_residence

string

[Person case]. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

NLD

date_of_birth

string

[Person case] ISO date string. This field is required when cases.0.passportVerificationForm is present. Must be a valid date in the format Y-m-d.

Example:

2000-01-31

passportVerificationForm

object

[Person case] Optional passport check information to be added to the case.

country

string

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code This field is required when cases.0.passportVerificationForm is present.

Example:

NLD

dateOfExpiry

string

This field is required when cases.0.passportVerificationForm is present. Must be a valid date in the format Y-m-d.

Example:

2025-11-12

documentNumber

string

This field is required when cases.0.passportVerificationForm is present. Must not be smaller than 6. Must not be larger than 9.

Example:

bngzmiy

givenNames

string

This field is required when cases.0.passportVerificationForm is present. Must not be larger than 255.

Example:

lastName

string

This field is required when cases.0.passportVerificationForm is present. Must not be larger than 255.

Example:

nationality

string

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code This field is required when cases.0.passportVerificationForm is present.

Example:

NLD

optionalData

string

Must not be larger than 14.

Example:

ljnikhwaykcmyu

company_number

string

[Business case]. Must not be larger than 255.

Example:

NL123

country

string

[Business case]. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

NLD

address

string

[Business case]. Must not be larger than 255.

Example:

3721 West Fork Street, Montana

asset_type

string

[Asset case] Must be one of vessel or aircraft.

Example:

vessel

identifier

string

[Asset case]. Must not be larger than 255.

Example:

123456

user_id

integer

The assignee of the case. If both this and group_id are missing, the case is assigned to the default assignee specified in the organisation policies. If either is provided but neither specifies an id, the case is unassigned.

group_id

integer

The assigned group of the case. If both this and user_id are missing, the case is assigned to the default assignee specified in the organisation policies. If either is provided but neither specifies an id, the case is unassigned.

deduplicate

boolean

Whether or not to skip any cases that already exist in the organisation. A case is considered a duplicate if all of the following fields are an exact match (case insensitive): name, aliases, additional_terms, gender, date_of_birth, nationalities, country_of_birth, country_of_residence, address, country, company_number, asset_type, and identifier.

Example:

false

update_duplicates

boolean

When a duplicate case is found, perform a new search. If the existing case is 'archived', its status will be changed to 'in review'. Search is skipped if the case is already monitored.

Example:

false

update_duplicates_clients

boolean

If a case with the same name already exists, its client(s) will be updated with the provided information.

Example:

false

batch_id

string

Example:

99cbb5f6-49a7-492c-a1de-92ff356d98d8

count

integer

Example:

150

Response Fields

string

The unique identifier of the batch. It can be used to check the status of the import using the 'Get batch' endpoint.

created_at

string

The date and time the batch was created. An ISO 8601 date string.

finished_at

string

The date and time the batch finished. Can be null if it is still processing. An ISO 8601 date string.

uuids

string[]

The list of case UUIDs in the same order as the request.

imported

string[]

The list of imported case UUIDs. This allows for distinguishing between cases that were imported and those that were deduplicated.

Auth

Bearer

Headers

Body

{ "cases": [ { "type": "Person", "status": "In review", "name": "John Doe", "confidence": "Relative", "aliases": [ "J. Doe" ], "additional_terms": [ "CEO" ], "description": "Relation of a high risk client", "clients": [ "['Johns']" ], "client_identifiers": [ "ID123" ], "sources": [ "sanctions" ], "gender": "Male", "nationalities": [ "NLD" ], "country_of_birth": "NLD", "country_of_residence": "NLD", "date_of_birth": "2000-01-31", "passportVerificationForm": { "country": "NLD", "dateOfExpiry": "2025-11-12", "documentNumber": "bngzmiy", "givenNames": "v", "lastName": "d", "nationality": "NLD", "optionalData": "ljnikhwaykcmyu" }, "company_number": "NL123", "country": "NLD", "address": "3721 West Fork Street, Montana", "asset_type": "vessel", "identifier": "123456", "user_id": null, "group_id": null } ], "deduplicate": false, "update_duplicates": false, "update_duplicates_clients": false, "batch_id": "99cbb5f6-49a7-492c-a1de-92ff356d98d8", "count": 150 }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/cases/import" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"cases\": [
        {
            \"type\": \"Person\",
            \"status\": \"In review\",
            \"name\": \"John Doe\",
            \"confidence\": \"Relative\",
            \"aliases\": [
                \"J. Doe\"
            ],
            \"additional_terms\": [
                \"CEO\"
            ],
            \"description\": \"Relation of a high risk client\",
            \"clients\": [
                \"[\'Johns\']\"
            ],
            \"client_identifiers\": [
                \"ID123\"
            ],
            \"sources\": [
                \"sanctions\"
            ],
            \"gender\": \"Male\",
            \"nationalities\": [
                \"NLD\"
            ],
            \"country_of_birth\": \"NLD\",
            \"country_of_residence\": \"NLD\",
            \"date_of_birth\": \"2000-01-31\",
            \"passportVerificationForm\": {
                \"country\": \"NLD\",
                \"dateOfExpiry\": \"2025-11-12\",
                \"documentNumber\": \"bngzmiy\",
                \"givenNames\": \"v\",
                \"lastName\": \"d\",
                \"nationality\": \"NLD\",
                \"optionalData\": \"ljnikhwaykcmyu\"
            },
            \"company_number\": \"NL123\",
            \"country\": \"NLD\",
            \"address\": \"3721 West Fork Street, Montana\",
            \"asset_type\": \"vessel\",
            \"identifier\": \"123456\"
        }
    ],
    \"deduplicate\": false,
    \"update_duplicates\": false,
    \"update_duplicates_clients\": false,
    \"batch_id\": \"99cbb5f6-49a7-492c-a1de-92ff356d98d8\",
    \"count\": 150
}"

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.pascal.vartion.com/api/v1/cases/import',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'OrganizationId' => 1,
        ],
        'json' => [
            'cases' => [
                [
                    'type' => 'Person',
                    'status' => 'In review',
                    'name' => 'John Doe',
                    'confidence' => 'Relative',
                    'aliases' => [
                        'J. Doe',
                    ],
                    'additional_terms' => [
                        'CEO',
                    ],
                    'description' => 'Relation of a high risk client',
                    'clients' => [
                        '[\'Johns\']',
                    ],
                    'client_identifiers' => [
                        'ID123',
                    ],
                    'sources' => [
                        'sanctions',
                    ],
                    'gender' => 'Male',
                    'nationalities' => [
                        'NLD',
                    ],
                    'country_of_birth' => 'NLD',
                    'country_of_residence' => 'NLD',
                    'date_of_birth' => '2000-01-31',
                    'passportVerificationForm' => [
                        'country' => 'NLD',
                        'dateOfExpiry' => '2025-11-12',
                        'documentNumber' => 'bngzmiy',
                        'givenNames' => 'v',
                        'lastName' => 'd',
                        'nationality' => 'NLD',
                        'optionalData' => 'ljnikhwaykcmyu',
                    ],
                    'company_number' => 'NL123',
                    'country' => 'NLD',
                    'address' => '3721 West Fork Street, Montana',
                    'asset_type' => 'vessel',
                    'identifier' => '123456',
                ],
            ],
            'deduplicate' => false,
            'update_duplicates' => false,
            'update_duplicates_clients' => false,
            'batch_id' => '99cbb5f6-49a7-492c-a1de-92ff356d98d8',
            'count' => 150,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://app.pascal.vartion.com/api/v1/cases/import'
payload = {
    "cases": [
        {
            "type": "Person",
            "status": "In review",
            "name": "John Doe",
            "confidence": "Relative",
            "aliases": [
                "J. Doe"
            ],
            "additional_terms": [
                "CEO"
            ],
            "description": "Relation of a high risk client",
            "clients": [
                "['Johns']"
            ],
            "client_identifiers": [
                "ID123"
            ],
            "sources": [
                "sanctions"
            ],
            "gender": "Male",
            "nationalities": [
                "NLD"
            ],
            "country_of_birth": "NLD",
            "country_of_residence": "NLD",
            "date_of_birth": "2000-01-31",
            "passportVerificationForm": {
                "country": "NLD",
                "dateOfExpiry": "2025-11-12",
                "documentNumber": "bngzmiy",
                "givenNames": "v",
                "lastName": "d",
                "nationality": "NLD",
                "optionalData": "ljnikhwaykcmyu"
            },
            "company_number": "NL123",
            "country": "NLD",
            "address": "3721 West Fork Street, Montana",
            "asset_type": "vessel",
            "identifier": "123456"
        }
    ],
    "deduplicate": false,
    "update_duplicates": false,
    "update_duplicates_clients": false,
    "batch_id": "99cbb5f6-49a7-492c-a1de-92ff356d98d8",
    "count": 150
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'OrganizationId': '1'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

const url = new URL(
    "https://app.pascal.vartion.com/api/v1/cases/import"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "OrganizationId": "1",
};

let body = {
    "cases": [
        {
            "type": "Person",
            "status": "In review",
            "name": "John Doe",
            "confidence": "Relative",
            "aliases": [
                "J. Doe"
            ],
            "additional_terms": [
                "CEO"
            ],
            "description": "Relation of a high risk client",
            "clients": [
                "['Johns']"
            ],
            "client_identifiers": [
                "ID123"
            ],
            "sources": [
                "sanctions"
            ],
            "gender": "Male",
            "nationalities": [
                "NLD"
            ],
            "country_of_birth": "NLD",
            "country_of_residence": "NLD",
            "date_of_birth": "2000-01-31",
            "passportVerificationForm": {
                "country": "NLD",
                "dateOfExpiry": "2025-11-12",
                "documentNumber": "bngzmiy",
                "givenNames": "v",
                "lastName": "d",
                "nationality": "NLD",
                "optionalData": "ljnikhwaykcmyu"
            },
            "company_number": "NL123",
            "country": "NLD",
            "address": "3721 West Fork Street, Montana",
            "asset_type": "vessel",
            "identifier": "123456"
        }
    ],
    "deduplicate": false,
    "update_duplicates": false,
    "update_duplicates_clients": false,
    "batch_id": "99cbb5f6-49a7-492c-a1de-92ff356d98d8",
    "count": 150
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response:

{
    "id": "1abd0c71-dadd-4dad-8e20-1bd83aea25b3",
    "created_at": "2024-06-10T12:00:00.000000Z",
    "finished_at": null,
    "uuids": [
        "a2546955-de2d-4907-a533-0846ee46f719",
        "d6253422-5197-429c-a8eb-4af7f6f7fffc",
        "052c7db6-bdca-4b95-b872-363b4287200f"
    ],
    "imported": [
        "a2546955-de2d-4907-a533-0846ee46f719"
    ]
}

Create and search case

POST

https://app.pascal.vartion.com

/api/v1/cases

requires authentication

Create and search a single case synchronously, returning results immediately. Case deduplication is optional - when enabled, the first matching case will be searched for changes and returned instead of creating duplicates.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

type

string

required

Must be one of Person, Business, or Asset.

Example:

Person

status

string

Must be one of: Preview or In review. Defaults to In review if not provided..

Example:

In review

name

string

required

The name to be checked. Must match the regex /[^' ',-\/.]/. Must not be smaller than 2. Must not be larger than 255.

Example:

John Doe

aliases

string[]

required

A list of additional name variations to be checked. Must match the regex /[^' ',-\/.]/. Must not be smaller than 2. Must not be larger than 255.

Example:

["J. Doe"]

confidence

string

The search confidence of the case. "Exact" will only find hits if all fields that are filled in are exact matches, while "Relative" can do partial matches. Must be one of Exact or Relative. Defaults to Relative if not provided..

Example:

Relative

additional_terms

string[]

A list of words that boost confidence if present in any visible text field. Is case-insensitive. Must not be larger than 255.

Example:

["CEO"]

client_ids

integer[]

required

A list of client IDs to link to this case. Must not be smaller than 1.

Example:

[1]

sources

string[]

If provided, will only enable these sources in the created case. Must be one or more of: sanctions, enforcements, peps, news, other. Defaults to organization's policy Default case sources if not provided..

deduplicate

boolean

When true, checks for existing cases with matching details. If found, returns and re-searches the existing case instead of creating a duplicate. If multiple duplicates are found, the most recent case is used and Monitored or In review cases are prioritized.
Note: Deduplication cannot be used when requesting a Preview case.

Example:

false

allow_duplicate_conversion

boolean

When true, allows automatic conversion of duplicate cases in Preview or Archived status to searchable statuses (In review or the status specified in the request). When false or not provided, an error will be thrown if a duplicate is found in Preview or Archived status, requiring the calling application to handle the status update or retry without deduplication. Only relevant when deduplicate is true.

Example:

false

gender

string

[Person case] Must be one of Male or Female.

Example:

Male

nationalities

string[]

required

[Person case] array of max 10 nationalities, nationality ISO 3166-1 alpha-2 or alpha-3 country code string. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

country_of_birth

string

[Person case] ISO 3166-1 alpha-2 or alpha-3 country code string. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

NLD

country_of_residence

string

[Person case] ISO 3166-1 alpha-2 or alpha-3 country code string. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

NLD

date_of_birth

string

[Person case] ISO date string. Must be a valid date in the format Y-m-d.

Example:

2000-01-31

company_number

string

[Business case] string of max 255 characters. Must not be larger than 255.

Example:

NL123

country

string

[Business case] ISO 3166-1 alpha-2 or alpha-3 country code string. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

address

string

[Business case] string of max 255 characters. Must not be larger than 255.

Example:

3721 West Fork Street, Montana

asset_type

string

[Asset case] Must be one of vessel or aircraft.

Example:

vessel

identifier

string

[Asset case] string of max 255 characters. Must not be larger than 255.

Example:

123456

Response Fields

additional_terms

null|string[]

A list of words that boost confidence of hits if present in any visible text field.

address

null|string

[Business case] The address of the resource.

asset_type

null|string

[Asset case] The type of asset the resource is. Possible values: "vessel", "aircraft".

clients

object[]

The clients associated with the resource.

company_number

null|string

[Business case] The company number of the resource.

Example:

NL123

confidence

string

The confidence level of the resource. Possible values: "Relative", "Exact"

country_of_birth

null|string

[Person case] The country of birth of the resource. ISO 3166-1 alpha-3 country code string.

country_of_residence

null|string

[Person case] The country of residence of the resource. ISO 3166-1 alpha-3 country code string.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

date_of_birth

null|string

[Person case] The date of birth of the resource, in YYYY-MM-DD format.

deleted_at

null|string

The date and time the resource was deleted. An ISO 8601 date string.

description

null|string

Additional information displayed in the resource.

excluded_terms

null|string[]

gender

null|string

[Person case] The gender of the resource. Possible values: "Female", "Male"

group_id

integer

The group linked to the resource.If both this and user_id are missing, the resource is unassigned.

hits_unresolved_count

integer

The number of unresolved hits for the resource. Only present when requested by passing hitCounts to the with parameter.

integer

A globally unique identifier of the resource.

identifier

null|string

[Asset case] The identifier of the resource, such as the registration number of a vessel or aircraft.

country

null|string

[Business case] The country of the resource. ISO 3166-1 alpha-3 country code string.

monitoring_frequency_sanctions

null|integer

The monitoring frequency of Sanctions for the resource, in days.

monitoring_frequency_peps

null|integer

The monitoring frequency of PEPs for the resource, in days.

monitoring_frequency_news

null|integer

The monitoring frequency of Media for the resource, in days.

monitoring_frequency_enforcements

null|integer

The monitoring frequency of Enforcements for the resource, in days.

monitoring_frequency_other

null|integer

The monitoring frequency of Other sources for the resource, in days.

name

string

The name of the resource.

nationalities

null|string

[Person case] [Asset case] The nationalities of the resource. ISO 3166-1 alpha-3 country code string.

origin

string

The origin of the resource. Possible values: "person-check", "business-check", "hyperlink", "import", "public-api"

organization_id

integer

The globally unique identifier of the organisation that owns the resource.

risk

null|float

The risk score of the resource. Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high).

searched_at

null|string

The date and time the resource was most recently searched. An ISO 8601 date string.

sources

object[]

The sources used by the resource.

active

boolean

Whether the source is active.

case_id

integer

The ID of the case the source belongs to.

data_source

object

The data source details.

data_source_id

integer

The ID of the data source.

integer

The ID of the source

searched_at

null|string

The date and time the source was most recently searched. An ISO 8601 date string.

succeeded

boolean

Whether the last search attempt succeeded.

status

string

The status of the resource. Possible values: "In Review", "Monitored", "Preview"

unresolved_risk

null|float

The risk score of the unresolved hits for the resource. Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high).

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

user_id

integer

The user linked to the resource.If both this and group_id are missing, the resource is unassigned.

uuid

string

A universally unique identifier of the resource.

Auth

Bearer

Headers

Body

{ "type": "Person", "status": "In review", "name": "John Doe", "aliases": [ "J. Doe" ], "confidence": "Relative", "additional_terms": [ "CEO" ], "client_ids": [ 1 ], "sources": null, "deduplicate": false, "allow_duplicate_conversion": false, "gender": "Male", "nationalities": [ "NLD" ], "country_of_birth": "NLD", "country_of_residence": "NLD", "date_of_birth": "2000-01-31", "company_number": "NL123", "country": "NL", "address": "3721 West Fork Street, Montana", "asset_type": "vessel", "identifier": "123456" }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/cases" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"type\": \"Person\",
    \"status\": \"In review\",
    \"name\": \"John Doe\",
    \"aliases\": [
        \"J. Doe\"
    ],
    \"confidence\": \"Relative\",
    \"additional_terms\": [
        \"CEO\"
    ],
    \"client_ids\": [
        1
    ],
    \"deduplicate\": false,
    \"allow_duplicate_conversion\": false,
    \"gender\": \"Male\",
    \"nationalities\": [
        \"NLD\"
    ],
    \"country_of_birth\": \"NLD\",
    \"country_of_residence\": \"NLD\",
    \"date_of_birth\": \"2000-01-31\",
    \"company_number\": \"NL123\",
    \"country\": \"NL\",
    \"address\": \"3721 West Fork Street, Montana\",
    \"asset_type\": \"vessel\",
    \"identifier\": \"123456\"
}"

Example response:

{
    "additional_terms": [
        "CEO"
    ],
    "address": "3721 West Fork Street, Montana",
    "aliases": [
        "J. Doe"
    ],
    "asset_type": null,
    "clients": [
        {
            "name": "John Doe",
            "id": 1
        }
    ],
    "company_number": null,
    "confidence": "Relative",
    "country": null,
    "country_of_birth": "NLD",
    "country_of_residence": "NLD",
    "created_at": "2023-08-02T18:48:22.000000Z",
    "date_of_birth": null,
    "deleted_at": null,
    "description": "Relation of a high risk client",
    "excluded_terms": [],
    "gender": null,
    "group_id": null,
    "id": 2049050,
    "identifier": null,
    "monitoring_frequency_sanctions": 90,
    "monitoring_frequency_peps": 90,
    "monitoring_frequency_news": 90,
    "monitoring_frequency_enforcements": 90,
    "monitoring_frequency_other": 90,
    "name": "My test case",
    "nationalities": null,
    "organization_id": 19,
    "origin": "public-api",
    "risk": 0.12,
    "searched_at": "2023-08-02T18:48:32.000000Z",
    "hits_unresolved_count": 0,
    "resolve_progress": 100,
    "hit_counts": {
        "negative": {
            "enforcements": 0,
            "news": 0,
            "other": 0,
            "peps": 0,
            "sanctions": 0
        },
        "positive": {
            "enforcements": 0,
            "news": 0,
            "other": 0,
            "peps": 0,
            "sanctions": 0
        },
        "unresolved": {
            "enforcements": 0,
            "news": 0,
            "other": 0,
            "peps": 0,
            "sanctions": 0
        }
    },
    "sources": [
        {
            "active": true,
            "case_id": 2049050,
            "data_source": {
                "active": true,
                "deactivated_at": "2023-02-21T12:57:31.000000Z",
                "id": 409,
                "source": "peps",
                "vendor": "default"
            },
            "data_source_id": 409,
            "id": 18320030,
            "searched_at": "2023-08-02T18:48:22.000000Z",
            "succeeded": true
        },
        {
            "active": true,
            "case_id": 2049050,
            "data_source": {
                "active": true,
                "deactivated_at": "2023-02-21T12:57:31.000000Z",
                "id": 413,
                "source": "news",
                "vendor": "default"
            },
            "data_source_id": 413,
            "id": 18320031,
            "searched_at": "2023-08-02T18:48:22.000000Z",
            "succeeded": true
        }
    ],
    "status": "Monitored",
    "type": "Person",
    "unresolved_risk": 0,
    "updated_at": "2023-08-02T18:48:22.000000Z",
    "user_id": null,
    "uuid": "a2546955-de2d-4907-a533-0846ee46f719"
}

{
    "additional_terms": [
        "CEO"
    ],
    "address": "3721 West Fork Street, Montana",
    "aliases": [
        "J. Doe"
    ],
    "asset_type": null,
    "clients": [
        {
            "name": "John Doe",
            "id": 1
        }
    ],
    "company_number": null,
    "confidence": "Relative",
    "country": null,
    "country_of_birth": "NLD",
    "country_of_residence": "NLD",
    "created_at": "2023-08-02T18:48:22.000000Z",
    "date_of_birth": null,
    "deleted_at": null,
    "description": "Relation of a high risk client",
    "excluded_terms": [],
    "gender": null,
    "group_id": null,
    "id": 2049050,
    "identifier": null,
    "monitoring_frequency_sanctions": 90,
    "monitoring_frequency_peps": 90,
    "monitoring_frequency_news": 90,
    "monitoring_frequency_enforcements": 90,
    "monitoring_frequency_other": 90,
    "name": "My test case",
    "nationalities": null,
    "organization_id": 19,
    "origin": "public-api",
    "risk": 0.12,
    "searched_at": "2023-08-02T18:48:32.000000Z",
    "hits_unresolved_count": 0,
    "resolve_progress": 100,
    "hit_counts": {
        "negative": {
            "enforcements": 0,
            "news": 0,
            "other": 0,
            "peps": 0,
            "sanctions": 0
        },
        "positive": {
            "enforcements": 0,
            "news": 0,
            "other": 0,
            "peps": 0,
            "sanctions": 0
        },
        "unresolved": {
            "enforcements": 0,
            "news": 0,
            "other": 0,
            "peps": 0,
            "sanctions": 0
        }
    },
    "sources": [
        {
            "active": true,
            "case_id": 2049050,
            "data_source": {
                "active": true,
                "deactivated_at": "2023-02-21T12:57:31.000000Z",
                "id": 409,
                "source": "peps",
                "vendor": "default"
            },
            "data_source_id": 409,
            "id": 18320030,
            "searched_at": "2023-08-02T18:48:22.000000Z",
            "succeeded": true
        },
        {
            "active": true,
            "case_id": 2049050,
            "data_source": {
                "active": true,
                "deactivated_at": "2023-02-21T12:57:31.000000Z",
                "id": 413,
                "source": "news",
                "vendor": "default"
            },
            "data_source_id": 413,
            "id": 18320031,
            "searched_at": "2023-08-02T18:48:22.000000Z",
            "succeeded": true
        }
    ],
    "status": "Monitored",
    "type": "Person",
    "unresolved_risk": 0,
    "updated_at": "2023-08-02T18:48:22.000000Z",
    "user_id": null,
    "uuid": "a2546955-de2d-4907-a533-0846ee46f719"
}

List cases

POST

https://app.pascal.vartion.com

/api/v1/cases/searches

requires authentication

Search for cases using filters. Returning basic information on a list of cases. Paginating through results is possible using the per_page and page parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

per_page

integer

Number of results per page. Must not be smaller than 1. Must not be larger than 1000.

Example:

page

integer

Page to be returned. Must not be smaller than 1.

Example:

sort_by

string

Field to sort the results by. Can be one of updated_at, status, uuid, name, type, confidence, risk, unresolved_risk, searched_at. Defaults to updated_at.

Example:

updated_at

sort_order

string

The sorting order for the results. Can be one of asc or desc. Defaults to desc.

Example:

desc

secondary_sort_by

string

Field to use as secondary sort for the results when the primary sort field values are equal. Can be one of updated_at, status, uuid, name, type, confidence, risk, unresolved_risk, searched_at. Defaults to updated_at.

Example:

uuid

secondary_sort_order

string

The sorting order for the results. Can be one of asc or desc. Defaults to desc.

Example:

desc

with

string[]

required

Adds additional values to the results. Must be one of: hitCounts, hitCountsPerSource.

Example:

["hitCountsPerSource"]

integer[]

Case IDs to be filtered on. Must not be smaller than 1.

type

string[]

Must be one of Person, Business, or Asset.

status

string[]

user_id

integer[]

Filter on case assignees using user ids. Use null for unassigned cases.

Example:

[1]

group_id

integer[]

Filter on case assignees using group ids.

Example:

[1]

organization_id

integer[]

Filter on cases from a specific organization (if token has access to multiple organizations).

origin

string[]

confidence

string[]

created_at

object

A date range, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

updated_at

object

A date range, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

name

string

Search on case names. Supports SQL LIKE wildcards. Must not be larger than 255.

client_id

integer[]

Cases associated to a list of clients. Must not be smaller than 1.

exclude_client_id

integer[]

Exclude cases associated to any of a list of clients. Must not be smaller than 1.

deleted

boolean

Example:

false

uuid

string[]

Search on case UUIDs. Supports SQL LIKE wildcards. This field must be a valid UUID.

Example:

["a2546955-de2d-4907-a533-0846ee46f719"]

query

string

Must not be larger than 255.

nationalities

string[]

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

country_of_birth

string[]

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

country_of_residence

string[]

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

date_of_birth

string[]

This field must be a valid date.

company_number

string

Must not be larger than 255.

Example:

address

string

Must not be larger than 255.

Example:

country

string[]

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

identifier

string[]

The identifier of an asset. Must not be larger than 255.

risk

string[]

hit_resolution

string[]

required

Filter on the resolution status of hits associated to the case.

Example:

["positive"]

hit_source

string[]

required

Filter on the source of hits associated to the case.

hit_time_range

object

A date range for the associated hits, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

client_status

string[]

required

Filter on the status of associated clients.

Example:

["Active"]

clients

object

cases_count

integer[]

Filter on the number of cases in associated clients by defining a minimum and/or maximum. Must not be smaller than 0.

Example:

[1]

clients_count

integer[]

Filter on the number of clients in associated clients by defining a minimum and/or maximum. Must not be smaller than 0.

Example:

[1]

created_at

object

A date range for the creation date of associated clients, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

risk

string[]

Filter on the screening risk of associated clients.

Example:

["very high"]

updated_at

object

A date range for the update date of associated clients, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

identifier

string[]

Filter on the identifier of associated clients. Must not be larger than 255.

Example:

["ID123"]

Response Fields

data

object[]

The list of resources.

additional_terms

null|string[]

A list of words that boost confidence of hits if present in any visible text field.

address

null|string

[Business case] The address of the resource.

asset_type

null|string

[Asset case] The type of asset of the resource. Possible values: "vessel", "aircraft".

clients

object[]

The clients associated with the resource.

company_number

null|string

[Business case] The company number of the resource.

Example:

NL123

confidence

string

The search confidence of the resource. "Exact" will only find hits if all fields that are filled in are exact matches, while "Relative" can do partial matches. Possible values: "Relative", "Exact"

country_of_birth

null|string

[Person case] The country of birth of the resource. ISO 3166-1 alpha-3 country code string.

country_of_residence

null|string

[Person case] The country of residence of the resource. ISO 3166-1 alpha-3 country code string.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

date_of_birth

null|string

[Person case] The date of birth of the resource, in YYYY-MM-DD format.

deleted_at

null|string

The date and time the resource was deleted. An ISO 8601 date string.

description

null|string

The description of the resource.

excluded_terms

null|string[]

A list of terms that should not be matched on when searching for new hits in this case.

gender

null|string

[Person case] The gender of the resource. Possible values: "Female", "Male"

group_id

integer

The group linked to the resource.If both this and user_id are missing, the resource is unassigned.

hit_counts

object

An object containing the hit counts for the resource, grouped by resolution. Only present when requested by passing hitCountsPerSource to the with parameter.

integer

A globally unique identifier of the resource.

identifier

null|string

[Asset case] The identifier of the asset, such as the registration number of a vessel or aircraft.

country

null|string

[Business case] The country of the resource. ISO 3166-1 alpha-3 country code string.

monitoring_frequency_sanctions

null|integer

The monitoring frequency of the Sanctions source of the resource, in days.

monitoring_frequency_peps

null|integer

The monitoring frequency of the PEPs source of the resource, in days.

monitoring_frequency_news

null|integer

The monitoring frequency of the Media source of the resource, in days.

monitoring_frequency_enforcements

null|integer

The monitoring frequency of Enforcements for the resource, in days.

monitoring_frequency_other

null|integer

The monitoring frequency of Other sources for the resource, in days.

name

string

The name of the resource.

nationalities

null|string

[Person case] [Asset case] The nationalities of the resource. ISO 3166-1 alpha-3 country code string.

origin

string

The origin of the resource. Possible values: "person-check", "business-check", "hyperlink", "import", "public-api"

organization_id

integer

The globally unique identifier of the organisation that owns the resource.

risk

null|float

The risk score of the resource. Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high).

searched_at

null|string

The date and time the resource was most recently searched. An ISO 8601 date string.

sources

object[]

The sources used by the resource.

active

boolean

Whether the source is active. An inactive source cannot be searched on.

case_id

integer

The ID of the case the source belongs to.

data_source

object

The data source details.

data_source_id

integer

The ID of the data source.

integer

The ID of the source

searched_at

null|string

The date and time the source was most recently searched. An ISO 8601 date string.

succeeded

boolean

Whether the last search attempt succeeded.

status

string

The status of the resource. Possible values: "In Review", "Monitored", "Archived", "Preview"

unresolved_risk

null|float

The risk score of the unresolved hits for the resource. Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high).

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

user_id

integer

The user linked to the resource.If both this and group_id are missing, the resource is unassigned.

uuid

string

A universally unique identifier of the resource.

hits_unresolved_count

integer

The number of unresolved hits for the resource. Only present when requested by passing hitCounts to the with parameter.

resolve_progress

integer

The percentage of hits that have been resolved for the resource. Only present when requested by passing hitCounts to the with parameter.

meta

object

Pagination information.

Example:

{"current_page":1,"from":1,"last_page":10,"per_page":15,"to":15,"total":150}

Auth

Bearer

Headers

Body

{ "per_page": 10, "page": 1, "sort_by": "updated_at", "sort_order": "desc", "secondary_sort_by": "uuid", "secondary_sort_order": "desc", "with": [ "hitCountsPerSource" ], "id": null, "type": null, "status": null, "user_id": [ 1 ], "group_id": [ 1 ], "organization_id": null, "origin": null, "confidence": null, "created_at": [ "2025-01-01", "2025-01-31" ], "updated_at": [ "2025-01-01", "2025-01-31" ], "name": null, "client_id": null, "exclude_client_id": null, "deleted": false, "uuid": [ "a2546955-de2d-4907-a533-0846ee46f719" ], "query": null, "nationalities": [ "NLD" ], "country_of_birth": [ "NLD" ], "country_of_residence": [ "NLD" ], "date_of_birth": null, "company_number": "b", "address": "n", "country": [ "NLD" ], "identifier": null, "risk": null, "hit_resolution": [ "positive" ], "hit_source": null, "hit_time_range": [ "2025-01-01", "2025-01-31" ], "client_status": [ "Active" ], "clients": { "cases_count": [ 1 ], "clients_count": [ 1 ], "created_at": [ "2025-01-01", "2025-01-31" ], "risk": [ "very high" ], "updated_at": [ "2025-01-01", "2025-01-31" ], "identifier": [ "ID123" ] } }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/cases/searches" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"per_page\": 10,
    \"page\": 1,
    \"sort_by\": \"updated_at\",
    \"sort_order\": \"desc\",
    \"secondary_sort_by\": \"uuid\",
    \"secondary_sort_order\": \"desc\",
    \"with\": [
        \"hitCountsPerSource\"
    ],
    \"user_id\": [
        1
    ],
    \"group_id\": [
        1
    ],
    \"created_at\": [
        \"2025-01-01\",
        \"2025-01-31\"
    ],
    \"updated_at\": [
        \"2025-01-01\",
        \"2025-01-31\"
    ],
    \"deleted\": false,
    \"uuid\": [
        \"a2546955-de2d-4907-a533-0846ee46f719\"
    ],
    \"nationalities\": [
        \"NLD\"
    ],
    \"country_of_birth\": [
        \"NLD\"
    ],
    \"country_of_residence\": [
        \"NLD\"
    ],
    \"company_number\": \"b\",
    \"address\": \"n\",
    \"country\": [
        \"NLD\"
    ],
    \"hit_resolution\": [
        \"positive\"
    ],
    \"hit_source\": null,
    \"hit_time_range\": [
        \"2025-01-01\",
        \"2025-01-31\"
    ],
    \"client_status\": [
        \"Active\"
    ],
    \"clients\": {
        \"cases_count\": [
            1
        ],
        \"clients_count\": [
            1
        ],
        \"created_at\": [
            \"2025-01-01\",
            \"2025-01-31\"
        ],
        \"risk\": [
            \"very high\"
        ],
        \"updated_at\": [
            \"2025-01-01\",
            \"2025-01-31\"
        ],
        \"identifier\": [
            \"ID123\"
        ]
    }
}"

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.pascal.vartion.com/api/v1/cases/searches',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'OrganizationId' => 1,
        ],
        'json' => [
            'per_page' => 10,
            'page' => 1,
            'sort_by' => 'updated_at',
            'sort_order' => 'desc',
            'secondary_sort_by' => 'uuid',
            'secondary_sort_order' => 'desc',
            'with' => [
                'hitCountsPerSource',
            ],
            'user_id' => [
                1,
            ],
            'group_id' => [
                1,
            ],
            'created_at' => [
                '2025-01-01',
                '2025-01-31',
            ],
            'updated_at' => [
                '2025-01-01',
                '2025-01-31',
            ],
            'deleted' => false,
            'uuid' => [
                'a2546955-de2d-4907-a533-0846ee46f719',
            ],
            'nationalities' => [
                'NLD',
            ],
            'country_of_birth' => [
                'NLD',
            ],
            'country_of_residence' => [
                'NLD',
            ],
            'company_number' => 'b',
            'address' => 'n',
            'country' => [
                'NLD',
            ],
            'hit_resolution' => [
                'positive',
            ],
            'hit_source' => null,
            'hit_time_range' => [
                '2025-01-01',
                '2025-01-31',
            ],
            'client_status' => [
                'Active',
            ],
            'clients' => [
                'cases_count' => [
                    1,
                ],
                'clients_count' => [
                    1,
                ],
                'created_at' => [
                    '2025-01-01',
                    '2025-01-31',
                ],
                'risk' => [
                    'very high',
                ],
                'updated_at' => [
                    '2025-01-01',
                    '2025-01-31',
                ],
                'identifier' => [
                    'ID123',
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

Example response:

{
    "additional_terms": [
        "CEO"
    ],
    "address": "3721 West Fork Street, Montana",
    "aliases": [
        "J. Doe"
    ],
    "asset_type": null,
    "clients": [
        {
            "name": "John Doe",
            "id": 1
        }
    ],
    "company_number": null,
    "confidence": "Relative",
    "country": null,
    "country_of_birth": "NLD",
    "country_of_residence": "NLD",
    "created_at": "2023-08-02T18:48:22.000000Z",
    "date_of_birth": null,
    "deleted_at": null,
    "description": "Relation of a high risk client",
    "excluded_terms": [],
    "gender": null,
    "group_id": null,
    "id": 2049050,
    "identifier": null,
    "monitoring_frequency_sanctions": 90,
    "monitoring_frequency_peps": 90,
    "monitoring_frequency_news": 90,
    "monitoring_frequency_enforcements": 90,
    "monitoring_frequency_other": 90,
    "name": "My test case",
    "nationalities": null,
    "organization_id": 19,
    "origin": "import",
    "risk": 0.12,
    "searched_at": "2023-08-02T18:48:32.000000Z",
    "hits_unresolved_count": 0,
    "resolve_progress": 100,
    "hit_counts": {
        "negative": {
            "enforcements": 0,
            "news": 0,
            "other": 0,
            "peps": 0,
            "sanctions": 0
        },
        "positive": {
            "enforcements": 0,
            "news": 0,
            "other": 0,
            "peps": 0,
            "sanctions": 0
        },
        "unresolved": {
            "enforcements": 0,
            "news": 0,
            "other": 0,
            "peps": 0,
            "sanctions": 0
        }
    },
    "sources": [
        {
            "active": true,
            "case_id": 2049050,
            "data_source": {
                "active": true,
                "deactivated_at": "2023-02-21T12:57:31.000000Z",
                "id": 409,
                "source": "peps",
                "vendor": "default"
            },
            "data_source_id": 409,
            "id": 18320030,
            "searched_at": "2023-08-02T18:48:22.000000Z",
            "succeeded": true
        },
        {
            "active": true,
            "case_id": 2049050,
            "data_source": {
                "active": true,
                "deactivated_at": "2023-02-21T12:57:31.000000Z",
                "id": 413,
                "source": "news",
                "vendor": "default"
            },
            "data_source_id": 413,
            "id": 18320031,
            "searched_at": "2023-08-02T18:48:22.000000Z",
            "succeeded": true
        }
    ],
    "status": "Monitored",
    "type": "Person",
    "unresolved_risk": 0,
    "updated_at": "2023-08-02T18:48:22.000000Z",
    "user_id": null,
    "uuid": "a2546955-de2d-4907-a533-0846ee46f719"
}

Update case

PATCH

https://app.pascal.vartion.com

/api/v1/cases/{id}

requires authentication

Edit the specifications or status of an existing case. Only fields provided will be updated, fields that are not provided will remain in the current state. Will return the updated case information.

For example, a request with just a case status {"status": "Monitored"} can be used to change a case from in review to monitored

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

URL Parameters

string

required

The ID of the case.

Example:

B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15

Body Parameters

clients

string[]

required

List of clients to link this case to. Each item can be either a number (client id) or string (client name). If a client with the given name doesn't exist, it will be created. Any previously linked clients that are not in this list will be unlinked. If you don't provide this parameter, the linked clients will not change. Must not be larger than 255.

excluded_terms

string[]

List terms that should not be matched on when searching for new hits in this case. Must not be larger than 255.

status

string

Example:

Monitored

description

string

Additional information to be displayed in the case.

monitoring_frequency

integer

Example:

monitoring_frequency_sanctions

integer

The frequency in days that the case should be monitored for new Sanctions hits. Must be one of 0, 1, 7, 28, 90, 365. If set to 0, the case will not be monitored for Sanctions hits.

monitoring_frequency_enforcements

integer

The frequency in days that the case should be monitored for new Enforcement hits. Must be one of 0, 1, 7, 28, 90, 365. If set to 0, the case will not be monitored for Enforcement hits.

monitoring_frequency_peps

integer

The frequency in days that the case should be monitored for new PEP hits. Must be one of 0, 1, 7, 28, 90, 365. If set to 0, the case will not be monitored for PEP hits.

monitoring_frequency_other

integer

The frequency in days that the case should be monitored for new hits from Other sources. Must be one of 0, 1, 7, 28, 90, 365. If set to 0, the case will not be monitored for hits from Other sources.

monitoring_frequency_news

integer

The frequency in days that the case should be monitored for new Media hits. Must be one of 0, 1, 7, 28, 90, 365. If set to 0, the case will not be monitored for Media hits.

name

string

Must match the regex /[^' ',-\/.]/. Must not be smaller than 2. Must not be larger than 255.

Example:

John Doe

aliases

string[]

required

Must match the regex /[^' ',-\/.]/. Must not be smaller than 2. Must not be larger than 255.

confidence

string

Example:

Relative

additional_terms

string[]

Must not be larger than 255.

sources

string[]

If provided, will update the enabled case sources to the selection. Must be one or more of: sanctions, enforcements, peps, news, other.

gender

string

[Person case] Must be one of Male or Female. This field is required when cases.passportVerificationForm is present.

Example:

Male

nationalities

string[]

required

[Person case] An array of max 10 nationalities. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

country_of_birth

string

[Person case]. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

NLD

country_of_residence

string

[Person case]. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

NLD

date_of_birth

string

[Person case] ISO date string. Must be a valid date in the format Y-m-d.

Example:

2000-01-31

passportVerificationForm

object

[Person case] Optional passport check information to be added to the case.

country

string

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code This field is required when cases.passportVerificationForm is present.

Example:

NLD

dateOfExpiry

string

This field is required when cases.passportVerificationForm is present. Must be a valid date in the format Y-m-d.

Example:

2025-11-12

documentNumber

string

This field is required when cases.passportVerificationForm is present. Must not be smaller than 6. Must not be larger than 9.

Example:

bngzmiy

givenNames

string

This field is required when cases.passportVerificationForm is present. Must not be larger than 255.

Example:

lastName

string

This field is required when cases.passportVerificationForm is present. Must not be larger than 255.

Example:

nationality

string

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code This field is required when cases.passportVerificationForm is present.

Example:

NLD

optionalData

string

Must not be larger than 14.

Example:

ljnikhwaykcmyu

company_number

string

[Business case]. Must not be larger than 255.

Example:

NL123

country

string

[Business case]. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

NLD

address

string

[Business case]. Must not be larger than 255.

Example:

3721 West Fork Street, Montana

asset_type

string

[Asset case] Must be one of vessel or aircraft.

Example:

vessel

identifier

string

[Asset case]. Must not be larger than 255.

Example:

123456

boolean

Controls whether or not to initiate a new search after updating the case. By default, this parameter is set to false.

When search is set to false (the default), the operation will not trigger a new search on the case. This means that no changes will be made to the existing hits, resolved or unresolved. However, when you set search to true, the API will perform a new search on the case. Here's what happens when you initiate a new search:

Unresolved Hits: Will be deleted.
Resolved Hits: Any existing resolved hits, regardless of their current state, will not be deleted.

Possible refound hits: It is possible that some hits that were previously unresolved might be refound during the new search. These hits will reappear as unresolved items.
Possible new hits: The new search might also discover new hits that were not present in the previous search. These hits will be added as unresolved items.

Response Fields

additional_terms

null|string[]

A list of words that boost confidence of hits if present in any visible text field.

address

null|string

[Business case] The address of the resource.

asset_type

null|string

[Asset case] The type of asset the resource is. Possible values: "vessel", "aircraft".

clients

object[]

The clients associated with the resource.

company_number

null|string

[Business case] The company number of the resource.

Example:

NL123

confidence

string

The confidence level of the resource. Possible values: "Relative", "Exact"

country_of_birth

null|string

[Person case] The country of birth of the resource. ISO 3166-1 alpha-3 country code string.

country_of_residence

null|string

[Person case] The country of residence of the resource. ISO 3166-1 alpha-3 country code string.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

date_of_birth

null|string

[Person case] The date of birth of the resource, in YYYY-MM-DD format.

deleted_at

null|string

The date and time the resource was deleted. An ISO 8601 date string.

description

null|string

Additional information displayed in the resource.

excluded_terms

null|string[]

gender

null|string

[Person case] The gender of the resource. Possible values: "Female", "Male"

group_id

integer

The group linked to the resource.If both this and user_id are missing, the resource is unassigned.

hits_unresolved_count

integer

The number of unresolved hits for the resource. Only present when requested by passing hitCounts to the with parameter.

integer

A globally unique identifier of the resource.

identifier

null|string

[Asset case] The identifier of the resource, such as the registration number of a vessel or aircraft.

country

null|string

[Business case] The country of the resource. ISO 3166-1 alpha-3 country code string.

monitoring_frequency_sanctions

null|integer

The monitoring frequency of Sanctions for the resource, in days.

monitoring_frequency_peps

null|integer

The monitoring frequency of PEPs for the resource, in days.

monitoring_frequency_news

null|integer

The monitoring frequency of Media for the resource, in days.

monitoring_frequency_enforcements

null|integer

The monitoring frequency of Enforcements for the resource, in days.

monitoring_frequency_other

null|integer

The monitoring frequency of Other sources for the resource, in days.

name

string

The name of the resource.

nationalities

null|string

[Person case] [Asset case] The nationalities of the resource. ISO 3166-1 alpha-3 country code string.

origin

string

The origin of the resource. Possible values: "person-check", "business-check", "hyperlink", "import", "public-api"

organization_id

integer

The globally unique identifier of the organisation that owns the resource.

risk

null|float

The risk score of the resource. Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high).

searched_at

null|string

The date and time the resource was most recently searched. An ISO 8601 date string.

sources

object[]

The sources used by the resource.

active

boolean

Whether the source is active.

case_id

integer

The ID of the case the source belongs to.

data_source

object

The data source details.

data_source_id

integer

The ID of the data source.

integer

The ID of the source

searched_at

null|string

The date and time the source was most recently searched. An ISO 8601 date string.

succeeded

boolean

Whether the last search attempt succeeded.

status

string

The status of the resource. Possible values: "In Review", "Monitored", "Archived", "Preview"

unresolved_risk

null|float

The risk score of the unresolved hits for the resource. Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high).

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

user_id

integer

The user linked to the resource.If both this and group_id are missing, the resource is unassigned.

uuid

string

A universally unique identifier of the resource.

Auth

Bearer

Headers

URL Parameters

Body

{ "clients": null, "excluded_terms": null, "status": "Monitored", "description": null, "monitoring_frequency": "7", "monitoring_frequency_sanctions": null, "monitoring_frequency_enforcements": null, "monitoring_frequency_peps": null, "monitoring_frequency_other": null, "monitoring_frequency_news": null, "name": "John Doe", "aliases": null, "confidence": "Relative", "additional_terms": null, "sources": null, "gender": "Male", "nationalities": [ "NLD" ], "country_of_birth": "NLD", "country_of_residence": "NLD", "date_of_birth": "2000-01-31", "passportVerificationForm": { "country": "NLD", "dateOfExpiry": "2025-11-12", "documentNumber": "bngzmiy", "givenNames": "v", "lastName": "d", "nationality": "NLD", "optionalData": "ljnikhwaykcmyu" }, "company_number": "NL123", "country": "NLD", "address": "3721 West Fork Street, Montana", "asset_type": "vessel", "identifier": "123456", "search": null }

Received response

Example request:

curl --request PATCH \
    "https://app.pascal.vartion.com/api/v1/cases/B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"clients\": null,
    \"status\": \"Monitored\",
    \"monitoring_frequency\": \"7\",
    \"name\": \"John Doe\",
    \"aliases\": null,
    \"confidence\": \"Relative\",
    \"gender\": \"Male\",
    \"nationalities\": [
        \"NLD\"
    ],
    \"country_of_birth\": \"NLD\",
    \"country_of_residence\": \"NLD\",
    \"date_of_birth\": \"2000-01-31\",
    \"passportVerificationForm\": {
        \"country\": \"NLD\",
        \"dateOfExpiry\": \"2025-11-12\",
        \"documentNumber\": \"bngzmiy\",
        \"givenNames\": \"v\",
        \"lastName\": \"d\",
        \"nationality\": \"NLD\",
        \"optionalData\": \"ljnikhwaykcmyu\"
    },
    \"company_number\": \"NL123\",
    \"country\": \"NLD\",
    \"address\": \"3721 West Fork Street, Montana\",
    \"asset_type\": \"vessel\",
    \"identifier\": \"123456\"
}"

Example response:

{
    "additional_terms": [
        "CEO"
    ],
    "address": "3721 West Fork Street, Montana",
    "aliases": [
        "J. Doe"
    ],
    "asset_type": null,
    "clients": [
        {
            "name": "John Doe",
            "id": 1
        }
    ],
    "company_number": null,
    "confidence": "Relative",
    "country": null,
    "country_of_birth": "NLD",
    "country_of_residence": "NLD",
    "created_at": "2023-08-02T18:48:22.000000Z",
    "date_of_birth": null,
    "deleted_at": null,
    "description": "Relation of a high risk client",
    "excluded_terms": [],
    "gender": null,
    "group_id": null,
    "id": 2049050,
    "identifier": null,
    "monitoring_frequency_sanctions": 90,
    "monitoring_frequency_peps": 90,
    "monitoring_frequency_news": 90,
    "monitoring_frequency_enforcements": 90,
    "monitoring_frequency_other": 90,
    "name": "My test case",
    "nationalities": null,
    "organization_id": 19,
    "origin": "import",
    "risk": 0.12,
    "searched_at": "2023-08-02T18:48:32.000000Z",
    "sources": [
        {
            "active": true,
            "case_id": 2049050,
            "data_source": {
                "active": true,
                "deactivated_at": "2023-02-21T12:57:31.000000Z",
                "id": 409,
                "source": "peps",
                "vendor": "default"
            },
            "data_source_id": 409,
            "id": 18320030,
            "searched_at": "2023-08-02T18:48:22.000000Z",
            "succeeded": true
        },
        {
            "active": true,
            "case_id": 2049050,
            "data_source": {
                "active": true,
                "deactivated_at": "2023-02-21T12:57:31.000000Z",
                "id": 413,
                "source": "news",
                "vendor": "default"
            },
            "data_source_id": 413,
            "id": 18320031,
            "searched_at": "2023-08-02T18:48:22.000000Z",
            "succeeded": true
        }
    ],
    "status": "Monitored",
    "type": "Person",
    "unresolved_risk": 0,
    "updated_at": "2023-08-02T18:48:22.000000Z",
    "user_id": null,
    "uuid": "a2546955-de2d-4907-a533-0846ee46f719"
}

Case hits key information

GET

https://app.pascal.vartion.com

/api/v1/cases/{id}/hits-key-information

requires authentication

Retrieve the key information of a case's hits.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

URL Parameters

string

required

The ID of the case.

Example:

B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15

Response Fields

{resolution}

object

An object containing the key information of unresolved hits in the case, grouped by resolution and source. Possible values for resolution: "unresolved", "positive" (included), "negative" (excluded). Possible values for source: "sanctions", "enforcements", "peps", "news", "other".

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.pascal.vartion.com/api/v1/cases/B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15/hits-key-information" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1"

Example response:

{
    "unresolved": {
        "enforcements": [
            {
                "data": {
                    "birth_dates": null,
                    "connections": null,
                    "name": "John Doe",
                    "nationalities": [
                        {
                            "country": "United States of America"
                        }
                    ]
                },
                "resolution": "unresolved",
                "source": "enforcements"
            }
        ],
        "sanctions": [
            {
                "data": {
                    "birth_dates": null,
                    "connections": null,
                    "name": "John Doe",
                    "nationalities": [
                        {
                            "country": "United States of America"
                        }
                    ]
                },
                "resolution": "unresolved",
                "source": "sanctions"
            }
        ]
    },
    "positive": {
        "enforcements": [
            {
                "data": {
                    "birth_dates": null,
                    "connections": null,
                    "name": "John Doe",
                    "nationalities": [
                        {
                            "country": "United States of America"
                        }
                    ]
                },
                "resolution": "positive",
                "source": "enforcements"
            }
        ],
        "sanctions": [
            {
                "data": {
                    "birth_dates": null,
                    "connections": null,
                    "name": "John Doe",
                    "nationalities": [
                        {
                            "country": "United States of America"
                        }
                    ]
                },
                "resolution": "positive",
                "source": "sanctions"
            }
        ]
    }
}

Clients

Create client

POST

https://app.pascal.vartion.com

/api/v1/clients

requires authentication

Create a new client.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

name

string

required

The name of the client. Must not be larger than 255.

Example:

My client

identifier

string

A unique, case sensitive identifier for the client. Must not be larger than 255.

Example:

ID123

description

string

A description of the client. Must not be larger than 2000.

Example:

A description of the client.

Response Fields

integer

A globally unique identifier of the resource.

name

string

The name of the resource.

organization_id

integer

The globally unique identifier of the organisation that owns the resource.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

description

null|string

The description of the resource.

status

string

The status of the resource. Possible values: "Active", "Archived".

assignee_user_id

null|integer

The ID of the user assigned to the resource.

onboarding_status

null|string

The onboarding status of the resource. Possible values: "waiting for client", "in review", "waiting for approval", "completed", "declined".

onboarding_risk

null|string

The onboarding risk level of the resource. Possible values: "very low", "low", "medium", "high", "very high".

cases_count

integer

The number of cases linked to the resource.

risk

null|float

The screening risk of the resource, based on the highest risk of all linked cases. Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high).

hits_total_count

integer

The total number of hits linked to the resource.

hits_unresolved_count

integer

The number of unresolved hits linked to the resource.

resolve_progress

integer

The percentage of resolved hits linked to the resource, between 0 and 100.

Auth

Bearer

Headers

Body

{ "name": "My client", "identifier": "ID123", "description": "A description of the client." }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/clients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"name\": \"My client\",
    \"identifier\": \"ID123\",
    \"description\": \"A description of the client.\"
}"

Example response:

{
    "id": 13152,
    "name": "Pauline Lindgren III",
    "organization_id": 91,
    "created_at": "2025-08-28T13:40:59.000000Z",
    "updated_at": "2025-08-28T13:40:59.000000Z",
    "description": "Accusantium quod voluptas ut. Rerum dolorum soluta rerum dolores. Ut officia quia velit maxime non ducimus.",
    "status": "Active",
    "assignee_user_id": null,
    "onboarding_status": null,
    "onboarding_risk": null,
    "cases_count": 8,
    "risk": 0.12,
    "hits_total_count": 0,
    "hits_unresolved_count": 0,
    "resolve_progress": 100,
    "approval_steps": []
}

Get client

GET

https://app.pascal.vartion.com

/api/v1/clients/{id}

requires authentication

Get detailed information on a specific client.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

URL Parameters

string

required

The ID of the client.

Example:

564

Response Fields

integer

A globally unique identifier of the resource.

identifier

null|string

A unique, case-sensitive identifier for the resource.

name

string

The name of the resource.

organization_id

integer

The globally unique identifier of the organisation that owns the resource.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

description

null|string

The description of the resource.

status

string

The status of the resource. Possible values: "Active", "Archived".

assignee_user_id

null|integer

The ID of the user assigned to the resource.

onboarding_status

null|string

The onboarding status of the resource. Possible values: "waiting for client", "in review", "waiting for approval", "completed", "declined".

onboarding_risk

null|string

The onboarding risk level of the resource. Possible values: "very low", "low", "medium", "high", "very high".

cases_count

integer

The number of cases linked to the resource.

risk

null|float

The screening risk of the resource, based on the highest risk of all linked cases. Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high).

hits_total_count

integer

The total number of hits linked to the resource.

hits_unresolved_count

integer

The number of unresolved hits linked to the resource.

resolve_progress

integer

The percentage of resolved hits linked to the resource, between 0 and 100.

approval_steps

object[]

The approval steps linked to the resource.

integer

The ID of the approval step.

user_id

null|integer

The ID of the user who approved this step. null if the step has not been approved yet.

approved

null|boolean

The approval status. true means approved, false means explicitly rejected, and null means pending (not yet reviewed).

updated_at

string

The date and time the approval step was last updated. An ISO 8601 date string.

approved_by_function

null|string

The organisation function name that approved this step. null if not yet approved.

user_name

null|string

The name of the user at the time of approval. This field captures the user's name when the approval was made and does not change if the user's name is later updated. null if not yet approved.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.pascal.vartion.com/api/v1/clients/564" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1"

Example response:

{
    "id": 1,
    "name": "My client",
    "identifier": "ABC-123",
    "organization_id": 1,
    "created_at": "2025-08-28T13:40:59.000000Z",
    "updated_at": "2025-08-28T14:20:59.000000Z",
    "description": "A description of the client.",
    "status": "Active",
    "assignee_user_id": null,
    "onboarding_status": "waiting for approval",
    "onboarding_risk": null,
    "cases_count": 8,
    "risk": 0.12,
    "hits_total_count": 0,
    "hits_unresolved_count": 0,
    "resolve_progress": 100,
    "approval_steps": [
        {
            "id": 328,
            "user_id": 2194,
            "approved": true,
            "updated_at": "2025-08-28T14:20:59.000000Z",
            "approved_by_function": "Compliance Officer",
            "user_name": "John Smith"
        },
        {
            "id": 329,
            "user_id": null,
            "approved": null,
            "updated_at": "2025-08-28T14:20:59.000000Z",
            "approved_by_function": null,
            "user_name": null
        }
    ]
}

List clients

POST

https://app.pascal.vartion.com

/api/v1/clients/searches

requires authentication

Search for clients using filters. Returning basic information on a list of clients. Paginating through results is possible using the per_page and page parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

integer[]

required

Client IDs to be filtered on. Must not be smaller than 1.

not_id

integer[]

required

Client IDs to be excluded. Must not be smaller than 1.

identifier

string[]

Client identifiers to be filtered on. Must not be larger than 255.

Example:

["ID123"]

assignee_user_id

integer[]

required

Must not be smaller than 1.

Example:

[16]

client_client_id

integer[]

required

Must not be smaller than 1.

Example:

[22]

not_client_client_id

integer[]

required

Must not be smaller than 1.

Example:

[67]

not_cases_id

integer[]

required

Must not be smaller than 1.

Example:

[66]

name

string

Search on client names. Supports SQL LIKE wildcards.

onboarding_status

string[]

Example:

["completed"]

organization_id

integer[]

required

Filter on clients from a specific organization (if token has access to multiple organizations). Must not be smaller than 1.

page

integer

Page to be returned. Must not be smaller than 1.

Example:

per_page

integer

Number of results per page. Must not be smaller than 1. Must not be larger than 1000.

Example:

sort_by

string

Field to sort the results by. Can be one of updated_at, name, type, status, onboarding_status. Defaults to updated_at.

Example:

updated_at

sort_order

string

The sorting order for the results. Can be one of asc or desc. Defaults to desc.

Example:

desc

status

string[]

updated_at

object

A date range, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

created_at

object

A date range, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

risk

string[]

Filter on the screening risk.

Example:

[["high","very high"]]

cases_count

integer[]

Filter on the number of cases in the client by defining a minimum and/or maximum. Must not be smaller than 0.

Example:

[1]

clients_count

integer[]

Filter on the number of linked clients by defining a minimum and/or maximum. Must not be smaller than 0.

Example:

[1]

custom_filters

string[]

Specific filters:
- 'has_onboarding_forms': Filter clients that have at least one onboarding form.

Example:

["has_onboarding_forms"]

cases

object

group_id

integer[]

required

Filter on case collaborators using group ids. Must not be smaller than 1.

Example:

[1]

user_id

integer[]

Filter on case assignees using user ids. Must not be smaller than 1.

Example:

[1]

country

string[]

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

created_at

object

A date range for the creation date of associated cases, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

identifier

string[]

Filter on the identifier of an associated asset. Must not be larger than 255.

name

string

Search on names of associated cases. Supports SQL LIKE wildcards. Must not be larger than 255.

nationalities

string[]

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

risk

string[]

status

string[]

required

type

string[]

required

Filter on the type of associated cases. Must be one of Person, Business or Asset.

updated_at

object

A date range for the update date of associated cases, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

uuid

string[]

Filter on the UUID of associated cases. Supports SQL LIKE wildcards. This field must be a valid UUID.

hits

object

with

string[]

required

Additional information to include with the clients. Must be one of: approvalSteps.

Example:

["approvalSteps"]

Response Fields

data

object[]

The list of resources.

integer

A globally unique identifier of the resource.

identifier

null|string

A unique, case-sensitive identifier for the resource.

name

string

The name of the resource.

organization_id

integer

The globally unique identifier of the organisation that owns the resource.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

description

null|string

The description of the resource.

status

string

The status of the resource. Possible values: "Active", "Archived".

assignee_user_id

null|integer

The ID of the user assigned to the resource.

onboarding_status

null|string

The onboarding status of the resource. Possible values: "waiting for client", "in review", "waiting for approval", "completed", "declined".

onboarding_risk

null|string

The onboarding risk level of the resource. Possible values: "very low", "low", "medium", "high", "very high".

cases_count

integer

The number of cases linked to the resource.

risk

null|float

The "screening" risk of the resource, based on the highest risk of all linked cases. It can also be null if no risk has been found (due to various reasons such as no cases, or no resolved hits). Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high).

hits_total_count

integer

The total number of hits linked to the resource.

hits_unresolved_count

integer

The number of unresolved hits linked to the resource.

resolve_progress

integer

The percentage of resolved hits linked to the resource. A value between 0 and 100.

approval_steps

object[]

The approval steps linked to the resource. Only present when requested by passing approvalSteps to the with parameter.

integer

The ID of the approval step.

user_id

null|integer

The ID of the user who approved this step. null if the step has not been approved yet.

approved

null|boolean

The approval status. true means approved, false means explicitly rejected, and null means pending (not yet reviewed).

updated_at

string

The date and time the approval step was last updated. An ISO 8601 date string.

approved_by_function

null|string

The organisation function name that approved this step. null if not yet approved.

user_name

null|string

The name of the user at the time of approval. This field captures the user's name when the approval was made and does not change if the user's name is later updated. null if not yet approved.

meta

object

Pagination information.

Example:

{"current_page":1,"from":1,"last_page":10,"per_page":15,"to":15,"total":150}

Auth

Bearer

Headers

Body

{ "id": null, "not_id": null, "identifier": [ "ID123" ], "assignee_user_id": [ 16 ], "client_client_id": [ 22 ], "not_client_client_id": [ 67 ], "not_cases_id": [ 66 ], "name": null, "onboarding_status": [ "completed" ], "organization_id": null, "page": 1, "per_page": 10, "sort_by": "updated_at", "sort_order": "desc", "status": null, "updated_at": [ "2025-01-01", "2025-01-31" ], "created_at": [ "2025-01-01", "2025-01-31" ], "risk": [ [ "high", "very high" ] ], "cases_count": [ 1 ], "clients_count": [ 1 ], "custom_filters": [ "has_onboarding_forms" ], "cases": { "group_id": [ 1 ], "user_id": [ 1 ], "country": [ "NLD" ], "created_at": [ "2025-01-01", "2025-01-31" ], "identifier": null, "name": null, "nationalities": [ "NLD" ], "risk": null, "status": null, "type": null, "updated_at": [ "2025-01-01", "2025-01-31" ], "uuid": null, "hits": { "resolution": [ [ "unresolved", "positive" ] ], "source": null, "time_range": [ "2025-01-01", "2025-01-31" ] } }, "with": [ "approvalSteps" ] }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/clients/searches" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"id\": null,
    \"not_id\": null,
    \"identifier\": [
        \"ID123\"
    ],
    \"assignee_user_id\": [
        16
    ],
    \"client_client_id\": [
        22
    ],
    \"not_client_client_id\": [
        67
    ],
    \"not_cases_id\": [
        66
    ],
    \"onboarding_status\": [
        \"completed\"
    ],
    \"organization_id\": null,
    \"page\": 1,
    \"per_page\": 10,
    \"sort_by\": \"updated_at\",
    \"sort_order\": \"desc\",
    \"updated_at\": [
        \"2025-01-01\",
        \"2025-01-31\"
    ],
    \"created_at\": [
        \"2025-01-01\",
        \"2025-01-31\"
    ],
    \"risk\": [
        [
            \"high\",
            \"very high\"
        ]
    ],
    \"cases_count\": [
        1
    ],
    \"clients_count\": [
        1
    ],
    \"custom_filters\": [
        \"has_onboarding_forms\"
    ],
    \"cases\": {
        \"group_id\": [
            1
        ],
        \"user_id\": [
            1
        ],
        \"country\": [
            \"NLD\"
        ],
        \"created_at\": [
            \"2025-01-01\",
            \"2025-01-31\"
        ],
        \"nationalities\": [
            \"NLD\"
        ],
        \"status\": null,
        \"type\": null,
        \"updated_at\": [
            \"2025-01-01\",
            \"2025-01-31\"
        ],
        \"hits\": {
            \"resolution\": [
                [
                    \"unresolved\",
                    \"positive\"
                ]
            ],
            \"source\": null,
            \"time_range\": [
                \"2025-01-01\",
                \"2025-01-31\"
            ]
        }
    },
    \"with\": [
        \"approvalSteps\"
    ]
}"

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.pascal.vartion.com/api/v1/clients/searches',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'OrganizationId' => 1,
        ],
        'json' => [
            'id' => null,
            'not_id' => null,
            'identifier' => [
                'ID123',
            ],
            'assignee_user_id' => [
                16,
            ],
            'client_client_id' => [
                22,
            ],
            'not_client_client_id' => [
                67,
            ],
            'not_cases_id' => [
                66,
            ],
            'onboarding_status' => [
                'completed',
            ],
            'organization_id' => null,
            'page' => 1,
            'per_page' => 10,
            'sort_by' => 'updated_at',
            'sort_order' => 'desc',
            'updated_at' => [
                '2025-01-01',
                '2025-01-31',
            ],
            'created_at' => [
                '2025-01-01',
                '2025-01-31',
            ],
            'risk' => [
                [
                    'high',
                    'very high',
                ],
            ],
            'cases_count' => [
                1,
            ],
            'clients_count' => [
                1,
            ],
            'custom_filters' => [
                'has_onboarding_forms',
            ],
            'cases' => [
                'group_id' => [
                    1,
                ],
                'user_id' => [
                    1,
                ],
                'country' => [
                    'NLD',
                ],
                'created_at' => [
                    '2025-01-01',
                    '2025-01-31',
                ],
                'nationalities' => [
                    'NLD',
                ],
                'status' => null,
                'type' => null,
                'updated_at' => [
                    '2025-01-01',
                    '2025-01-31',
                ],
                'hits' => [
                    'resolution' => [
                        [
                            'unresolved',
                            'positive',
                        ],
                    ],
                    'source' => null,
                    'time_range' => [
                        '2025-01-01',
                        '2025-01-31',
                    ],
                ],
            ],
            'with' => [
                'approvalSteps',
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://app.pascal.vartion.com/api/v1/clients/searches'
payload = {
    "id": null,
    "not_id": null,
    "identifier": [
        "ID123"
    ],
    "assignee_user_id": [
        16
    ],
    "client_client_id": [
        22
    ],
    "not_client_client_id": [
        67
    ],
    "not_cases_id": [
        66
    ],
    "onboarding_status": [
        "completed"
    ],
    "organization_id": null,
    "page": 1,
    "per_page": 10,
    "sort_by": "updated_at",
    "sort_order": "desc",
    "updated_at": [
        "2025-01-01",
        "2025-01-31"
    ],
    "created_at": [
        "2025-01-01",
        "2025-01-31"
    ],
    "risk": [
        [
            "high",
            "very high"
        ]
    ],
    "cases_count": [
        1
    ],
    "clients_count": [
        1
    ],
    "custom_filters": [
        "has_onboarding_forms"
    ],
    "cases": {
        "group_id": [
            1
        ],
        "user_id": [
            1
        ],
        "country": [
            "NLD"
        ],
        "created_at": [
            "2025-01-01",
            "2025-01-31"
        ],
        "nationalities": [
            "NLD"
        ],
        "status": null,
        "type": null,
        "updated_at": [
            "2025-01-01",
            "2025-01-31"
        ],
        "hits": {
            "resolution": [
                [
                    "unresolved",
                    "positive"
                ]
            ],
            "source": null,
            "time_range": [
                "2025-01-01",
                "2025-01-31"
            ]
        }
    },
    "with": [
        "approvalSteps"
    ]
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'OrganizationId': '1'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

const url = new URL(
    "https://app.pascal.vartion.com/api/v1/clients/searches"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "OrganizationId": "1",
};

let body = {
    "id": null,
    "not_id": null,
    "identifier": [
        "ID123"
    ],
    "assignee_user_id": [
        16
    ],
    "client_client_id": [
        22
    ],
    "not_client_client_id": [
        67
    ],
    "not_cases_id": [
        66
    ],
    "onboarding_status": [
        "completed"
    ],
    "organization_id": null,
    "page": 1,
    "per_page": 10,
    "sort_by": "updated_at",
    "sort_order": "desc",
    "updated_at": [
        "2025-01-01",
        "2025-01-31"
    ],
    "created_at": [
        "2025-01-01",
        "2025-01-31"
    ],
    "risk": [
        [
            "high",
            "very high"
        ]
    ],
    "cases_count": [
        1
    ],
    "clients_count": [
        1
    ],
    "custom_filters": [
        "has_onboarding_forms"
    ],
    "cases": {
        "group_id": [
            1
        ],
        "user_id": [
            1
        ],
        "country": [
            "NLD"
        ],
        "created_at": [
            "2025-01-01",
            "2025-01-31"
        ],
        "nationalities": [
            "NLD"
        ],
        "status": null,
        "type": null,
        "updated_at": [
            "2025-01-01",
            "2025-01-31"
        ],
        "hits": {
            "resolution": [
                [
                    "unresolved",
                    "positive"
                ]
            ],
            "source": null,
            "time_range": [
                "2025-01-01",
                "2025-01-31"
            ]
        }
    },
    "with": [
        "approvalSteps"
    ]
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response:

{
    "data": [
        {
            "id": 1,
            "identifier": "ABC-123",
            "name": "My client",
            "organization_id": 1,
            "created_at": "2025-08-28T13:40:59.000000Z",
            "updated_at": "2025-08-28T13:40:59.000000Z",
            "description": "A description of the client.",
            "status": "Active",
            "assignee_user_id": null,
            "onboarding_status": null,
            "onboarding_risk": null,
            "cases_count": 8,
            "risk": 0.12,
            "hits_total_count": 0,
            "hits_unresolved_count": 0,
            "resolve_progress": 100,
            "approval_steps": []
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}

Link clients

POST

https://app.pascal.vartion.com

/api/v1/clients/{id}/clients

requires authentication

Link a client to other clients.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The id of the client that you want to link to other clients.

Example:

Body Parameters

client_ids

string[]

required

The list of client id's to link to the client.

Example:

[2,3]

Auth

Bearer

Headers

URL Parameters

Body

{ "client_ids": [ 2, 3 ] }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/clients/1/clients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"client_ids\": [
        2,
        3
    ]
}"

Example response:

[Empty response]

Update client

PATCH

https://app.pascal.vartion.com

/api/v1/clients/{id}

requires authentication

Edit the specifications of an existing client.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

URL Parameters

string

required

The ID of the client.

Example:

564

Body Parameters

name

string

The name of the client. Must not be larger than 255.

Example:

My client

Response Fields

integer

A globally unique identifier of the resource.

identifier

null|string

A unique, case-sensitive identifier for the resource.

name

string

The name of the resource.

organization_id

integer

The globally unique identifier of the organisation that owns the resource.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

description

null|string

The description of the resource.

status

string

The status of the resource. Possible values: "Active", "Archived".

assignee_user_id

null|integer

The ID of the user assigned to the resource.

onboarding_status

null|string

The onboarding status of the resource. Possible values: "waiting for client", "in review", "waiting for approval", "completed", "declined".

onboarding_risk

null|string

The onboarding risk level of the resource. Possible values: "very low", "low", "medium", "high", "very high".

cases_count

integer

The number of cases linked to the resource.

risk

null|float

The screening risk of the resource, based on the highest risk of all linked cases. Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high).

hits_total_count

integer

The total number of hits linked to the resource.

hits_unresolved_count

integer

The number of unresolved hits linked to the resource.

resolve_progress

integer

The percentage of resolved hits linked to the resource, between 0 and 100.

approval_steps

object[]

The approval steps linked to the resource.

integer

The ID of the approval step.

user_id

null|integer

The ID of the user who approved this step. null if the step has not been approved yet.

approved

null|boolean

The approval status. true means approved, false means explicitly rejected, and null means pending (not yet reviewed).

updated_at

string

The date and time the approval step was last updated. An ISO 8601 date string.

approved_by_function

null|string

The organisation function name that approved this step. null if not yet approved.

user_name

null|string

The name of the user at the time of approval. This field captures the user's name when the approval was made and does not change if the user's name is later updated. null if not yet approved.

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "My client" }

Received response

Example request:

curl --request PATCH \
    "https://app.pascal.vartion.com/api/v1/clients/564" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"name\": \"My client\"
}"

Example response:

{
    "id": 1,
    "name": "My client",
    "identifier": "ABC-123",
    "organization_id": 1,
    "created_at": "2025-08-28T13:40:59.000000Z",
    "updated_at": "2025-08-28T14:20:59.000000Z",
    "description": "A description of the client.",
    "status": "Active",
    "assignee_user_id": null,
    "onboarding_status": "waiting for approval",
    "onboarding_risk": null,
    "cases_count": 8,
    "risk": 0.12,
    "hits_total_count": 0,
    "hits_unresolved_count": 0,
    "resolve_progress": 100,
    "approval_steps": [
        {
            "id": 328,
            "user_id": 2194,
            "approved": true,
            "updated_at": "2025-08-28T14:20:59.000000Z",
            "approved_by_function": "Compliance Officer",
            "user_name": "John Smith"
        },
        {
            "id": 329,
            "user_id": null,
            "approved": null,
            "updated_at": "2025-08-28T14:20:59.000000Z",
            "approved_by_function": null,
            "user_name": null
        }
    ]
}

Unlink clients

DELETE

https://app.pascal.vartion.com

/api/v1/clients/{id}/clients

requires authentication

Unlink a client from other clients.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The id of the client that you want to unlink from other clients.

Example:

Body Parameters

client_ids

string[]

required

The list of client id's to unlink from the client.

Example:

[2,3]

Auth

Bearer

Headers

URL Parameters

Body

{ "client_ids": [ 2, 3 ] }

Received response

Example request:

curl --request DELETE \
    "https://app.pascal.vartion.com/api/v1/clients/1/clients" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"client_ids\": [
        2,
        3
    ]
}"

Example response:

[Empty response]

Import clients

POST

https://app.pascal.vartion.com

/api/v1/clients/import

requires authentication

Import a list of clients asynchronously. You can use the 'Search clients' endpoint to check the status of the imported clients. The returned 'batch_id' is a batch ID, which you can use to check the progress of the import using the 'Get batch' endpoint.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

clients

object[]

required

Must not be smaller than 1. Must not be larger than 200.

type

string

Must be one of Person or Business. Defaults to null.

Example:

Person

name

string

required

The name of the client. Must not be larger than 255.

Example:

John Doe

identifier

string

An optional identifier for the client. This must be unique across all clients in your organization. Must not be larger than 255.

Example:

ID123

status

string

The status of the client. Must be one of Active or Archived. Defaults to Active.

Example:

Active

address

string

The address of the client. Must not be larger than 255.

Example:

123 Main St, Springfield

phone_number

string

Must be a valid phone number in E.164 format.

Example:

+31612345678

string

The email address of the client. This field must be a valid email address.

Example:

[email protected]

incorporation_date

string

[Business client] The incorporation date of the client. This field must be a valid date.

Example:

2020-01-31

company_number

string

[Business client] The company number of the client. Must not be larger than 255.

Example:

12345678

country

string

[Business client] The country of the client. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

NLD

nationalities

string[]

[Person client] The nationalities of the client. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

date_of_birth

string

[Person client] The date of birth of the client. This field must be a valid date.

Example:

1990-01-31

standard_industry_classifications

string[]

Standard industry classifications (SIC) codes for the client. Must not be larger than 255.

Example:

["01110"]

account_creation_date

string

The client account creation date. This field must be a valid date.

Example:

2023-01-31

risk_indicators

string[]

Must be a valid risk indicator as defined by your organization.

Example:

["PEP"]

estimated_incoming_amount

number

The estimated incoming amount for the client. Must not be smaller than 0. Must not be larger than 999999999999999.

Example:

100000

estimated_incoming_currency

string

The currency code for the estimated incoming amount.

Example:

EUR

estimated_outgoing_amount

number

The estimated outgoing amount for the client. Must not be smaller than 0. Must not be larger than 999999999999999.

Example:

50000

estimated_outgoing_currency

string

The currency code for the estimated outgoing amount.

Example:

EUR

description

string

A description for the client. Must not be larger than 2000.

Example:

Important client

user_risk_score

number

A risk score overwritten by you. Must be one of 0.03 (Very low), 0.06 (Low), 0.12 (Medium), 0.24 (High), or 0.25 (Very high).

Example:

0.06

assignee_user_id

integer

The assignee of the client. null is unassigned. Defaults to null.

Example:

collaborator_user_ids

string[]

profession

string

The profession of the client. Must not be larger than 255.

Example:

Software Engineer

gender

string

The gender of the client. Must be one of male, female, or non-binary.

Example:

male

cash_incoming_currency

string

The currency code for cash incoming.

Example:

USD

cash_incoming_amount

number

Amount of cash incoming. Must not be smaller than 0. Must not be larger than 999999999999999.

Example:

10000

cash_outgoing_currency

string

The currency code for cash outgoing.

Example:

USD

cash_outgoing_amount

number

Amount of cash outgoing. Must not be smaller than 0. Must not be larger than 999999999999999.

Example:

5000

cash_percentage

number

Percentage of cash transactions. Must not be smaller than 0. Must not be larger than 100.

Example:

12.5

transaction_count

integer

Total number of transactions. Must not be smaller than 0.

Example:

120

transaction_volume_incoming

integer

Total incoming transaction volume. Must not be smaller than 0.

Example:

200000

transaction_volume_outgoing

integer

Total outgoing transaction volume. Must not be smaller than 0.

Example:

150000

transaction_count_cross_border

integer

Number of cross-border transactions. Must not be smaller than 0.

Example:

transaction_volume_cross_border_incoming

integer

Incoming cross-border transaction volume. Must not be smaller than 0.

Example:

50000

transaction_volume_cross_border_outgoing

integer

Outgoing cross-border transaction volume. Must not be smaller than 0.

Example:

30000

transaction_countries

string[]

Countries involved in transactions. Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

deduplication_fields

string[]

Clients will be considered duplicates if they match on identifier or all of the given fields. Duplicate clients will be updated with the values from the import. If any of the selected deduplication fields are empty in an import record, while an existing record has the same field filled in, the record will not be seen as a duplicate and a new client will be created. Possible values are: name, address, phone_number, email, profession, gender, incorporation_date, company_number, country, nationalities, date_of_birth, or account_creation_date.

Example:

["name"]

ignore_empty_fields

boolean

If set to true, empty fields in the import records will be ignored when updating existing clients (i.e. existing values will not be overwritten with empty values). This allows you to do 'partial' updates to your existing clients. Empty values are: null, empty string, or empty array. Defaults to false.

Example:

false

batch_id

string

Example:

99cbb5f6-49a7-492c-a1de-92ff356d98d8

count

integer

Example:

250

Response Fields

batch_id

string

The unique identifier of the batch. It can be used to check the status of the import using the 'Get batch' endpoint.

Auth

Bearer

Headers

Body

{ "clients": [ { "type": "Person", "name": "John Doe", "identifier": "ID123", "status": "Active", "address": "123 Main St, Springfield", "phone_number": "+31612345678", "email": "[email protected]", "incorporation_date": "2020-01-31", "company_number": "12345678", "country": "NLD", "nationalities": [ "NLD" ], "date_of_birth": "1990-01-31", "standard_industry_classifications": [ "01110" ], "account_creation_date": "2023-01-31", "risk_indicators": [ "PEP" ], "estimated_incoming_amount": 100000, "estimated_incoming_currency": "EUR", "estimated_outgoing_amount": 50000, "estimated_outgoing_currency": "EUR", "description": "Important client", "user_risk_score": 0.06, "assignee_user_id": 1, "collaborator_user_ids": null, "profession": "Software Engineer", "gender": "male", "cash_incoming_currency": "USD", "cash_incoming_amount": 10000, "cash_outgoing_currency": "USD", "cash_outgoing_amount": 5000, "cash_percentage": 12.5, "transaction_count": 120, "transaction_volume_incoming": 200000, "transaction_volume_outgoing": 150000, "transaction_count_cross_border": 10, "transaction_volume_cross_border_incoming": 50000, "transaction_volume_cross_border_outgoing": 30000, "transaction_countries": [ "NLD" ] } ], "deduplication_fields": [ "name" ], "ignore_empty_fields": false, "batch_id": "99cbb5f6-49a7-492c-a1de-92ff356d98d8", "count": 250 }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/clients/import" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"clients\": [
        {
            \"type\": \"Person\",
            \"name\": \"John Doe\",
            \"identifier\": \"ID123\",
            \"status\": \"Active\",
            \"address\": \"123 Main St, Springfield\",
            \"phone_number\": \"+31612345678\",
            \"email\": \"[email protected]\",
            \"incorporation_date\": \"2020-01-31\",
            \"company_number\": \"12345678\",
            \"country\": \"NLD\",
            \"nationalities\": [
                \"NLD\"
            ],
            \"date_of_birth\": \"1990-01-31\",
            \"standard_industry_classifications\": [
                \"01110\"
            ],
            \"account_creation_date\": \"2023-01-31\",
            \"risk_indicators\": [
                \"PEP\"
            ],
            \"estimated_incoming_amount\": 100000,
            \"estimated_incoming_currency\": \"EUR\",
            \"estimated_outgoing_amount\": 50000,
            \"estimated_outgoing_currency\": \"EUR\",
            \"description\": \"Important client\",
            \"user_risk_score\": 0.06,
            \"assignee_user_id\": 1,
            \"profession\": \"Software Engineer\",
            \"gender\": \"male\",
            \"cash_incoming_currency\": \"USD\",
            \"cash_incoming_amount\": 10000,
            \"cash_outgoing_currency\": \"USD\",
            \"cash_outgoing_amount\": 5000,
            \"cash_percentage\": 12.5,
            \"transaction_count\": 120,
            \"transaction_volume_incoming\": 200000,
            \"transaction_volume_outgoing\": 150000,
            \"transaction_count_cross_border\": 10,
            \"transaction_volume_cross_border_incoming\": 50000,
            \"transaction_volume_cross_border_outgoing\": 30000,
            \"transaction_countries\": [
                \"NLD\"
            ]
        }
    ],
    \"deduplication_fields\": [
        \"name\"
    ],
    \"ignore_empty_fields\": false,
    \"batch_id\": \"99cbb5f6-49a7-492c-a1de-92ff356d98d8\",
    \"count\": 250
}"

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.pascal.vartion.com/api/v1/clients/import',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
        ],
        'json' => [
            'clients' => [
                [
                    'type' => 'Person',
                    'name' => 'John Doe',
                    'identifier' => 'ID123',
                    'status' => 'Active',
                    'address' => '123 Main St, Springfield',
                    'phone_number' => '+31612345678',
                    'email' => '[email protected]',
                    'incorporation_date' => '2020-01-31',
                    'company_number' => '12345678',
                    'country' => 'NLD',
                    'nationalities' => [
                        'NLD',
                    ],
                    'date_of_birth' => '1990-01-31',
                    'standard_industry_classifications' => [
                        '01110',
                    ],
                    'account_creation_date' => '2023-01-31',
                    'risk_indicators' => [
                        'PEP',
                    ],
                    'estimated_incoming_amount' => 100000.0,
                    'estimated_incoming_currency' => 'EUR',
                    'estimated_outgoing_amount' => 50000.0,
                    'estimated_outgoing_currency' => 'EUR',
                    'description' => 'Important client',
                    'user_risk_score' => 0.06,
                    'assignee_user_id' => 1,
                    'profession' => 'Software Engineer',
                    'gender' => 'male',
                    'cash_incoming_currency' => 'USD',
                    'cash_incoming_amount' => 10000.0,
                    'cash_outgoing_currency' => 'USD',
                    'cash_outgoing_amount' => 5000.0,
                    'cash_percentage' => 12.5,
                    'transaction_count' => 120,
                    'transaction_volume_incoming' => 200000,
                    'transaction_volume_outgoing' => 150000,
                    'transaction_count_cross_border' => 10,
                    'transaction_volume_cross_border_incoming' => 50000,
                    'transaction_volume_cross_border_outgoing' => 30000,
                    'transaction_countries' => [
                        'NLD',
                    ],
                ],
            ],
            'deduplication_fields' => [
                'name',
            ],
            'ignore_empty_fields' => false,
            'batch_id' => '99cbb5f6-49a7-492c-a1de-92ff356d98d8',
            'count' => 250,
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://app.pascal.vartion.com/api/v1/clients/import'
payload = {
    "clients": [
        {
            "type": "Person",
            "name": "John Doe",
            "identifier": "ID123",
            "status": "Active",
            "address": "123 Main St, Springfield",
            "phone_number": "+31612345678",
            "email": "[email protected]",
            "incorporation_date": "2020-01-31",
            "company_number": "12345678",
            "country": "NLD",
            "nationalities": [
                "NLD"
            ],
            "date_of_birth": "1990-01-31",
            "standard_industry_classifications": [
                "01110"
            ],
            "account_creation_date": "2023-01-31",
            "risk_indicators": [
                "PEP"
            ],
            "estimated_incoming_amount": 100000,
            "estimated_incoming_currency": "EUR",
            "estimated_outgoing_amount": 50000,
            "estimated_outgoing_currency": "EUR",
            "description": "Important client",
            "user_risk_score": 0.06,
            "assignee_user_id": 1,
            "profession": "Software Engineer",
            "gender": "male",
            "cash_incoming_currency": "USD",
            "cash_incoming_amount": 10000,
            "cash_outgoing_currency": "USD",
            "cash_outgoing_amount": 5000,
            "cash_percentage": 12.5,
            "transaction_count": 120,
            "transaction_volume_incoming": 200000,
            "transaction_volume_outgoing": 150000,
            "transaction_count_cross_border": 10,
            "transaction_volume_cross_border_incoming": 50000,
            "transaction_volume_cross_border_outgoing": 30000,
            "transaction_countries": [
                "NLD"
            ]
        }
    ],
    "deduplication_fields": [
        "name"
    ],
    "ignore_empty_fields": false,
    "batch_id": "99cbb5f6-49a7-492c-a1de-92ff356d98d8",
    "count": 250
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

const url = new URL(
    "https://app.pascal.vartion.com/api/v1/clients/import"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
};

let body = {
    "clients": [
        {
            "type": "Person",
            "name": "John Doe",
            "identifier": "ID123",
            "status": "Active",
            "address": "123 Main St, Springfield",
            "phone_number": "+31612345678",
            "email": "[email protected]",
            "incorporation_date": "2020-01-31",
            "company_number": "12345678",
            "country": "NLD",
            "nationalities": [
                "NLD"
            ],
            "date_of_birth": "1990-01-31",
            "standard_industry_classifications": [
                "01110"
            ],
            "account_creation_date": "2023-01-31",
            "risk_indicators": [
                "PEP"
            ],
            "estimated_incoming_amount": 100000,
            "estimated_incoming_currency": "EUR",
            "estimated_outgoing_amount": 50000,
            "estimated_outgoing_currency": "EUR",
            "description": "Important client",
            "user_risk_score": 0.06,
            "assignee_user_id": 1,
            "profession": "Software Engineer",
            "gender": "male",
            "cash_incoming_currency": "USD",
            "cash_incoming_amount": 10000,
            "cash_outgoing_currency": "USD",
            "cash_outgoing_amount": 5000,
            "cash_percentage": 12.5,
            "transaction_count": 120,
            "transaction_volume_incoming": 200000,
            "transaction_volume_outgoing": 150000,
            "transaction_count_cross_border": 10,
            "transaction_volume_cross_border_incoming": 50000,
            "transaction_volume_cross_border_outgoing": 30000,
            "transaction_countries": [
                "NLD"
            ]
        }
    ],
    "deduplication_fields": [
        "name"
    ],
    "ignore_empty_fields": false,
    "batch_id": "99cbb5f6-49a7-492c-a1de-92ff356d98d8",
    "count": 250
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response:

{
    "batch_id": "1abd0c71-dadd-4dad-8e20-1bd83aea25b3"
}

Onboarding forms

List onboarding form templates

POST

https://app.pascal.vartion.com

/api/v1/onboarding-form-templates/searches

requires authentication

Search for any created onboarding form templates. Paginating through results is possible using the per_page and page parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

integer[]

Must not be smaller than 1.

page

integer

Page to be returned. Must not be smaller than 1.

Example:

per_page

integer

Number of results per page. Must not be smaller than 1. Must not be larger than 1000.

Example:

updated_at

object

A date range, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

sort_by

string

Field to sort the results by. Can be one of created_at, updated_at, name. Defaults to updated_at.

Example:

updated_at

sort_order

string

The sorting order for the results. Can be one of asc or desc. Defaults to desc.

Example:

desc

organization_id

integer[]

Must not be smaller than 1.

name

string

Must not be larger than 255.

Response Fields

data

object[]

The list of resources.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

external_name

string

The external name of the resource seen by external users.

integer

A globally unique identifier of the resource.

name

string

The name of the resource.

organization_id

integer

The globally unique identifier of the organisation that owns the resource.

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

meta

object

Pagination information.

Example:

{"current_page":1,"from":1,"last_page":10,"per_page":15,"to":15,"total":150}

Auth

Bearer

Headers

Body

{ "id": null, "page": 1, "per_page": 10, "updated_at": [ "2025-01-01", "2025-01-31" ], "sort_by": "updated_at", "sort_order": "desc", "organization_id": null, "name": null }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/onboarding-form-templates/searches" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"page\": 1,
    \"per_page\": 10,
    \"updated_at\": [
        \"2025-01-01\",
        \"2025-01-31\"
    ],
    \"sort_by\": \"updated_at\",
    \"sort_order\": \"desc\"
}"

Example response:

{
    "data": [
        {
            "created_at": "2024-11-28T08:34:03.000000Z",
            "external_name": "Standard Form",
            "id": 88,
            "name": "Standard Form",
            "organization_id": 15,
            "updated_at": "2024-11-28T08:34:03.000000Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}

Create onboarding form

POST

https://app.pascal.vartion.com

/api/v1/onboarding-forms

requires authentication

Create an onboarding form for an existing client.
Adding an onboarding form to a client will make it visible in the Onboarding application.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

assignee_user_email

string

This field must be a valid email address of a user in the organisation. Leaving this empty will assign the onboarding form to the authenticated user that performs the API call.

Example:

[email protected]

external_users

object[]

required

A list of all the individuals you want to send the onboarding form to. These individuals will receive an email requesting they fill out the form. Must not be smaller than 1.

onboarding_form_template_id

integer

required

You can retrieve the available onboarding form templates by using the Search Onboarding Form Templates endpoint. This endpoint will return a list of templates, including their IDs, which you can use when creating an onboarding form. Must not be smaller than 1.

Example:

client_id

integer

required

To find the appropriate client ID, you can use the Search Clients endpoint. This endpoint allows you to filter and retrieve clients. The response will include the client IDs, which you can use when creating an onboarding form. Alternatively new clients can be created using the Create Client which directly return the id of the created client. Must not be smaller than 1.

Example:

Response Fields

assignee_user_id

null|integer

The ID of the user assigned to this resource.

client_id

integer

The ID of the client associated with this resource.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

external_name

string

The external name of the resource, visible to external users.

external_questions_open

integer

The number of external questions that are still open in the resource.

external_questions_total

integer

The total number of external questions in the resource.

integer

A globally unique identifier of the resource.

name

null|string

The internal name of the resource.

organization_id

integer

The globally unique identifier of the organisation that owns the resource.

questions_open

null|integer

The number of questions in the resource that are still open.

questions_total

null|integer

The total number of questions in the resource.

status

string

The status of the resource. Possible values: "in progress", "submitted by client", "completed", "declined".

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

Auth

Bearer

Headers

Body

{ "assignee_user_email": "[email protected]", "external_users": [ { "first_name": "g", "last_name": "z", "email": "[email protected]" } ], "onboarding_form_template_id": 16, "client_id": 22 }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/onboarding-forms" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"assignee_user_email\": \"[email protected]\",
    \"external_users\": [
        {
            \"first_name\": \"g\",
            \"last_name\": \"z\",
            \"email\": \"[email protected]\"
        }
    ],
    \"onboarding_form_template_id\": 16,
    \"client_id\": 22
}"

Example response:

{
    "assignee_user_id": 24,
    "client_id": 2834,
    "created_at": "2025-03-31T11:22:10.000000Z",
    "external_name": "Standard Form",
    "external_questions_open": 1,
    "external_questions_total": 1,
    "id": 273,
    "name": "Standard Form",
    "organization_id": 10240,
    "questions_open": 1,
    "questions_total": 1,
    "status": "in progress",
    "updated_at": "2025-03-31T11:22:10.000000Z"
}

List onboarding forms

POST

https://app.pascal.vartion.com

/api/v1/onboarding-forms/searches

requires authentication

Search for onboarding forms using filters. Returning basic information on a list of onboarding forms. Paginating through results is possible using the per_page and page parameters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

integer[]

Onboarding form IDs to be filtered on. Must not be smaller than 1.

page

integer

Page to be returned. Must not be smaller than 1.

Example:

per_page

integer

Number of results per page. Must not be smaller than 1. Must not be larger than 1000.

Example:

name

string

Must not be larger than 255.

Example:

updated_at

object

A date range, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

sort_by

string

Field to sort the results by. Can be one of created_at, updated_at, name. Defaults to updated_at.

Example:

updated_at

sort_order

string

The sorting order for the results. Can be one of asc or desc. Defaults to desc.

Example:

desc

organization_id

integer[]

Filter on onboarding forms from a specific organization (if token has access to multiple organizations). Must not be smaller than 1.

external_user_ids

integer[]

required

Must not be smaller than 1.

Example:

[22]

client_id

integer[]

Must not be smaller than 1.

Example:

[67]

with

string[]

required

Additional information to include with the onboarding forms. Must be one of: user, externalUsers, organizationTheme.

Example:

["user"]

Response Fields

data

object[]

The list of resources.

assignee_user_id

null|integer

The ID of the user assigned to this resource.

client_id

integer

The ID of the client associated with this resource.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

external_name

string

The external name of the resource, visible to external users.

external_questions_open

integer

The number of external questions that are still open in the resource.

external_questions_total

integer

The total number of external questions in the resource.

integer

A globally unique identifier of the resource.

name

null|string

The internal name of the resource.

organization_id

integer

The globally unique identifier of the organisation that owns the resource.

questions_open

null|integer

The number of questions that are still open in the resource.

questions_total

null|integer

The total number of questions in the resource.

status

string

The status of the resource. Possible values: "in progress", "submitted by client", "completed", "declined".

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

meta

object

Pagination information.

Example:

{"current_page":1,"from":1,"last_page":10,"per_page":15,"to":15,"total":150}

Auth

Bearer

Headers

Body

{ "id": null, "page": 1, "per_page": 10, "name": "b", "updated_at": [ "2025-01-01", "2025-01-31" ], "sort_by": "updated_at", "sort_order": "desc", "organization_id": null, "external_user_ids": [ 22 ], "client_id": [ 67 ], "with": [ "user" ] }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/onboarding-forms/searches" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"page\": 1,
    \"per_page\": 10,
    \"name\": \"b\",
    \"updated_at\": [
        \"2025-01-01\",
        \"2025-01-31\"
    ],
    \"sort_by\": \"updated_at\",
    \"sort_order\": \"desc\",
    \"external_user_ids\": [
        22
    ],
    \"client_id\": [
        67
    ],
    \"with\": [
        \"user\"
    ]
}"

Example response:

Headers


cache-control
                                                            : no-cache, private
content-type
                                                            : application/json
x-ratelimit-limit
                                                            : 1000
x-ratelimit-remaining
                                                            : 995
vary
                                                            : Precognition, Origin

{
    "data": [],
    "meta": {
        "current_page": 1,
        "from": null,
        "last_page": 1,
        "per_page": 10,
        "to": null,
        "total": 0
    }
}

List onboarding form questions

POST

https://app.pascal.vartion.com

/api/v1/onboarding-form-questions/searches

requires authentication

Search for onboarding form questions using filters.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

external_ids

string[]

Filter on specific question external IDs. Must not be larger than 200.

Example:

["ID123"]

page

integer

Page to be returned. Must not be smaller than 1.

Example:

per_page

integer

Number of results per page. Must not be smaller than 1. Must not be larger than 1000.

Example:

onboarding_form_ids

integer[]

required

Filter on specific onboarding forms. Must not be smaller than 1.

Response Fields

data

object[]

The list of resources.

integer

A globally unique identifier of the resource.

external_id

null|string

An optional identifier manually assigned to questions by users with the Developer role in your organisation.

question_id

string

A unique identifier of the question within the onboarding form.

parent_question_id

null|string

This is the question_id of the parent question if it exists. It is used to retrieve a question's parent, enabling hierarchical organization of questions. This is particularly useful for groups of questions from repeatable entities, such as persons, businesses, or other repeaters. For example, in a form with questions about multiple individuals (e.g., Person 1, Person 2), the parent_question_id links each nested question (like "First Name" or "Last Name") to its corresponding parent entity. By querying with the parent_question_id, you can determine which person or entity a specific question belongs to within the form structure. Repeatable entity questions will always have an empty answer field.

linked_to_parent_answer_option

null|string

If this question is a child of a "true_false" question, this field will contain the option of the parent question that this question is linked to. For example if the parent question has a "Yes" and "No" option, the parent question's answer is "Yes", and this field is "Yes", then this question is visible. If this field is "No", then this question is hidden.

title

string

The question title.

answer

null|string

The answer provided to the question. This is null for questions that have not been answered yet.

type

string

The type of question. Possible values: "true_false", "number", "datepicker", "dropdown", "text", "textarea", "url", "repeater", "country", "currency", "person-entity", "business-entity", "upload", and "phone".

created_at

string

The date and time the resource was created. An ISO 8601 date string.

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

Auth

Bearer

Headers

Body

{ "external_ids": [ "ID123" ], "page": 1, "per_page": 10, "onboarding_form_ids": null }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/onboarding-form-questions/searches" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"external_ids\": [
        \"ID123\"
    ],
    \"page\": 1,
    \"per_page\": 10,
    \"onboarding_form_ids\": null
}"

Example response:

{
    "data": [
        {
            "id": 164,
            "question_id": 2,
            "parent_question_id": null,
            "title": "Yes / No",
            "answer": "Yes",
            "type": "true_false",
            "created_at": "2024-04-18T09:55:40.000000Z",
            "updated_at": "2024-04-18T09:55:48.000000Z"
        },
        {
            "id": 178,
            "question_id": 3,
            "parent_question_id": null,
            "title": "Date of birth",
            "answer": "2024-04-02",
            "type": "datepicker",
            "created_at": "2024-04-19T07:47:24.000000Z",
            "updated_at": "2024-04-19T07:58:17.000000Z"
        },
        {
            "id": 168,
            "question_id": 4,
            "parent_question_id": null,
            "title": "True or false",
            "answer": "Yes",
            "type": "true_false",
            "created_at": "2024-04-18T10:01:46.000000Z",
            "updated_at": "2024-04-18T10:01:54.000000Z"
        },
        {
            "id": 173,
            "question_id": 5,
            "parent_question_id": null,
            "title": "Yes / No",
            "answer": "Yes",
            "type": "true_false",
            "created_at": "2024-04-18T11:40:29.000000Z",
            "updated_at": "2024-04-18T11:51:59.000000Z"
        },
        {
            "id": 175,
            "question_id": 6,
            "parent_question_id": null,
            "title": "Name",
            "answer": "John Doe",
            "type": "text",
            "created_at": "2024-04-18T11:51:56.000000Z",
            "updated_at": "2024-04-18T11:52:01.000000Z"
        },
        {
            "id": 176,
            "question_id": 7,
            "parent_question_id": null,
            "title": "E-mail",
            "answer": "[email protected]",
            "type": "text",
            "created_at": "2024-04-18T11:51:56.000000Z",
            "updated_at": "2024-04-18T11:52:04.000000Z"
        },
        {
            "id": 548,
            "question_id": 8,
            "parent_question_id": null,
            "title": "Name",
            "answer": null,
            "type": "text",
            "created_at": "2024-05-28T11:15:07.000000Z",
            "updated_at": "2024-05-28T11:15:07.000000Z"
        },
        {
            "id": 170,
            "question_id": 9,
            "parent_question_id": null,
            "title": "Website",
            "answer": null,
            "type": "url",
            "created_at": "2024-04-18T10:01:46.000000Z",
            "updated_at": "2024-05-07T07:39:07.000000Z"
        },
        {
            "id": 166,
            "question_id": 10,
            "parent_question_id": null,
            "title": "Please give a number",
            "answer": "2",
            "type": "number",
            "created_at": "2024-04-18T10:01:46.000000Z",
            "updated_at": "2024-04-23T12:42:32.000000Z"
        },
        {
            "id": 167,
            "question_id": 11,
            "parent_question_id": null,
            "title": "Website",
            "answer": "http://example.com",
            "type": "url",
            "created_at": "2024-04-18T10:01:46.000000Z",
            "updated_at": "2024-04-23T12:42:38.000000Z"
        },
        {
            "id": 171,
            "question_id": 12,
            "parent_question_id": null,
            "title": "Choose a fruit",
            "answer": null,
            "type": "dropdown",
            "created_at": "2024-04-18T10:01:46.000000Z",
            "updated_at": "2024-05-07T07:39:10.000000Z"
        },
        {
            "id": 172,
            "question_id": 13,
            "parent_question_id": null,
            "title": "Choose another fruit",
            "answer": "a",
            "type": "dropdown",
            "created_at": "2024-04-18T10:01:46.000000Z",
            "updated_at": "2024-04-23T12:42:40.000000Z"
        },
        {
            "id": 177,
            "question_id": 14,
            "parent_question_id": null,
            "title": "Please upload your document",
            "answer": null,
            "type": "upload",
            "created_at": "2024-04-18T11:51:56.000000Z",
            "updated_at": "2024-04-18T11:51:56.000000Z"
        },
        {
            "id": 189,
            "question_id": 15,
            "parent_question_id": null,
            "title": "Persons to email",
            "answer": null,
            "type": "repeater",
            "created_at": "2024-04-22T08:11:43.000000Z",
            "updated_at": "2024-04-23T14:28:48.000000Z"
        },
        {
            "id": 185,
            "question_id": 16,
            "parent_question_id": 15,
            "title": "E-mail",
            "answer": null,
            "type": "text",
            "created_at": "2024-04-22T08:11:43.000000Z",
            "updated_at": "2024-04-23T14:28:48.000000Z"
        },
        {
            "id": 169,
            "question_id": 17,
            "parent_question_id": null,
            "title": "Please choose another number",
            "answer": "2",
            "type": "number",
            "created_at": "2024-04-18T10:01:46.000000Z",
            "updated_at": "2024-04-23T12:43:29.000000Z"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 13,
        "per_page": 15,
        "to": 15,
        "total": 187
    }
}

Download `upload` question file

GET

https://app.pascal.vartion.com

/api/v1/onboarding-form-question-uploads/{id}

requires authentication

Download an uploaded file for a question in an onboarding form.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

*/*

OrganizationId

Example:

URL Parameters

integer

required

The ID of the onboarding form question.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.pascal.vartion.com/api/v1/onboarding-form-question-uploads/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: */*" \
    --header "OrganizationId: 1"

Example response:

One time case links

The usual flow for a one time case link is as follows:

Create a one time case link using your personal access token.
Store the generated one time case link id and token somewhere secure.
Use a one time case link (this is done by your user). See: Authenticate using a one time case link

Create one time case links

POST

https://app.pascal.vartion.com

/api/v1/one-time-case-links

requires authentication

Create one time case links.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

case_uuid

uuid

required

The UUID of the case.

Example:

ac6962da-4ff0-42ad-b5ee-35153d15e924

user_email

required

The email address of the user that will use the link.

Example:

[email protected]

return_url

url

The url that the user will be redirected to when they finish resolving the case. If no return_url is supplied, the window is closed instead. (this only works when the page is opened in a new tab)

Example:

https://localhost

expires_at

datetime

required

When the link should expire. This needs to be later than "now" and less than 31 days from now.

Example:

1970-01-31 23:00:00

interface_language

string

The language that the user interface should be displayed in. Must be one of: en-gb, en, nl, fr, ru, or es.

Example:

en-gb

Response Fields

case_uuid

string

The UUID of the case associated with this resource.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

created_by_id

integer

The ID of the user who created this resource.

expires_at

string

The date and time when the link expires. An ISO 8601 date string.

integer

A globally unique identifier of the resource.

return_url

null|string

The URL that the user will be redirected to when they finish resolving the case.

token

string

The token for the one time link. This is only returned once when creating the link.

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

user_id

integer

The user linked to the resource.

Auth

Bearer

Headers

Body

{ "case_uuid": "ac6962da-4ff0-42ad-b5ee-35153d15e924", "user_email": "[email protected]", "return_url": "https:\/\/localhost", "expires_at": "1970-01-31 23:00:00", "interface_language": "en-gb" }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/one-time-case-links" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"case_uuid\": \"ac6962da-4ff0-42ad-b5ee-35153d15e924\",
    \"user_email\": \"[email protected]\",
    \"return_url\": \"https:\\/\\/localhost\",
    \"expires_at\": \"1970-01-31 23:00:00\",
    \"interface_language\": \"en-gb\"
}"

Example response:

{
    "case_uuid": "ac6962da-4ff0-42ad-b5ee-35153d15e924",
    "created_at": "2023-08-14T10:50:25.000000Z",
    "created_by_id": 4,
    "expires_at": "2099-01-31T23:00:00.000000Z",
    "id": 11,
    "return_url": "https://localhost",
    "token": "ehgwKBKPPubqQ7CC",
    "updated_at": "2023-08-14T10:50:25.000000Z",
    "user_id": 13989
}

View a one time case link

GET

https://app.pascal.vartion.com

/api/v1/one-time-case-links/{id}

requires authentication

View a one time case link.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

URL Parameters

integer

required

The id of the one time case link.

Example:

Response Fields

case_uuid

string

The UUID of the case associated with this resource.

created_at

string

The date and time the resource was created. An ISO 8601 date string.

created_by_id

integer

The ID of the user who created this resource.

expires_at

string

The date and time when the link expires. An ISO 8601 date string.

integer

A globally unique identifier of the resource.

return_url

null|string

The URL that the user will be redirected to when they finish resolving the case.

updated_at

string

The date and time the resource was last updated. An ISO 8601 date string.

used_at

null|string

The date and time when the link was used, null if not yet used. An ISO 8601 date string.

user_id

integer

The user linked to the resource.

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.pascal.vartion.com/api/v1/one-time-case-links/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1"

Example response:

{
    "case_uuid": "ac6962da-4ff0-42ad-b5ee-35153d15e924",
    "created_at": "2023-08-14T10:50:25.000000Z",
    "created_by_id": 4,
    "expires_at": "2099-01-31T23:00:00.000000Z",
    "id": 11,
    "return_url": "https://localhost",
    "updated_at": "2023-08-14T10:50:25.000000Z",
    "used_at": null,
    "user_id": 13989
}

Delete a one time case link

DELETE

https://app.pascal.vartion.com

/api/v1/one-time-case-links/{id}

requires authentication

Delete a one time case link.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

URL Parameters

integer

required

The id of the one time case link.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://app.pascal.vartion.com/api/v1/one-time-case-links/1" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1"

Example response:

Headers


cache-control
                                                            : no-cache, private
content-type
                                                            : application/json
x-ratelimit-limit
                                                            : 1000
x-ratelimit-remaining
                                                            : 994
vary
                                                            : Precognition, Origin

{
    "message": ""
}

Authenticate using a one time case link

GET

https://app.pascal.vartion.com

/v1/one-time-case-link-authentication

Authenticate using a one time case link.
When successful, the user will be redirected to the page where they can resolve the linked case. When unsuccessful, the user will be redirected the the login page.

Headers

Content-Type

Example:

application/x-www-form-urlencoded

Example:

text/html

Body Parameters

integer

required

The one time case link ID.

Example:

token

The one time case link token.

required

Example:

fpncIktnu0GfUKJl

Headers

Body

Received response

Example request:

curl --request GET \
    --get "https://app.pascal.vartion.com/v1/one-time-case-link-authentication" \
    --header "Content-Type: application/x-www-form-urlencoded" \
    --header "Accept: text/html" \
    --data "id=1&token=fpncIktnu0GfUKJl"

Example response:

<!DOCTYPE html>
<html lang="en-gb">
...
</html>

Authenticate using a one time case link

POST

https://app.pascal.vartion.com

/v1/one-time-case-link-authentication

Headers

Content-Type

Example:

application/x-www-form-urlencoded

Example:

text/html

Body Parameters

integer

required

The one time case link ID.

Example:

token

The one time case link token.

required

Example:

fpncIktnu0GfUKJl

Headers

Body

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/v1/one-time-case-link-authentication" \
    --header "Content-Type: application/x-www-form-urlencoded" \
    --header "Accept: text/html" \
    --data "id=1&token=fpncIktnu0GfUKJl"

Example response:

<!DOCTYPE html>
<html lang="en-gb">
...
</html>

Reports

Generate case reports

POST

https://app.pascal.vartion.com

/api/v1/pdf/case

requires authentication

Start the generation of one or more PDF case reports. Cases to be used are selected using the filter parameter. An id is returned which can be used to check if the download is finished and download the PDF when it is finished.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

batch_name

string

Must not be larger than 255.

Example:

filename

string

Must not be larger than 255.

Example:

detailed

boolean

Example:

false

language

string

The language that the report should be generated in. Must be one of: en-gb, en, nl, fr, ru, or es.

Example:

en-gb

pages

string[]

Pages to include in the report. Must be one or more of: overview, input, policies, passport_verification, key_findings, audit, comments, unresolved, positive, negative.

Example:

["overview"]

comment

string

An additional comment to be displayed in the report.

Example:

Automatically generated from the Pascal API

to_email

boolean

Whether or not to send the report as an email to the API user.

Example:

false

filters

object

integer[]

Case IDs to be filtered on. Must not be smaller than 1.

type

string[]

Must be one of Person, Business, or Asset.

status

string[]

user_id

integer[]

Filter on case assignees using user ids. Use null for unassigned cases.

Example:

[1]

group_id

integer[]

Filter on case assignees using group ids.

Example:

[1]

organization_id

integer[]

Filter on cases from a specific organization (if token has access to multiple organizations).

origin

string[]

confidence

string[]

created_at

object

A date range, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

updated_at

object

A date range, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

name

string

Search on case names. Supports SQL LIKE wildcards. Must not be larger than 255.

client_id

integer[]

Cases associated to a list of clients. Must not be smaller than 1.

exclude_client_id

integer[]

Exclude cases associated to any of a list of clients. Must not be smaller than 1.

deleted

boolean

Example:

false

uuid

string[]

Search on case UUIDs. Supports SQL LIKE wildcards. This field must be a valid UUID.

Example:

["a2546955-de2d-4907-a533-0846ee46f719"]

query

string

Must not be larger than 255.

nationalities

string[]

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

country_of_birth

string[]

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

country_of_residence

string[]

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

date_of_birth

string[]

This field must be a valid date.

company_number

string

Must not be larger than 255.

Example:

address

string

Must not be larger than 255.

Example:

country

string[]

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

["NLD"]

identifier

string[]

The identifier of an asset. Must not be larger than 255.

risk

string[]

hit_resolution

string[]

required

Filter on the resolution status of hits associated to the case.

Example:

["positive"]

hit_source

string[]

required

Filter on the source of hits associated to the case.

hit_time_range

object

A date range for the associated hits, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

client_status

string[]

required

Filter on the status of associated clients.

Example:

["Active"]

clients

object

cases_count

integer[]

Filter on the number of cases in associated clients by defining a minimum and/or maximum. Must not be smaller than 0.

Example:

[1]

clients_count

integer[]

Filter on the number of clients in associated clients by defining a minimum and/or maximum. Must not be smaller than 0.

Example:

[1]

created_at

object

A date range for the creation date of associated clients, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

risk

string[]

Filter on the screening risk of associated clients.

Example:

["very high"]

updated_at

object

A date range for the update date of associated clients, always expanded to full days (start = 00:00:00, end = 23:59:59).

Example:

["2025-01-01","2025-01-31"]

identifier

string[]

Filter on the identifier of associated clients. Must not be larger than 255.

Example:

["ID123"]

Response Fields

string

The unique identifier of the batch. It can be used to check if the download is finished and download the PDF when it is finished.

Auth

Bearer

Headers

Body

{ "batch_name": "b", "filename": "n", "detailed": false, "language": "en-gb", "pages": [ "overview" ], "comment": "Automatically generated from the Pascal API", "to_email": false, "filters": { "id": null, "type": null, "status": null, "user_id": [ 1 ], "group_id": [ 1 ], "organization_id": null, "origin": null, "confidence": null, "created_at": [ "2025-01-01", "2025-01-31" ], "updated_at": [ "2025-01-01", "2025-01-31" ], "name": null, "client_id": null, "exclude_client_id": null, "deleted": false, "uuid": [ "a2546955-de2d-4907-a533-0846ee46f719" ], "query": null, "nationalities": [ "NLD" ], "country_of_birth": [ "NLD" ], "country_of_residence": [ "NLD" ], "date_of_birth": null, "company_number": "g", "address": "z", "country": [ "NLD" ], "identifier": null, "risk": null, "hit_resolution": [ "positive" ], "hit_source": null, "hit_time_range": [ "2025-01-01", "2025-01-31" ], "client_status": [ "Active" ], "clients": { "cases_count": [ 1 ], "clients_count": [ 1 ], "created_at": [ "2025-01-01", "2025-01-31" ], "risk": [ "very high" ], "updated_at": [ "2025-01-01", "2025-01-31" ], "identifier": [ "ID123" ] } } }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/pdf/case" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"batch_name\": \"b\",
    \"filename\": \"n\",
    \"detailed\": false,
    \"language\": \"en-gb\",
    \"pages\": [
        \"overview\"
    ],
    \"comment\": \"Automatically generated from the Pascal API\",
    \"to_email\": false,
    \"filters\": {
        \"user_id\": [
            1
        ],
        \"group_id\": [
            1
        ],
        \"created_at\": [
            \"2025-01-01\",
            \"2025-01-31\"
        ],
        \"updated_at\": [
            \"2025-01-01\",
            \"2025-01-31\"
        ],
        \"deleted\": false,
        \"uuid\": [
            \"a2546955-de2d-4907-a533-0846ee46f719\"
        ],
        \"nationalities\": [
            \"NLD\"
        ],
        \"country_of_birth\": [
            \"NLD\"
        ],
        \"country_of_residence\": [
            \"NLD\"
        ],
        \"company_number\": \"g\",
        \"address\": \"z\",
        \"country\": [
            \"NLD\"
        ],
        \"hit_resolution\": [
            \"positive\"
        ],
        \"hit_source\": null,
        \"hit_time_range\": [
            \"2025-01-01\",
            \"2025-01-31\"
        ],
        \"client_status\": [
            \"Active\"
        ],
        \"clients\": {
            \"cases_count\": [
                1
            ],
            \"clients_count\": [
                1
            ],
            \"created_at\": [
                \"2025-01-01\",
                \"2025-01-31\"
            ],
            \"risk\": [
                \"very high\"
            ],
            \"updated_at\": [
                \"2025-01-01\",
                \"2025-01-31\"
            ],
            \"identifier\": [
                \"ID123\"
            ]
        }
    }
}"

$client = new \GuzzleHttp\Client();
$response = $client->post(
    'https://app.pascal.vartion.com/api/v1/pdf/case',
    [
        'headers' => [
            'Authorization' => 'Bearer {YOUR_AUTH_KEY}',
            'Content-Type' => 'application/json',
            'Accept' => 'application/json',
            'OrganizationId' => 1,
        ],
        'json' => [
            'batch_name' => 'b',
            'filename' => 'n',
            'detailed' => false,
            'language' => 'en-gb',
            'pages' => [
                'overview',
            ],
            'comment' => 'Automatically generated from the Pascal API',
            'to_email' => false,
            'filters' => [
                'user_id' => [
                    1,
                ],
                'group_id' => [
                    1,
                ],
                'created_at' => [
                    '2025-01-01',
                    '2025-01-31',
                ],
                'updated_at' => [
                    '2025-01-01',
                    '2025-01-31',
                ],
                'deleted' => false,
                'uuid' => [
                    'a2546955-de2d-4907-a533-0846ee46f719',
                ],
                'nationalities' => [
                    'NLD',
                ],
                'country_of_birth' => [
                    'NLD',
                ],
                'country_of_residence' => [
                    'NLD',
                ],
                'company_number' => 'g',
                'address' => 'z',
                'country' => [
                    'NLD',
                ],
                'hit_resolution' => [
                    'positive',
                ],
                'hit_source' => null,
                'hit_time_range' => [
                    '2025-01-01',
                    '2025-01-31',
                ],
                'client_status' => [
                    'Active',
                ],
                'clients' => [
                    'cases_count' => [
                        1,
                    ],
                    'clients_count' => [
                        1,
                    ],
                    'created_at' => [
                        '2025-01-01',
                        '2025-01-31',
                    ],
                    'risk' => [
                        'very high',
                    ],
                    'updated_at' => [
                        '2025-01-01',
                        '2025-01-31',
                    ],
                    'identifier' => [
                        'ID123',
                    ],
                ],
            ],
        ],
    ]
);
$body = $response->getBody();
print_r(json_decode((string) $body));

import requests
import json

url = 'https://app.pascal.vartion.com/api/v1/pdf/case'
payload = {
    "batch_name": "b",
    "filename": "n",
    "detailed": false,
    "language": "en-gb",
    "pages": [
        "overview"
    ],
    "comment": "Automatically generated from the Pascal API",
    "to_email": false,
    "filters": {
        "user_id": [
            1
        ],
        "group_id": [
            1
        ],
        "created_at": [
            "2025-01-01",
            "2025-01-31"
        ],
        "updated_at": [
            "2025-01-01",
            "2025-01-31"
        ],
        "deleted": false,
        "uuid": [
            "a2546955-de2d-4907-a533-0846ee46f719"
        ],
        "nationalities": [
            "NLD"
        ],
        "country_of_birth": [
            "NLD"
        ],
        "country_of_residence": [
            "NLD"
        ],
        "company_number": "g",
        "address": "z",
        "country": [
            "NLD"
        ],
        "hit_resolution": [
            "positive"
        ],
        "hit_source": null,
        "hit_time_range": [
            "2025-01-01",
            "2025-01-31"
        ],
        "client_status": [
            "Active"
        ],
        "clients": {
            "cases_count": [
                1
            ],
            "clients_count": [
                1
            ],
            "created_at": [
                "2025-01-01",
                "2025-01-31"
            ],
            "risk": [
                "very high"
            ],
            "updated_at": [
                "2025-01-01",
                "2025-01-31"
            ],
            "identifier": [
                "ID123"
            ]
        }
    }
}
headers = {
  'Authorization': 'Bearer {YOUR_AUTH_KEY}',
  'Content-Type': 'application/json',
  'Accept': 'application/json',
  'OrganizationId': '1'
}

response = requests.request('POST', url, headers=headers, json=payload)
response.json()

const url = new URL(
    "https://app.pascal.vartion.com/api/v1/pdf/case"
);

const headers = {
    "Authorization": "Bearer {YOUR_AUTH_KEY}",
    "Content-Type": "application/json",
    "Accept": "application/json",
    "OrganizationId": "1",
};

let body = {
    "batch_name": "b",
    "filename": "n",
    "detailed": false,
    "language": "en-gb",
    "pages": [
        "overview"
    ],
    "comment": "Automatically generated from the Pascal API",
    "to_email": false,
    "filters": {
        "user_id": [
            1
        ],
        "group_id": [
            1
        ],
        "created_at": [
            "2025-01-01",
            "2025-01-31"
        ],
        "updated_at": [
            "2025-01-01",
            "2025-01-31"
        ],
        "deleted": false,
        "uuid": [
            "a2546955-de2d-4907-a533-0846ee46f719"
        ],
        "nationalities": [
            "NLD"
        ],
        "country_of_birth": [
            "NLD"
        ],
        "country_of_residence": [
            "NLD"
        ],
        "company_number": "g",
        "address": "z",
        "country": [
            "NLD"
        ],
        "hit_resolution": [
            "positive"
        ],
        "hit_source": null,
        "hit_time_range": [
            "2025-01-01",
            "2025-01-31"
        ],
        "client_status": [
            "Active"
        ],
        "clients": {
            "cases_count": [
                1
            ],
            "clients_count": [
                1
            ],
            "created_at": [
                "2025-01-01",
                "2025-01-31"
            ],
            "risk": [
                "very high"
            ],
            "updated_at": [
                "2025-01-01",
                "2025-01-31"
            ],
            "identifier": [
                "ID123"
            ]
        }
    }
};

fetch(url, {
    method: "POST",
    headers,
    body: JSON.stringify(body),
}).then(response => response.json());

Example response:

{
    "id": "1abd0c71-dadd-4dad-8e20-1bd83aea25b3",
    "created_at": "2024-06-10T12:00:00.000000Z",
    "finished_at": null
}

Download reports

GET

https://app.pascal.vartion.com

/api/v1/reports/{id}/download

requires authentication

Download a previously generated report, using a report id or a report job id.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/pdf

OrganizationId

Example:

URL Parameters

string

required

The ID of the report.

Example:

B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.pascal.vartion.com/api/v1/reports/B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15/download" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/pdf" \
    --header "OrganizationId: 1"

Example response:

PDF report file

Transaction monitoring risk config

Get risk config

GET

https://app.pascal.vartion.com

/api/v1/transaction-monitoring-risk-config

requires authentication

This endpoint returns the transaction monitoring risk configuration.

Note: Access to transaction monitoring is required to use this endpoint.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Response Fields

blocked_countries

sometimes|required|array

Countries that are currently blocked.

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://app.pascal.vartion.com/api/v1/transaction-monitoring-risk-config" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1"

Example response:

{
    "blocked_countries": [
        "NLD",
        "USA",
        "JPN"
    ]
}

Transactions

Import transactions

POST

https://app.pascal.vartion.com

/api/v1/transactions/import

requires authentication

Import a list of transactions asynchronously.

Note: Access to transaction monitoring is required to use this endpoint.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

transactions

object[]

required

An array of transactions to be imported. You can import up to 200 transactions per request.

client_account_number

string

required

The client bank account number (spaces will be automatically removed). Must not be larger than 255.

Example:

1234567890

client_swift_code

string

The client SWIFT/BIC code (spaces will be automatically removed). Must not be larger than 255.

Example:

ABNANL2A

client_bank_account_country

string

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

NLD

identifier

string

Unique identifier for the transaction. If provided and a transaction with the same identifier already exists, it will be skipped. If not provided, an ID will be generated automatically. Must not be larger than 255.

Example:

TXN123456

amount

number

required

The transaction amount. Must not be smaller than 0. Must not be larger than 999999999999999.

Example:

1000.5

currency

string

required

The currency code for the transaction amount.

Example:

EUR

direction

string

required

The direction of the transaction. Must be either "incoming" or "outgoing".

Example:

incoming

counter_party_name

string

The name of the counter party. Must not be larger than 255.

Example:

John Doe

counter_party_currency

string

The currency code for the counter party (if applicable).

Example:

USD

counter_party_account_number

string

required

The counter party bank account number (spaces will be automatically removed). Must not be larger than 255.

Example:

0987654321

counter_party_swift_code

string

The counter party SWIFT/BIC code (spaces will be automatically removed). Must not be larger than 255.

Example:

RABONL2U

counter_party_bank_name

string

The name of the counter party bank. Must not be larger than 255.

Example:

Rabobank

counter_party_bank_account_country

string

Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code.

Example:

NLD

description

string

Description or reference for the transaction. Must not be larger than 2000.

Example:

Invoice payment #12345

transaction_date

string

The date and time when the transaction occurred. Accepts ISO 8601 format with timezone information (e.g., 2023-08-02T14:30:00+02:00) or simple format (2023-08-02 14:30:00). This field must be a valid date.

Example:

2023-08-02T14:30:00+02:00

type

string

The type of transaction. Must not be larger than 255.

Example:

wire_transfer

balance_after_transaction

number

The account balance on the bank account after this transaction was processed. Must not be smaller than -999999999999999. Must not be larger than 999999999999999.

Example:

15000.75

batch_id

string

Example:

99cbb5f6-49a7-492c-a1de-92ff356d98d8

count

integer

Example:

150

Response Fields

string

The unique identifier of the batch. It can be used to check the status of the import using the 'Get batch' endpoint.

created_at

string

The date and time the batch was created. An ISO 8601 date string.

finished_at

string

The date and time the batch finished. Can be null if it is still processing. An ISO 8601 date string.

Auth

Bearer

Headers

Body

{ "transactions": [ { "client_account_number": "1234567890", "client_swift_code": "ABNANL2A", "client_bank_account_country": "NLD", "identifier": "TXN123456", "amount": 1000.5, "currency": "EUR", "direction": "incoming", "counter_party_name": "John Doe", "counter_party_currency": "USD", "counter_party_account_number": "0987654321", "counter_party_swift_code": "RABONL2U", "counter_party_bank_name": "Rabobank", "counter_party_bank_account_country": "NLD", "description": "Invoice payment #12345", "transaction_date": "2023-08-02T14:30:00+02:00", "type": "wire_transfer", "balance_after_transaction": 15000.75 } ], "batch_id": "99cbb5f6-49a7-492c-a1de-92ff356d98d8", "count": 150 }

Received response

Example request:

curl --request POST \
    "https://app.pascal.vartion.com/api/v1/transactions/import" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"transactions\": [
        {
            \"client_account_number\": \"1234567890\",
            \"client_swift_code\": \"ABNANL2A\",
            \"client_bank_account_country\": \"NLD\",
            \"identifier\": \"TXN123456\",
            \"amount\": 1000.5,
            \"currency\": \"EUR\",
            \"direction\": \"incoming\",
            \"counter_party_name\": \"John Doe\",
            \"counter_party_currency\": \"USD\",
            \"counter_party_account_number\": \"0987654321\",
            \"counter_party_swift_code\": \"RABONL2U\",
            \"counter_party_bank_name\": \"Rabobank\",
            \"counter_party_bank_account_country\": \"NLD\",
            \"description\": \"Invoice payment #12345\",
            \"transaction_date\": \"2023-08-02T14:30:00+02:00\",
            \"type\": \"wire_transfer\",
            \"balance_after_transaction\": 15000.75
        }
    ],
    \"batch_id\": \"99cbb5f6-49a7-492c-a1de-92ff356d98d8\",
    \"count\": 150
}"

Example response:

{
    "id": "1abd0c71-dadd-4dad-8e20-1bd83aea25b3",
    "created_at": "2024-06-10T12:00:00.000000Z",
    "finished_at": null
}