### Fetch Case Details via GET Request (Bash, PHP, Python, JavaScript) Source: https://app.pascal.vartion.com/docs/index Demonstrates how to retrieve case details from the API using a GET request. Includes examples for constructing the URL, setting headers, and handling query parameters. This method is useful for fetching specific case information and associated data like hit counts. ```bash curl --request GET \ --get "https://app.pascal.vartion.com/api/v1/cases/B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15?with[]=hitCounts&with[]=hitCountsPerSource" \ --header "Authorization: Bearer {YOUR_AUTH_KEY}" \ --header "Content-Type: application/json" \ --header "Accept: application/json" \ --header "OrganizationId: 1" ``` ```php $client = new \GuzzleHttp\Client(); $url = 'https://app.pascal.vartion.com/api/v1/cases/B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15'; $response = $client->get( $url, [ 'headers' => [ 'Authorization' => 'Bearer {YOUR_AUTH_KEY}', 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'OrganizationId' => 1, ], 'query' => [ 'with[0]' => 'hitCounts', 'with[1]' => 'hitCountsPerSource', ], ] ); $body = $response->getBody(); print_r(json_decode((string) $body)); ``` ```python import requests import json url = 'https://app.pascal.vartion.com/api/v1/cases/B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15' params = { 'with[0]': 'hitCounts', 'with[1]': 'hitCountsPerSource', } headers = { 'Authorization': 'Bearer {YOUR_AUTH_KEY}', 'Content-Type': 'application/json', 'Accept': 'application/json', 'OrganizationId': '1' } response = requests.request('GET', url, headers=headers, params=params) response.json() ``` ```javascript const url = new URL( "https://app.pascal.vartion.com/api/v1/cases/B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15" ); const params = { "with[0]": "hitCounts", "with[1]": "hitCountsPerSource", }; Object.keys(params) .forEach(key => url.searchParams.append(key, params[key])); const headers = { "Authorization": "Bearer {YOUR_AUTH_KEY}", "Content-Type": "application/json", "Accept": "application/json", "OrganizationId": "1", }; fetch(url, { method: "GET", headers, }).then(response => response.json()); ``` -------------------------------- ### Search Onboarding Forms API Request Examples Source: https://app.pascal.vartion.com/docs/index Demonstrates how to make a POST request to the onboarding forms search endpoint using cURL, PHP, Python, and JavaScript. It includes setting authentication headers, content type, and the request body with various search parameters. ```bash 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\"\ ]\ }" ``` ```php $client = new \GuzzleHttp\Client(); $url = 'https://app.pascal.vartion.com/api/v1/onboarding-forms/searches'; $response = $client->post( $url, [ 'headers' => [ 'Authorization' => 'Bearer {YOUR_AUTH_KEY}', 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'OrganizationId' => 1, ], 'json' => [ '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', ], ], ] ); $body = $response->getBody(); print_r(json_decode((string) $body)); ``` ```python import requests import json url = 'https://app.pascal.vartion.com/api/v1/onboarding-forms/searches' payload = { "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" ] } 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() ``` ```javascript const url = new URL( "https://app.pascal.vartion.com/api/v1/onboarding-forms/searches" ); const headers = { "Authorization": "Bearer {YOUR_AUTH_KEY}", "Content-Type": "application/json", "Accept": "application/json", "OrganizationId": "1", }; let body = { "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" ] }; fetch(url, { method: "POST", headers, body: JSON.stringify(body), }).then(response => response.json()); ``` -------------------------------- ### Fetch Transaction Monitoring Risk Config (Python) Source: https://app.pascal.vartion.com/docs/index Python example using the requests library to get transaction monitoring risk configuration. It shows how to define and send headers, including authentication and organization ID. ```python import requests import json url = 'https://app.pascal.vartion.com/api/v1/transaction-monitoring-risk-config' headers = { 'Authorization': 'Bearer {YOUR_AUTH_KEY}', 'Content-Type': 'application/json', 'Accept': 'application/json', 'OrganizationId': '1' } response = requests.request('GET', url, headers=headers) response.json() ``` -------------------------------- ### List Onboarding Forms with Filters Source: https://app.pascal.vartion.com/docs/.postman Retrieves a list of onboarding forms, supporting pagination via 'per_page' and 'page' parameters. Returns basic information for each form. No specific dependencies are mentioned, and the output is a JSON array of form objects. ```json { "description": "List onboarding forms using filters.\nReturning basic information on a list of onboarding forms.\nPaginating through results is possible using the per_page and page parameters." } ``` -------------------------------- ### Get One Time Case Link by ID (PHP) Source: https://app.pascal.vartion.com/docs/index Fetches a one-time case link by its ID using the Guzzle HTTP client. This example demonstrates setting up the request with necessary headers such as Authorization, Content-Type, Accept, and OrganizationId. The response body is decoded from JSON. ```php $client = new \GuzzleHttp\Client(); $url = 'https://app.pascal.vartion.com/api/v1/one-time-case-links/1'; $response = $client->get( $url, [ 'headers' => [ 'Authorization' => 'Bearer {YOUR_AUTH_KEY}', 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'OrganizationId' => 1, ], ] ); $body = $response->getBody(); print_r(json_decode((string) $body)); ``` -------------------------------- ### Create Onboarding Form using Python Source: https://app.pascal.vartion.com/docs/index This Python script demonstrates creating an onboarding form using the 'requests' library. It defines the API endpoint, headers, and the JSON payload required for the request. ```python import requests import json url = 'https://app.pascal.vartion.com/api/v1/onboarding-forms' payload = { "assignee_user_email": "gbailey@example.net", "onboarding_form_template_id": 27, "client_id": 35, "onboarding_form_question_answers": [ { "external_id": "company_name", "answer": "Acme Corp" }, { "external_id": "country", "answer": "NLD" } ], "status": "in progress", "external_users": [ { "first_name": "y", "last_name": "v", "email": "jdach@example.org" } ] } headers = { 'Authorization': 'Bearer {YOUR_AUTH_KEY}', 'Content-Type': 'application/json', 'Accept': 'application/json', 'OrganizationId': '1' } response = requests.post(url, headers=headers, data=json.dumps(payload)) print(response.json()) ``` -------------------------------- ### POST /api/v1/onboarding-form-questions/searches Source: https://app.pascal.vartion.com/docs/index Lists onboarding form questions using filters. Requires authentication. ```APIDOC ## POST /api/v1/onboarding-form-questions/searches ### Description List onboarding form questions using filters. Requires authentication. ### Method POST ### Endpoint https://app.pascal.vartion.com/api/v1/onboarding-form-questions/searches ### Headers - **Authorization** (string) - Required - Example: Bearer {YOUR_AUTH_KEY} - **Content-Type** (string) - Required - Example: application/json - **Accept** (string) - Required - Example: application/json - **OrganizationId** (integer) - Required - Example: 1 ### Request Body - **external_ids** (string[]) - Optional - Filter on specific question external IDs. Must not be larger than 200. Example: ["ID123"] - **page** (integer) - Optional - Page to be returned. Must not be smaller than 1. Example: 1 - **per_page** (integer) - Optional - Number of results per page. Must not be smaller than 1. Must not be larger than 1000. Example: 10 - **onboarding_form_ids** (integer[]) - Required - Filter on specific onboarding forms. Must not be smaller than 1. ### Request Example ```json { "external_ids": ["ID123"], "page": 1, "per_page": 10, "onboarding_form_ids": [1] } ``` ### Response #### Success Response (200) - **message** (string) - Description of the success response (if applicable, otherwise describe the returned data structure). #### Response Example ```json { "message": "Questions listed successfully." } ``` #### Error Response (401) - **message** (string) - Unauthorized action. #### Error Response Example ```json { "message": "This action is unauthorized." } ``` ``` -------------------------------- ### Get Case Hits Key Information - PHP Source: https://app.pascal.vartion.com/docs/index This PHP code uses the Guzzle HTTP client to fetch key information about case hits. It includes setting up the request URL, headers such as Authorization and OrganizationId, and then decodes the JSON response body. Ensure Guzzle is installed in your project. ```php $client = new \GuzzleHttp\Client(); $url = 'https://app.pascal.vartion.com/api/v1/cases/B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15/hits-key-information'; $response = $client->get( $url, [ 'headers' => [ 'Authorization' => 'Bearer {YOUR_AUTH_KEY}', 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'OrganizationId' => 1, ], ] ); $body = $response->getBody(); print_r(json_decode((string) $body)); ``` -------------------------------- ### GET Client by ID - Python Source: https://app.pascal.vartion.com/docs/index This Python script utilizes the `requests` library to fetch client data. It defines the API endpoint, headers including authentication and organization details, and makes a GET request. The response is then parsed as JSON. ```python import requests import json url = 'https://app.pascal.vartion.com/api/v1/clients/564' headers = { 'Authorization': 'Bearer {YOUR_AUTH_KEY}', 'Content-Type': 'application/json', 'Accept': 'application/json', 'OrganizationId': '1' } response = requests.request('GET', url, headers=headers) response.json() ``` -------------------------------- ### Create Client API Request (Bash, PHP, Python, JavaScript) Source: https://app.pascal.vartion.com/docs/index Examples of how to create a client resource using the API. This involves sending a POST request to the clients endpoint with necessary headers and a JSON payload. The response will contain the details of the newly created client. ```bash 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.\" }" ``` ```php $client = new \GuzzleHttp\Client(); $url = 'https://app.pascal.vartion.com/api/v1/clients'; $response = $client->post( $url, [ 'headers' => [ 'Authorization' => 'Bearer {YOUR_AUTH_KEY}', 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'OrganizationId' => 1, ], 'json' => [ 'name' => 'My client', 'identifier' => 'ID123', 'description' => 'A description of the client.', ], ] ); $body = $response->getBody(); print_r(json_decode((string) $body)); ``` ```python import requests import json url = 'https://app.pascal.vartion.com/api/v1/clients' payload = { "name": "My client", "identifier": "ID123", "description": "A description of the client." } 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() ``` ```javascript const url = new URL( "https://app.pascal.vartion.com/api/v1/clients" ); const headers = { "Authorization": "Bearer {YOUR_AUTH_KEY}", "Content-Type": "application/json", "Accept": "application/json", "OrganizationId": "1", }; let body = { "name": "My client", "identifier": "ID123", "description": "A description of the client." }; fetch(url, { method: "POST", headers, body: JSON.stringify(body), }).then(response => response.json()); ``` -------------------------------- ### POST /api/v1/onboarding-form-templates/searches Source: https://app.pascal.vartion.com/docs/index Lists onboarding form templates with options for pagination, filtering, and sorting. ```APIDOC ## POST /api/v1/onboarding-form-templates/searches ### Description Lists onboarding form templates. Paginating through results is possible using the per_page and page parameters. ### Method POST ### Endpoint https://app.pascal.vartion.com/api/v1/onboarding-form-templates/searches ### Headers - **Authorization** (string) - Required - Example: Bearer {YOUR_AUTH_KEY} - **Content-Type** (string) - Required - Example: application/json - **Accept** (string) - Required - Example: application/json - **OrganizationId** (integer) - Required - Example: 1 ### Parameters #### Request Body - **id** (integer[]) - Optional - Must not be smaller than 1. - **page** (integer) - Optional - Page to be returned. Must not be smaller than 1. Example: 1 - **per_page** (integer) - Optional - Number of results per page. Must not be smaller than 1. Must not be larger than 1000. Example: 10 - **updated_at** (object) - Optional - 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) - Optional - 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) - Optional - The sorting order for the results. Can be one of _asc_ or _desc_. Defaults to desc. Example: desc - **organization_id** (integer[]) - Optional - Must not be smaller than 1. - **name** (string) - Optional - Must not be larger than 255. ### Request Example ```json { "id": [1, 2], "page": 1, "per_page": 10, "updated_at": ["2025-01-01","2025-01-31"], "sort_by": "updated_at", "sort_order": "desc", "organization_id": [1], "name": "Example Template" } ``` ### Response #### Success Response (200) - **batch_id** (string) - The ID of the batch operation. ``` -------------------------------- ### GET Client by ID - JavaScript Source: https://app.pascal.vartion.com/docs/index This JavaScript code demonstrates how to retrieve client information using the `fetch` API. It constructs the URL and headers, including the authorization token and organization ID, and makes a GET request. The response is then processed as JSON. ```javascript const url = new URL( "https://app.pascal.vartion.com/api/v1/clients/564" ); const headers = { "Authorization": "Bearer {YOUR_AUTH_KEY}", "Content-Type": "application/json", "Accept": "application/json", "OrganizationId": "1", }; fetch(url, { method: "GET", headers, }).then(response => response.json()); ``` -------------------------------- ### GET Client by ID - PHP Source: https://app.pascal.vartion.com/docs/index This PHP code uses the Guzzle HTTP client to retrieve client information. It sets up the necessary headers, including authorization and organization ID, to make a GET request to the API. The response body is then decoded from JSON. ```php $client = new \GuzzleHttp\Client(); $url = 'https://app.pascal.vartion.com/api/v1/clients/564'; $response = $client->get( $url, [ 'headers' => [ 'Authorization' => 'Bearer {YOUR_AUTH_KEY}', 'Content-Type' => 'application/json', 'Accept' => 'application/json', 'OrganizationId' => 1, ], ] ); $body = $response->getBody(); print_r(json_decode((string) $body)); ``` -------------------------------- ### POST /api/v1/onboarding-form-templates/searches Source: https://app.pascal.vartion.com/docs/.postman List onboarding form templates with filtering and sorting options. ```APIDOC ## POST /api/v1/onboarding-form-templates/searches ### Description List onboarding form templates with filtering and sorting options. ### Method POST ### Endpoint {{baseUrl}}/api/v1/onboarding-form-templates/searches ### Parameters #### Header Parameters - **Content-Type** (string) - Required - application/json - **Accept** (string) - Required - application/json - **OrganizationId** (integer) - Required - The ID of the organization. #### Request Body - **page** (integer) - Optional - The page number for pagination. - **per_page** (integer) - Optional - The number of items per page. - **updated_at** (array) - Optional - Filter by update date range [start_date, end_date] (YYYY-MM-DD). - **sort_by** (string) - Optional - Field to sort by (e.g., 'updated_at'). - **sort_order** (string) - Optional - Sort order ('asc' or 'desc'). ### Request Example ```json { "page": 1, "per_page": 10, "updated_at": ["2025-01-01", "2025-01-31"], "sort_by": "updated_at", "sort_order": "desc" } ``` ### Response #### Success Response (200) - **[Response fields will be documented here based on the actual API response structure]** #### Response Example ```json { "example": "[Response body example]" } ``` ``` -------------------------------- ### Search Onboarding Form Questions (JavaScript) Source: https://app.pascal.vartion.com/docs/index This JavaScript code snippet demonstrates how to fetch onboarding form questions using the Fetch API. It constructs the URL, defines request headers, and prepares the JSON body for a POST request to the search endpoint. ```javascript const url = new URL( "https://app.pascal.vartion.com/api/v1/onboarding-form-questions/searches" ); const headers = { "Authorization": "Bearer {YOUR_AUTH_KEY}", "Content-Type": "application/json", "Accept": "application/json", "OrganizationId": "1", }; let body = { "external_ids": [ "ID123" ], "page": 1, "per_page": 10, "onboarding_form_ids": null }; fetch(url, { method: "POST", headers, body: JSON.stringify(body), }).then(response => response.json()); ``` -------------------------------- ### Get One Time Case Link by ID (Python) Source: https://app.pascal.vartion.com/docs/index Makes a GET request to retrieve a one-time case link using its ID. This Python script utilizes the `requests` library and defines headers including Authorization, Content-Type, Accept, and OrganizationId. The response is parsed as JSON. ```python import requests import json url = 'https://app.pascal.vartion.com/api/v1/one-time-case-links/1' headers = { 'Authorization': 'Bearer {YOUR_AUTH_KEY}', 'Content-Type': 'application/json', 'Accept': 'application/json', 'OrganizationId': '1' } response = requests.request('GET', url, headers=headers) response.json() ``` -------------------------------- ### Get Case Hits Key Information - Python Source: https://app.pascal.vartion.com/docs/index This Python script utilizes the 'requests' library to make a GET request to retrieve case hit information. It defines the API endpoint URL and necessary headers, including the authorization token and organization ID. The response is then parsed as JSON. ```python import requests import json url = 'https://app.pascal.vartion.com/api/v1/cases/B3b1a0de-E464-0660-dEBB-cE54cDE1a84b|15/hits-key-information' headers = { 'Authorization': 'Bearer {YOUR_AUTH_KEY}', 'Content-Type': 'application/json', 'Accept': 'application/json', 'OrganizationId': '1' } response = requests.request('GET', url, headers=headers) response.json() ``` -------------------------------- ### Create Onboarding Form (Python) Source: https://app.pascal.vartion.com/docs/index This Python snippet demonstrates how to create a new onboarding form using the requests library. It requires an authorization key and specifies the payload with user and form details. The response is then parsed as JSON. ```python import requests url = "https://app.pascal.vartion.com/api/v1/onboarding-forms" payload = { "assignee_user_email": "gbailey@example.net", "onboarding_form_template_id": 27, "client_id": 35, "onboarding_form_question_answers": [ { "external_id": "company_name", "answer": "Acme Corp" }, { "external_id": "country", "answer": "NLD" } ], "status": "in progress", "external_users": [ { "first_name": "y", "last_name": "v", "email": "jdach@example.org" } ] } 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() ``` -------------------------------- ### Create Onboarding Form Source: https://app.pascal.vartion.com/docs/.postman Creates a new onboarding form for an existing client. This action makes the form visible in the 'Onboarding' application. Requires client ID, template ID, and assignee email. ```json { "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" } ``` -------------------------------- ### GET /api/v1/clients/:id Source: https://app.pascal.vartion.com/docs/.postman Retrieves detailed information about a specific client using its unique identifier. ```APIDOC ## GET /api/v1/clients/:id ### Description Retrieves detailed information about a specific client using its unique identifier. ### Method GET ### Endpoint /api/v1/clients/:id #### Path Parameters - **id** (string) - Required - The ID of the client. #### Query Parameters None #### Request Body None ### Request Example ```bash GET /api/v1/clients/564 HTTP/1.1 Host: {{baseUrl}} Content-Type: application/json Accept: application/json OrganizationId: 1 ``` ### Response #### Success Response (200) - **id** (integer) - The unique identifier of the client. - **name** (string) - The name of the client. - **identifier** (string) - A unique identifier for the client. - **organization_id** (integer) - The ID of the organization the client belongs to. - **created_at** (string) - The timestamp when the client was created. - **updated_at** (string) - The timestamp when the client was last updated. - **description** (string) - A description of the client. - **status** (string) - The current status of the client (e.g., "Active"). - **assignee_user_id** (integer|null) - The ID of the user assigned to the client. - **onboarding_status** (string|null) - The current status of the client's onboarding process. - **onboarding_risk** (any|null) - Information regarding the onboarding risk. - **cases_count** (integer) - The number of cases associated with the client. - **risk** (number) - A risk score associated with the client. - **hits_total_count** (integer) - The total number of hits for the client. - **hits_unresolved_count** (integer) - The number of unresolved hits for the client. - **resolve_progress** (integer) - The progress of resolving issues for the client. - **approval_steps** (array) - A list of approval steps for the client. - **id** (integer) - The ID of the approval step. - **user_id** (integer|null) - The ID of the user who approved the step. - **approved** (boolean|null) - Indicates if the step was approved. - **updated_at** (string) - The timestamp when the approval step was last updated. - **approved_by_function** (string|null) - The function of the user who approved the step. - **user_name** (string|null) - The name of the user who approved the step. #### Response Example ```json { "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 } ] } ``` ``` -------------------------------- ### GET /api/v1/batches/:id Source: https://app.pascal.vartion.com/docs/.postman Retrieves the status and details of a specific batch import using its ID. ```APIDOC ## GET /api/v1/batches/:id ### Description Retrieves the status and details of a specific batch import using its ID. ### Method GET ### Endpoint {{baseUrl}}/api/v1/batches/:id ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the batch to retrieve. #### Query Parameters None #### Request Body None ### Request Example ```json { "example": "No request body needed for GET request." } ``` ### Response #### Success Response (200) - **id** (string) - The unique identifier for the batch import. - **createdAt** (string) - The timestamp when the batch import was created. - **finishedAt** (string or null) - The timestamp when the batch import finished (null if still processing). - **status** (string) - The current status of the batch (e.g., 'processing', 'completed', 'failed'). - **results** (object) - Details about the import results (e.g., number of successful imports, errors). #### Response Example ```json { "id": "1abd0c71-dadd-4dad-8e20-1bd83aea25b3", "createdAt": "2024-06-10T12:00:00.000000Z", "finishedAt": "2024-06-10T12:05:00.000000Z", "status": "completed", "results": { "successfulImports": 145, "failedImports": 5, "errors": [ { "accountNumber": "NL1234567890", "reason": "Invalid account number format" } ] } } ``` ``` -------------------------------- ### Create Onboarding Form using JavaScript Source: https://app.pascal.vartion.com/docs/index This JavaScript code snippet shows how to create an onboarding form using the Fetch API. It constructs the request with appropriate headers and a JSON body, then sends it to the specified API endpoint. ```javascript const url = 'https://app.pascal.vartion.com/api/v1/onboarding-forms'; const data = { "assignee_user_email": "gbailey@example.net", "onboarding_form_template_id": 27, "client_id": 35, "onboarding_form_question_answers": [ { "external_id": "company_name", "answer": "Acme Corp" }, { "external_id": "country", "answer": "NLD" } ], "status": "in progress", "external_users": [ { "first_name": "y", "last_name": "v", "email": "jdach@example.org" } ] }; fetch(url, { method: 'POST', headers: { 'Authorization': 'Bearer {YOUR_AUTH_KEY}', 'Content-Type': 'application/json', 'Accept': 'application/json', 'OrganizationId': '1' }, body: JSON.stringify(data) }) .then(response => response.json()) .then(data => { console.log('Success:', data); }) .catch((error) => { console.error('Error:', error); }); ``` -------------------------------- ### Create Onboarding Form using cURL Source: https://app.pascal.vartion.com/docs/index This snippet demonstrates how to create an onboarding form using a cURL request. It includes setting the Authorization, Content-Type, Accept, and OrganizationId headers, along with the JSON payload containing form details. ```bash 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\": \"gbailey@example.net\", \"onboarding_form_template_id\": 27, \"client_id\": 35, \"onboarding_form_question_answers\": [ { \"external_id\": \"company_name\", \"answer\": \"Acme Corp\" }, { \"external_id\": \"country\", \"answer\": \"NLD\" } ], \"status\": \"in progress\", \"external_users\": [ { \"first_name\": \"y\", \"last_name\": \"v\", \"email\": \"jdach@example.org\" } ] }" ``` -------------------------------- ### GET /api/v1/reports/:id/download Source: https://app.pascal.vartion.com/docs/.postman Downloads a generated PDF report using its batch ID. The Content-Type will be 'application/pdf'. ```APIDOC ## GET /api/v1/reports/:id/download ### Description Download the generated PDF report using the provided ID. ### Method GET ### Endpoint {{baseUrl}}/api/v1/reports/:id/download ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the report batch to download. #### Query Parameters None ### Request Example (No request body for GET request) ### Response #### Success Response (200) - Content-Type: application/pdf - The response body will be the PDF file content. #### Response Example (Binary data representing a PDF file) ``` -------------------------------- ### Get Case Hits Key Information Source: https://app.pascal.vartion.com/docs/.postman Retrieves key information related to hits for a specific case. ```APIDOC ## GET /api/v1/cases/:id/hits-key-information ### Description Retrieves key information associated with the hits of a specific case. ### Method GET ### Endpoint `/api/v1/cases/:id/hits-key-information` ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the case. ### Response #### Success Response (200) - **[Response fields will be detailed here based on the actual API response structure]** #### Response Example ```json { "example": "Response body for case hits key information" } ``` ```