{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "{{ config(\"app.url\") }}" } ], "info": { "name": "Pascal API Documentation", "_postman_id": "e3d64078-d76f-40b0-ab4a-2fe5efd522fb", "description": "", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Bank accounts", "description": "", "item": [ { "name": "Import bank accounts", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/bank-accounts\/import", "query": [], "raw": "{{baseUrl}}\/api\/v1\/bank-accounts\/import" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "OrganizationId", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"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\":true}],\"batch_id\":\"99cbb5f6-49a7-492c-a1de-92ff356d98d8\",\"count\":150}" }, "description": "Import a list of bank accounts asynchronously.\nYou can provide up to 200 bank accounts per request.\nThe returned `id` is a batch ID, which you can use to check the progress of the import using the 'Get batch' endpoint.\n\n**Note:** Access to transaction monitoring is required to use this endpoint." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"1abd0c71-dadd-4dad-8e20-1bd83aea25b3\",\n \"createdAt\": \"2024-06-10T12:00:00.000000Z\",\n \"finishedAt\": null\n}\n", "name": "" } ] } ] }, { "name": "Batches", "description": "", "item": [ { "name": "Get batch", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/batches\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/batches\/:id", "variable": [ { "id": "id", "key": "id", "value": "1abd0c71-dadd-4dad-8e20-1bd83aea25b3", "description": "The ID of the batch." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "OrganizationId", "value": "1" } ], "body": null, "description": "This endpoint allows you to retrieve the status of a batch.\nBatches are created when importing cases, clients, transactions, or bank accounts.\nWhen a batch is finished (`finished_at` is not `null`), all jobs have been processed.\nThis allows you to track the progress of long-running imports.\nA finished batch is deleted 48 hours after it is finished and can no longer be found.\nIf a batch is not finished after 72 hours, it is also deleted and can no longer be found.\nYou can find the batch ID in the response when starting an import." }, "response": [ { "header": [], "code": 200, "body": "{\n \"id\": \"1abd0c71-dadd-4dad-8e20-1bd83aea25b3\",\n \"created_at\": \"2024-06-10T12:00:00.000000Z\",\n \"finished_at\": null\n}\n", "name": "" } ] } ] }, { "name": "Cases", "description": "", "item": [ { "name": "Import cases", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/cases\/import", "query": [], "raw": "{{baseUrl}}\/api\/v1\/cases\/import" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "OrganizationId", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"cases\":[{\"type\":\"Person\",\"status\":\"In review\",\"name\":\"John Doe\",\"confidence\":\"Relative\",\"aliases\":[\"J. Doe\"],\"additional_terms\":[\"CEO\"],\"excluded_terms\":[\"Johnathan Doe\"],\"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\":\"2026-04-13\",\"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_email\":\"user@example.com\"}],\"deduplicate\":false,\"update_duplicates\":false,\"update_duplicates_clients\":false,\"batch_id\":\"99cbb5f6-49a7-492c-a1de-92ff356d98d8\",\"count\":150}" }, "description": "Import and search a list of new cases asynchronously.\nAfter making a request, a list of case UUIDs will be returned in the same order as your request.\nA list of \"imported\" case UUIDs will also be returned. This allows you to distinguish between cases that were imported and those that were deduplicated.\nYou can use the 'List cases' endpoint to check the status of the imported cases.\nThe returned `id` is a batch ID, which you can use to check the progress of the import using the 'Get batch' endpoint." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"1abd0c71-dadd-4dad-8e20-1bd83aea25b3\",\"createdAt\":\"2024-06-10T12:00:00.000000Z\",\"finishedAt\":null,\"uuids\":[\"a2546955-de2d-4907-a533-0846ee46f719\",\"d6253422-5197-429c-a8eb-4af7f6f7fffc\",\"052c7db6-bdca-4b95-b872-363b4287200f\"],\"imported\":[\"a2546955-de2d-4907-a533-0846ee46f719\"]}", "name": "" } ] }, { "name": "Create and search case", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/cases", "query": [], "raw": "{{baseUrl}}\/api\/v1\/cases" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" }, { "key": "OrganizationId", "value": "1" } ], "body": { "mode": "raw", "raw": "{\"type\":\"Person\",\"status\":\"In review\",\"name\":\"John Doe\",\"aliases\":[\"J. Doe\"],\"confidence\":\"Relative\",\"match_on_connections\":false,\"additional_terms\":[\"CEO\"],\"excluded_terms\":[\"Johnathan Doe\"],\"client_ids\":[2],\"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\",\"user_email\":\"user@example.com\"}" }, "description": "Create and search a single case synchronously, returning results immediately.\nCase deduplication is optional - when enabled, the first matching case will be searched for changes and returned instead of creating duplicates.\n