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

Pascal sends POST requests with `Content-Type: application/json` to your configured URL. The request body looks like:

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

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.

Cases

Import cases

POST

https://app.pascal.vartion.com

/api/v1/cases/import

requires authentication

This endpoint allows you to 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 case search API to check the status of the imported cases.

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

Example:

Relative

aliases

string[]

A list of additional name variations to be checked. Must not be larger than 255.

Example:

["J. Doe"]

additional_terms

string[]

A list words that boost confidence if present in any visible text field. 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[]

Must not be larger than 255.

Example:

["brklpyybiaqkwkh"]

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.passportVerificationForm is present.

Example:

Male

nationalities

string[]

required

[Person case] [Asset case] array of max 10 nationalities, nationality SO 3166-1 alpha-2 or alpha-3 country code string.

Example:

["NLD"]

country_of_birth

string

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

Example:

NLD

country_of_residence

string

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

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. This field must contain 7 items.

country

string

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

Example:

annkwkenigc

dateOfExpiry

string

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

Example:

2025-02-17

documentNumber

string

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

Example:

puiwycx

givenNames

string

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

Example:

hqxjaffaebrz

lastName

string

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

Example:

zobbizcmszhvrvccyjhzb

nationality

string

This field is required when cases.passportVerificationForm is present.

optionalData

string

Must not be larger than 14.

Example:

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.

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

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.

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.

update_duplicates_clients

boolean

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

batch_id

string

Because each import request is limited to 200 cases, you can use this parameter to add more cases 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:

2bba4ff7-95ec-3689-b613-71f9a7af6edd

count

integer

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

Example:

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": [ "brklpyybiaqkwkh" ], "sources": [ "sanctions" ], "gender": "Male", "nationalities": [ "NLD" ], "country_of_birth": "NLD", "country_of_residence": "NLD", "date_of_birth": "2000-01-31", "passportVerificationForm": { "country": "annkwkenigc", "dateOfExpiry": "2025-02-17", "documentNumber": "puiwycx", "givenNames": "hqxjaffaebrz", "lastName": "zobbizcmszhvrvccyjhzb", "nationality": null, "optionalData": "su" }, "company_number": "NL123", "country": "NL", "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": "2bba4ff7-95ec-3689-b613-71f9a7af6edd", "count": 16 }

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\": [
                \"brklpyybiaqkwkh\"
            ],
            \"sources\": [
                \"sanctions\"
            ],
            \"gender\": \"Male\",
            \"nationalities\": [
                \"NLD\"
            ],
            \"country_of_birth\": \"NLD\",
            \"country_of_residence\": \"NLD\",
            \"date_of_birth\": \"2000-01-31\",
            \"passportVerificationForm\": {
                \"country\": \"annkwkenigc\",
                \"dateOfExpiry\": \"2025-02-17\",
                \"documentNumber\": \"puiwycx\",
                \"givenNames\": \"hqxjaffaebrz\",
                \"lastName\": \"zobbizcmszhvrvccyjhzb\",
                \"optionalData\": \"su\"
            },
            \"company_number\": \"NL123\",
            \"country\": \"NL\",
            \"address\": \"3721 West Fork Street, Montana\",
            \"asset_type\": \"vessel\",
            \"identifier\": \"123456\"
        }
    ],
    \"deduplicate\": false,
    \"update_duplicates\": false,
    \"update_duplicates_clients\": false,
    \"batch_id\": \"2bba4ff7-95ec-3689-b613-71f9a7af6edd\",
    \"count\": 16
}"

$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' => [
                        'brklpyybiaqkwkh',
                    ],
                    'sources' => [
                        'sanctions',
                    ],
                    'gender' => 'Male',
                    'nationalities' => [
                        'NLD',
                    ],
                    'country_of_birth' => 'NLD',
                    'country_of_residence' => 'NLD',
                    'date_of_birth' => '2000-01-31',
                    'passportVerificationForm' => [
                        'country' => 'annkwkenigc',
                        'dateOfExpiry' => '2025-02-17',
                        'documentNumber' => 'puiwycx',
                        'givenNames' => 'hqxjaffaebrz',
                        'lastName' => 'zobbizcmszhvrvccyjhzb',
                        'optionalData' => 'su',
                    ],
                    'company_number' => 'NL123',
                    'country' => 'NL',
                    'address' => '3721 West Fork Street, Montana',
                    'asset_type' => 'vessel',
                    'identifier' => '123456',
                ],
            ],
            'deduplicate' => false,
            'update_duplicates' => false,
            'update_duplicates_clients' => false,
            'batch_id' => '2bba4ff7-95ec-3689-b613-71f9a7af6edd',
            'count' => 16,
        ],
    ]
);
$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": [
                "brklpyybiaqkwkh"
            ],
            "sources": [
                "sanctions"
            ],
            "gender": "Male",
            "nationalities": [
                "NLD"
            ],
            "country_of_birth": "NLD",
            "country_of_residence": "NLD",
            "date_of_birth": "2000-01-31",
            "passportVerificationForm": {
                "country": "annkwkenigc",
                "dateOfExpiry": "2025-02-17",
                "documentNumber": "puiwycx",
                "givenNames": "hqxjaffaebrz",
                "lastName": "zobbizcmszhvrvccyjhzb",
                "optionalData": "su"
            },
            "company_number": "NL123",
            "country": "NL",
            "address": "3721 West Fork Street, Montana",
            "asset_type": "vessel",
            "identifier": "123456"
        }
    ],
    "deduplicate": false,
    "update_duplicates": false,
    "update_duplicates_clients": false,
    "batch_id": "2bba4ff7-95ec-3689-b613-71f9a7af6edd",
    "count": 16
}
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": [
                "brklpyybiaqkwkh"
            ],
            "sources": [
                "sanctions"
            ],
            "gender": "Male",
            "nationalities": [
                "NLD"
            ],
            "country_of_birth": "NLD",
            "country_of_residence": "NLD",
            "date_of_birth": "2000-01-31",
            "passportVerificationForm": {
                "country": "annkwkenigc",
                "dateOfExpiry": "2025-02-17",
                "documentNumber": "puiwycx",
                "givenNames": "hqxjaffaebrz",
                "lastName": "zobbizcmszhvrvccyjhzb",
                "optionalData": "su"
            },
            "company_number": "NL123",
            "country": "NL",
            "address": "3721 West Fork Street, Montana",
            "asset_type": "vessel",
            "identifier": "123456"
        }
    ],
    "deduplicate": false,
    "update_duplicates": false,
    "update_duplicates_clients": false,
    "batch_id": "2bba4ff7-95ec-3689-b613-71f9a7af6edd",
    "count": 16
};

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

Example response:

{
    "id": "99cbb5f6-49a7-492c-a1de-92ff356d98d8",
    "totalJobs": 1,
    "pendingJobs": 1,
    "progress": 0,
    "createdAt": "2023-08-02T18:48:22.000000Z",
    "uuids": [
        "a2546955-de2d-4907-a533-0846ee46f719",
        "d6253422-5197-429c-a8eb-4af7f6f7fffc",
    ],
    "imported": [
        "a2546955-de2d-4907-a533-0846ee46f719",
    ]
}

Search cases

POST

https://app.pascal.vartion.com

/api/v1/cases/searches

requires authentication

This endpoint allows you to 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 between 1 and 1000. 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

Example:

updated_at

sort_order

string

Example:

asc

secondary_sort_by

string

secondary_sort_order

string

Example:

asc

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.

group_id

integer[]

Filter on case assigned to groups using group ids.

organization_id

integer[]

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

origin

string[]

confidence

string[]

created_at

string

updated_at

string

hit_time_range

string

name

string

Full text search on case names. 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.

transaction_id

integer[]

Must not be smaller than 1.

Example:

[1]

exclude_transaction_id

integer[]

Must not be smaller than 1.

Example:

[56]

deleted

boolean

uuid

string[]

Case UUIDs to be filtered on. Must not be larger than 36.

Example:

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

query

string

Must not be larger than 255.

nationalities

string[]

country

string[]

required

risk

string[]

custom_filters

string[]

Auth

Bearer

Headers

Body

{ "per_page": 10, "page": 1, "sort_by": "updated_at", "sort_order": "asc", "secondary_sort_by": null, "secondary_sort_order": "asc", "with": [ "hitCountsPerSource" ], "id": null, "type": null, "status": null, "user_id": null, "group_id": null, "organization_id": null, "origin": null, "confidence": null, "created_at": null, "updated_at": null, "hit_time_range": null, "name": null, "client_id": null, "exclude_client_id": null, "transaction_id": [ 1 ], "exclude_transaction_id": [ 56 ], "deleted": false, "uuid": [ "a2546955-de2d-4907-a533-0846ee46f719" ], "query": null, "nationalities": null, "country": null, "risk": null, "custom_filters": null }

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\": \"asc\",
    \"secondary_sort_order\": \"asc\",
    \"with\": [
        \"hitCountsPerSource\"
    ],
    \"transaction_id\": [
        1
    ],
    \"exclude_transaction_id\": [
        56
    ],
    \"deleted\": false,
    \"uuid\": [
        \"a2546955-de2d-4907-a533-0846ee46f719\"
    ],
    \"country\": null
}"

Example response:

{
    "data": [
        {
            "additional_terms": null,
            "address": null,
            "aliases": null,
            "case_groups": [],
            "case_users": [],
            "clients": [],
            "company_number": null,
            "confidence": "Relative",
            "country_of_birth": null,
            "country_of_residence": null,
            "created_at": "2023-08-02T18:48:22.000000Z",
            "date_of_birth": null,
            "deleted_at": null,
            "description": "Voluptas ad rem illum est dignissimos aut provident vitae.",
            "excluded_terms": [],
            "gender": null,
            "group": null,
            "group_id": null,
            "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
                }
            },
            "hits_unresolved_count": 0,
            "id": 2049050,
            "country": null,
            "monitoring_frequency": 28,
            "name": "My test case",
            "nationalities": null,
            "organization_id": 19,
            "origin": "import",
            "resolve_progress": 100,
            "risk": 0,
            "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": "In review",
            "type": "Person",
            "unresolved_risk": 0,
            "updated_at": "2023-08-02T18:48:22.000000Z",
            "user": null,
            "user_id": null,
            "uuid": "a2546955-de2d-4907-a533-0846ee46f719"
        }
    ],
    "meta": {
        "current_page": 1,
        "from": 1,
        "last_page": 1,
        "path": "http://pascal.vartion.com/api/v1/cases/searches",
        "per_page": 10,
        "to": 1,
        "total": 1
    }
}

Update case

PATCH

https://app.pascal.vartion.com

/api/v1/cases/{id}

requires authentication

This endpoint allows you to 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:

DCa85692-fEc7-080C-Fb6b-892d69b9D73C|9

Body Parameters

clients

string[]

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 match the regex /^[a-z0-9 ]*$/i.

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 larger than 255.

aliases

string[]

Must not be larger than 255.

confidence

string

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] array of max 10 nationalities, nationality ISO 3166-1 alpha-2 or alpha-3 country code string.

Example:

["NLD"]

country_of_birth

string

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

Example:

NLD

country_of_residence

string

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

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

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

Example:

skybty

dateOfExpiry

string

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

Example:

edezqibrehrff

documentNumber

string

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

Example:

idii

givenNames

string

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

Example:

kyjwzwpflcj

lastName

string

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

Example:

rbs

nationality

string

This field is required when cases.passportVerificationForm is present. This field must be 3 characters.

Example:

ikl

optionalData

string

Must not be larger than 14.

Example:

kfledrfklblqlb

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.

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

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.

Auth

Bearer

Headers

URL Parameters

Body

{ "clients": null, "excluded_terms": null, "status": "Monitored", "description": null, "monitoring_frequency": "0", "monitoring_frequency_sanctions": null, "monitoring_frequency_enforcements": null, "monitoring_frequency_peps": null, "monitoring_frequency_other": null, "monitoring_frequency_news": null, "name": null, "aliases": null, "confidence": null, "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": "skybty", "dateOfExpiry": "edezqibrehrff", "documentNumber": "idii", "givenNames": "kyjwzwpflcj", "lastName": "rbs", "nationality": "ikl", "optionalData": "kfledrfklblqlb" }, "company_number": "NL123", "country": "NL", "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/DCa85692-fEc7-080C-Fb6b-892d69b9D73C|9" \
    --header "Authorization: Bearer {YOUR_AUTH_KEY}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --header "OrganizationId: 1" \
    --data "{
    \"status\": \"Monitored\",
    \"monitoring_frequency\": \"0\",
    \"gender\": \"Male\",
    \"nationalities\": [
        \"NLD\"
    ],
    \"country_of_birth\": \"NLD\",
    \"country_of_residence\": \"NLD\",
    \"date_of_birth\": \"2000-01-31\",
    \"passportVerificationForm\": {
        \"country\": \"skybty\",
        \"dateOfExpiry\": \"edezqibrehrff\",
        \"documentNumber\": \"idii\",
        \"givenNames\": \"kyjwzwpflcj\",
        \"lastName\": \"rbs\",
        \"nationality\": \"ikl\",
        \"optionalData\": \"kfledrfklblqlb\"
    },
    \"company_number\": \"NL123\",
    \"country\": \"NL\",
    \"address\": \"3721 West Fork Street, Montana\",
    \"asset_type\": \"vessel\",
    \"identifier\": \"123456\"
}"

Example response:

{
    "additional_terms": null,
    "address": null,
    "aliases": null,
    "case_groups": [],
    "case_users": [],
    "clients": [],
    "company_number": null,
    "confidence": "Relative",
    "country_of_birth": null,
    "country_of_residence": null,
    "created_at": "2023-08-02T18:48:22.000000Z",
    "date_of_birth": null,
    "deleted_at": null,
    "description": "Voluptas ad rem illum est dignissimos aut provident vitae.",
    "excluded_terms": [],
    "gender": null,
    "group": null,
    "group_id": null,
    "id": 2049050,
    "country": null,
    "monitoring_frequency": 28,
    "name": "My test case",
    "nationalities": null,
    "organization_id": 19,
    "origin": "import",
    "risk": 0,
    "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": null,
    "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

This endpoint allows you to get 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:

aaA80f21-c6bA-5F28-822E-e039a4D524cB|27

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request GET \
    --get "https://app.pascal.vartion.com/api/v1/cases/aaA80f21-c6bA-5F28-822E-e039a4D524cB|27/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"
            }
        ]
    }
}

Clients

Create client

POST

https://app.pascal.vartion.com

/api/v1/clients

requires authentication

This endpoint allows you to 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

Must not be larger than 255.

Example:

bvswf

description

string

Must not be larger than 2000.

Example:

Magnam dicta provident labore consequuntur qui aperiam impedit.

assignee_user_id

integer

Example:

collaborator_user_ids

integer[]

Must not be smaller than 1.

Example:

[81]

Auth

Bearer

Headers

Body

{ "name": "bvswf", "description": "Magnam dicta provident labore consequuntur qui aperiam impedit.", "assignee_user_id": 10, "collaborator_user_ids": [ 81 ] }

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\": \"bvswf\",
    \"description\": \"Magnam dicta provident labore consequuntur qui aperiam impedit.\",
    \"assignee_user_id\": 10,
    \"collaborator_user_ids\": [
        81
    ]
}"

Get client

GET

https://app.pascal.vartion.com

/api/v1/clients/{id}

requires authentication

This endpoint allows you to 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:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

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

Example response:

Search clients

POST

https://app.pascal.vartion.com

/api/v1/clients/searches

requires authentication

This endpoint allows you to 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

custom_filters

string[]

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

Example:

["has_onboarding_forms"]

integer[]

required

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

not_id

integer[]

required

Must not be smaller than 1.

Example:

[30]

client_client_id

integer[]

required

Must not be smaller than 1.

Example:

[34]

not_client_client_id

integer[]

required

Must not be smaller than 1.

Example:

[47]

not_cases_id

integer[]

required

Must not be smaller than 1.

Example:

[44]

name

string

Search on client names. Supports SQL LIKE wildcards.

onboarding_status

string[]

Example:

["in review"]

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 between 1 and 1000. Must not be smaller than 1. Must not be larger than 1000.

Example:

sort_by

string

Example:

updated_at

sort_order

string

Example:

desc

status

string[]

updated_at

string

Auth

Bearer

Headers

Body

{ "custom_filters": [ "has_onboarding_forms" ], "id": null, "not_id": [ 30 ], "client_client_id": [ 34 ], "not_client_client_id": [ 47 ], "not_cases_id": [ 44 ], "name": null, "onboarding_status": [ "in review" ], "organization_id": null, "page": 1, "per_page": 10, "sort_by": "updated_at", "sort_order": "desc", "status": null, "updated_at": null }

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 "{
    \"custom_filters\": [
        \"has_onboarding_forms\"
    ],
    \"id\": null,
    \"not_id\": [
        30
    ],
    \"client_client_id\": [
        34
    ],
    \"not_client_client_id\": [
        47
    ],
    \"not_cases_id\": [
        44
    ],
    \"onboarding_status\": [
        \"in review\"
    ],
    \"organization_id\": null,
    \"page\": 1,
    \"per_page\": 10,
    \"sort_by\": \"updated_at\",
    \"sort_order\": \"desc\"
}"

Link clients

POST

https://app.pascal.vartion.com

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

requires authentication

This endpoint allows you to 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]

Unlink clients

DELETE

https://app.pascal.vartion.com

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

requires authentication

This endpoint allows you to 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]

Onboarding forms

Search onboarding forms

POST

https://app.pascal.vartion.com

/api/v1/onboarding-forms/searches

requires authentication

This endpoint allows you to 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 between 1 and 1000. Must not be smaller than 1. Must not be larger than 1000.

Example:

updated_at

string

sort_by

string

Example:

created_at

sort_order

string

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:

[45]

client_id

integer[]

Must not be smaller than 1.

Example:

[27]

with

string[]

required

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

Example:

["user"]

Auth

Bearer

Headers

Body

{ "id": null, "page": 1, "per_page": 10, "updated_at": null, "sort_by": "created_at", "sort_order": "desc", "organization_id": null, "external_user_ids": [ 45 ], "client_id": [ 27 ], "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,
    \"sort_by\": \"created_at\",
    \"sort_order\": \"desc\",
    \"external_user_ids\": [
        45
    ],
    \"client_id\": [
        27
    ],
    \"with\": [
        \"user\"
    ]
}"

Search onboarding form questions

POST

https://app.pascal.vartion.com

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

requires authentication

This endpoint allows you to search for onboarding form questions using filters.

The parent_question_id field 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.
Parent questions for repeatable entities will always have an empty answer field.

Headers

Authorization

Example:

Bearer {YOUR_AUTH_KEY}

Content-Type

Example:

application/json

Example:

application/json

OrganizationId

Example:

Body Parameters

page

integer

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

Example:

per_page

integer

number between 1 and 1000. 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.

Auth

Bearer

Headers

Body

{ "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 "{
    \"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": "john.doe@vartion.com",
            "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

This endpoint allows you to 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

This endpoint allows you to 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:

example@vartion.com

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

Auth

Bearer

Headers

Body

{ "case_uuid": "ac6962da-4ff0-42ad-b5ee-35153d15e924", "user_email": "example@vartion.com", "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\": \"example@vartion.com\",
    \"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

This endpoint allows you to 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:

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

This endpoint allows you to 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"

Authenticate using a one time case link

GET

https://app.pascal.vartion.com

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

This endpoint allows you to authenticate using a one time case link.
When successful, the user will be redirected to the page where they can resolve the linked case.

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

This endpoint allows you to authenticate using a one time case link.
When successful, the user will be redirected to the page where they can resolve the linked case.

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

This endpoint allows you to 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:

jhwlzrdiaokpee

filename

string

Must not be larger than 255.

Example:

wvzzaifnq

detailed

boolean

language

string

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

Example:

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.

filters
object

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

group_id
integer[]

Filter on case assigned to groups using group ids.

organization_id
integer[]

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

origin
string[]

confidence
string[]

created_at
string

updated_at
string

hit_time_range
string

name
string

Full text search on case names. 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.

transaction_id
integer[]

Must not be smaller than 1.

Example:

[44]

exclude_transaction_id
integer[]

Must not be smaller than 1.

Example:

[82]

deleted
boolean

uuid
string[]

Case UUIDs to be filtered on. Must not be larger than 36.

Example:

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

query
string

Must not be larger than 255.

nationalities
string[]

country
string[]

required

risk
string[]

custom_filters
string[]

Auth

:

Bearer

Headers

:

:

:

Body

{ "batch_name": "jhwlzrdiaokpee", "filename": "wvzzaifnq", "detailed": false, "language": "fr", "pages": [ "overview" ], "comment": "Automatically generated from the Pascal API", "to_email": false, "filters": { "id": null, "type": null, "status": null, "user_id": null, "group_id": null, "organization_id": null, "origin": null, "confidence": null, "created_at": null, "updated_at": null, "hit_time_range": null, "name": null, "client_id": null, "exclude_client_id": null, "transaction_id": [ 44 ], "exclude_transaction_id": [ 82 ], "deleted": false, "uuid": [ "a2546955-de2d-4907-a533-0846ee46f719" ], "query": null, "nationalities": null, "country": null, "risk": null, "custom_filters": null } }

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\": \"jhwlzrdiaokpee\", \"filename\": \"wvzzaifnq\", \"detailed\": false, \"language\": \"fr\", \"pages\": [ \"overview\" ], \"comment\": \"Automatically generated from the Pascal API\", \"to_email\": false, \"filters\": { \"transaction_id\": [ 44 ], \"exclude_transaction_id\": [ 82 ], \"deleted\": false, \"uuid\": [ \"a2546955-de2d-4907-a533-0846ee46f719\" ], \"country\": null } }"

$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' => 'jhwlzrdiaokpee', 'filename' => 'wvzzaifnq', 'detailed' => false, 'language' => 'fr', 'pages' => [ 'overview', ], 'comment' => 'Automatically generated from the Pascal API', 'to_email' => false, 'filters' => [ 'transaction_id' => [ 44, ], 'exclude_transaction_id' => [ 82, ], 'deleted' => false, 'uuid' => [ 'a2546955-de2d-4907-a533-0846ee46f719', ], 'country' => null, ], ], ] ); $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": "jhwlzrdiaokpee", "filename": "wvzzaifnq", "detailed": false, "language": "fr", "pages": [ "overview" ], "comment": "Automatically generated from the Pascal API", "to_email": false, "filters": { "transaction_id": [ 44 ], "exclude_transaction_id": [ 82 ], "deleted": false, "uuid": [ "a2546955-de2d-4907-a533-0846ee46f719" ], "country": null } } 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": "jhwlzrdiaokpee", "filename": "wvzzaifnq", "detailed": false, "language": "fr", "pages": [ "overview" ], "comment": "Automatically generated from the Pascal API", "to_email": false, "filters": { "transaction_id": [ 44 ], "exclude_transaction_id": [ 82 ], "deleted": false, "uuid": [ "a2546955-de2d-4907-a533-0846ee46f719" ], "country": null } }; fetch(url, { method: "POST", headers, body: JSON.stringify(body), }).then(response => response.json());

Example response:

{ "id": "99d92417-1264-4cce-9e86-e71a8357e044", "name": "Generating case reports...", "totalJobs": 1, "pendingJobs": 1, "progress": 0, "createdAt": "2023-08-09T11:02:04.000000Z", }

Download reports

GET

https://app.pascal.vartion.com

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

requires authentication

This endpoint allows you to 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

Accept

Example:

application/pdf

OrganizationId

Example:

1

URL Parameters

id
string

required

The ID of the report.

Example:

37CEAa5f-D1f2-c46E-a606-0ABef6825c80|8

Auth

:

Bearer

Headers

:

:

:

URL Parameters

:

Example request:

curl --request GET \ --get "https://app.pascal.vartion.com/api/v1/reports/37CEAa5f-D1f2-c46E-a606-0ABef6825c80|8/download" \ --header "Authorization: Bearer {YOUR_AUTH_KEY}" \ --header "Content-Type: application/json" \ --header "Accept: application/pdf" \ --header "OrganizationId: 1"

$client = new \GuzzleHttp\Client(); $response = $client->get( 'https://app.pascal.vartion.com/api/v1/reports/37CEAa5f-D1f2-c46E-a606-0ABef6825c80|8/download', [ 'headers' => [ 'Authorization' => 'Bearer {YOUR_AUTH_KEY}', 'Content-Type' => 'application/json', 'Accept' => 'application/pdf', 'OrganizationId' => 1, ], ] ); $body = $response->getBody(); print_r(json_decode((string) $body));

import requests import json url = 'https://app.pascal.vartion.com/api/v1/reports/37CEAa5f-D1f2-c46E-a606-0ABef6825c80|8/download' headers = { 'Authorization': 'Bearer {YOUR_AUTH_KEY}', 'Content-Type': 'application/json', 'Accept': 'application/pdf', 'OrganizationId': '1' } response = requests.request('GET', url, headers=headers) response.json()

const url = new URL( "https://app.pascal.vartion.com/api/v1/reports/37CEAa5f-D1f2-c46E-a606-0ABef6825c80|8/download" ); const headers = { "Authorization": "Bearer {YOUR_AUTH_KEY}", "Content-Type": "application/json", "Accept": "application/pdf", "OrganizationId": "1", }; fetch(url, { method: "GET", headers, }).then(response => response.json());

Example response:

PDF report file

Report is not (yet) generated