### GET /api/v1/onboarding-form-question-uploads/{id} Source: https://app.pascal.vartion.com/docs.openapi Download an uploaded file for a question in an onboarding form. ```markdown ### Parameters - **OrganizationId** (string, header, optional) ### Responses #### 200 - application/pdf ### Example Usage ```bash curl -X GET "{{ config("app.url") }}/api/v1/onboarding-form-question-uploads/{id}" ``` ``` -------------------------------- ### GET /api/v1/clients/{id} Source: https://app.pascal.vartion.com/docs.openapi Get detailed information on a specific client. ```markdown ### Parameters - **with** (array (string), query, optional): Adds additional values to the result. Must be one of: labels. (example: ["labels"]) - **OrganizationId** (string, header, optional) ### Responses #### 200 - response - **id** (integer): A globally unique identifier of the client. (example: 1) - **created_at** (string): The date and time the client was created. An ISO 8601 date string. (example: "2025-08-28T13:40:59.000000Z") - **updated_at** (string): The date and time the client was last updated. An ISO 8601 date string. (example: "2025-08-28T14:20:59.000000Z") - **description** (string): The description of the client. (example: "A description of the client.") - **identifier** (string): A unique, case-sensitive identifier for the client. (example: "ABC-123") - **name** (string): The name of the client. (example: "My client") - **onboarding_risk** (string): The onboarding risk level of the client. Possible values: "very low", "low", "medium", "high", "very high". (example: null) - **onboarding_status** (string): The onboarding status of the client. Possible values: "waiting for client", "in review", "waiting for approval", "completed", "declined". (example: "waiting for approval") - **status** (string): The status of the client. Possible values: "Active", "Archived". (example: "Active") - **cases_count** (integer): The number of cases linked to the client. (example: 8) - **hits_total_count** (integer): The total number of hits linked to the client. (example: 0) - **hits_unresolved_count** (integer): The number of unresolved hits linked to the client. (example: 0) - **resolve_progress** (integer): The percentage of resolved hits linked to the client, between 0 and 100. (example: 100) - **risk** (number): The screening risk of the client, based on the highest risk of all linked cases. Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high). (example: 0.12) - **assignee_user_id** (string): The ID of the user assigned to the client. (example: null) - **organization_id** (integer): The globally unique identifier of the organisation that owns the client. (example: 1) - **approval_steps** (array (object)): The approval steps linked to the client. (example: [{"id":328,"updated_at":"2025-08-28T14:20:59.000000Z","approved":true,"approved_by_function":"Compliance Officer","user_id":2194,"user_name":"John Smith"},{"id":329,"updated_at":"2025-08-28T14:20:59.000000Z","approved":null,"approved_by_function":null,"user_id":null,"user_name":null}]) Array items: - **id** (integer): The ID of the approval step. (example: 328) - **updated_at** (string): The date and time the approval step was last updated. An ISO 8601 date string. (example: "2025-08-28T14:20:59.000000Z") - **approved** (boolean): The approval status. `true` means approved, `false` means explicitly rejected, and `null` means pending (not yet reviewed). (example: true) - **approved_by_function** (string): The organisation function name that approved this step. `null` if not yet approved. (example: "Compliance Officer") - **user_id** (integer): The ID of the user who approved this step. `null` if the step has not been approved yet. (example: 2194) - **user_name** (string): The name of the user at the time of approval. This field captures the user's name when the approval was made and does not change if the user's name is later updated. `null` if not yet approved. (example: "John Smith") - **labels** (array (object)): The labels linked to the client. Only present when requested by passing `labels` to the `with` parameter. (example: [{"id":5,"name":"High value","index":0,"color":"#475569"}]) Array items: - **id** (integer): A globally unique identifier of the label. (example: 5) - **name** (string): The name of the label. (example: "High value") - **index** (integer): The sort index of the label. (example: 0) - **color** (string): The color of the label. (example: "#475569") ### Example Usage ```bash curl -X GET "{{ config("app.url") }}/api/v1/clients/{id}?with=labels" ``` ``` -------------------------------- ### GET /api/v1/one-time-case-links/{id} Source: https://app.pascal.vartion.com/docs.openapi View a one time case link.
```markdown ### Parameters - **OrganizationId** (string, header, optional) ### Responses #### 200 - response - **id** (integer): A globally unique identifier of the link. (example: 11) - **created_at** (string): The date and time the link was created. An ISO 8601 date string. (example: "2023-08-14T10:50:25.000000Z") - **updated_at** (string): The date and time the link was last updated. An ISO 8601 date string. (example: "2023-08-14T10:50:25.000000Z") - **expires_at** (string): The date and time when the link expires. An ISO 8601 date string. (example: "2099-01-31T23:00:00.000000Z") - **return_url** (string): The URL that the user will be redirected to when they finish resolving the case. (example: "https://localhost") - **used_at** (string): The date and time when the link was used, `null` if not yet used. An ISO 8601 date string. (example: null) - **created_by_id** (integer): The ID of the user who created the link. (example: 4) - **user_id** (integer): The ID of the user linked to the link. (example: 13989) - **case_uuid** (string): The `uuid` of the linked case. (example: "ac6962da-4ff0-42ad-b5ee-35153d15e924") ### Example Usage ```bash curl -X GET "{{ config("app.url") }}/api/v1/one-time-case-links/{id}" ``` ``` -------------------------------- ### POST /api/v1/pdf/case Source: https://app.pascal.vartion.com/docs.openapi 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 PDF generation is finished using the 'Get batch' endpoint and download the PDF when it is finished using the 'Download reports' endpoint. ```markdown ### Parameters - **OrganizationId** (string, header, optional) ### Request Body **Content-Type:** application/json - **batch_name** (string): Must not be larger than 255. (example: "b") - **filename** (string): Must not be larger than 255. (example: "n") - **detailed** (boolean) (example: false) - **language** (string (en-gb|en|nl|fr|ru|es|de|pt|it|el|hi|ro|tr)): The language that the report should be generated in. Must be one of: en-gb, en, nl, fr, ru, es, de, pt, it, el, hi, ro, or tr. (example: "nl") ("en-gb"|"en"|"nl"|"fr"|"ru"|"es"|"de"|"pt"|"it"|"el"|"hi"|"ro"|"tr") - **pages** (array (string (overview|input|policies|passport_verification|key_findings|audit|comments|unresolved|positive|negative))): Pages to include in the report. Must be one or more of: overview, input, policies, passport_verification, key_findings, audit, comments, unresolved, positive, negative. (example: ["overview"]) - **comment** (string): An additional comment to be displayed in the report. (example: "Automatically generated from the Pascal API") - **to_email** (boolean): Whether or not to send the report as an email to the API user. (example: false) - **filters** (object) (example: []) - **id** (array (integer)): Case IDs to be filtered on. Must not be smaller than 1. (example: null) - **type** (array (string (Person|Business|Asset))): Must be one of Person, Business, or Asset. (example: null) - **status** (array (string (Preview|In review|On hold|Archived|Monitored))) (example: null) - **user_id** (array (integer)): Filter on case assignees using user ids. Use null for unassigned cases. (example: [1]) - **group_id** (array (integer)): Filter on case assignees using group ids. (example: [1]) - **organization_id** (array (integer)): Filter on cases from one or more specific organizations (if token has access to multiple organizations). (example: null) - **origin** (array (string (person-check|business-check|hyperlink))) (example: null) - **confidence** (array (string (Exact|Relative))) (example: null) - **created_at** (object): A date range, always expanded to full days (start = 00:00:00, end = 23:59:59). (example: ["2025-01-01","2025-01-31"]) - **updated_at** (object): A date range, always expanded to full days (start = 00:00:00, end = 23:59:59). (example: ["2025-01-01","2025-01-31"]) - **searched_at** (object): A date range, always expanded to full days (start = 00:00:00, end = 23:59:59). (example: ["2025-01-01","2025-01-31"]) - **name** (string): Search on case names. Supports SQL LIKE wildcards. Must not be larger than 255. (example: null) - **client_id** (array (integer)): Filter on cases linked to specific clients. Must not be smaller than 1. (example: null) - **exclude_client_id** (array (integer)): Exclude cases linked to specific clients. Must not be smaller than 1. (example: null) - **deleted** (boolean) (example: false) - **uuid** (array (string)): Search on case UUIDs. Supports SQL LIKE wildcards. This field must be a valid UUID. (example: ["a2546955-de2d-4907-a533-0846ee46f719"]) - **query** (string): Search on case names, UUIDs, and IDs. Supports SQL LIKE wildcards for names and UUIDs. Must not be larger than 255. (example: null) - **nationalities** (array (string)): Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code. (example: ["NLD"]) - **aliases** (array (string)): Must not be larger than 255. (example: ["g"]) - **country_of_birth** (array (string)): Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code. (example: ["NLD"]) - **country_of_residence** (array (string)): Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code. (example: ["NLD"]) - **date_of_birth** (array (string)): This field must be a valid date. (example: null) - **company_number** (string): Must not be larger than 255. (example: "z") - **address** (string): Must not be larger than 255. (example: "m") - **country** (array (string)): Must be a valid ISO 3166-1 alpha-2 or alpha-3 country code. (example: ["NLD"]) - **identifier** (array (string)): The identifier of an asset. Must not be larger than 255. (example: null) - **labels** (array (string)): Filter on cases linked to labels with these names. Must not be larger than 255. (example: ["High value"]) - **risk** (array (string (very low|low|moderate|high|very high|no risk))) (example: null) - **hit_resolution** (array (string (unresolved|positive|negative))) (required): Filter on the resolution status of hits linked to the case. (example: ["positive"]) - **hit_source** (array (string (sanctions|enforcements|peps|news|other))) (required): Filter on the source of hits linked to the case. (example: null) - **hit_time_range** (object): A date range for the linked hits, always expanded to full days (start = 00:00:00, end = 23:59:59). (example: ["2025-01-01","2025-01-31"]) - **client_status** (array (string (Active|Archived))) (required): Filter on the status of linked clients. (example: ["Active"]) - **clients** (object) (example: null) - **cases_count** (array (integer)): Filter on the number of cases per linked client by defining a minimum and/or maximum. Must not be smaller than 0. (example: [1]) - **clients_count** (array (integer)): Filter on the number of clients per linked client by defining a minimum and/or maximum. Must not be smaller than 0. (example: [1]) - **created_at** (object): A date range for the creation date of linked clients, always expanded to full days (start = 00:00:00, end = 23:59:59). (example: ["2025-01-01","2025-01-31"]) - **risk** (array (string (very low|low|moderate|high|very high))): Filter on the screening risk of linked clients. (example: ["very high"]) - **updated_at** (object): A date range for the update date of linked clients, always expanded to full days (start = 00:00:00, end = 23:59:59). (example: ["2025-01-01","2025-01-31"]) - **identifier** (array (string)): Filter on the identifier of linked clients. Must not be larger than 255. (example: ["ID123"]) ### Responses #### 200 - response - **id** (string): The unique identifier of the batch. It can be used to check if the PDF generation is finished using the 'Get batch' endpoint and download the PDF when it is finished using the 'Download reports' endpoint. (example: "1abd0c71-dadd-4dad-8e20-1bd83aea25b3") - **createdAt** (string): The date and time the batch was created. An ISO 8601 date string. (example: "2024-06-10T12:00:00.000000Z") - **finishedAt** (string): The date and time the batch finished. Can be `null` if it is still processing. An ISO 8601 date string. (example: null) ### Example Usage ```bash curl -X POST "{{ config("app.url") }}/api/v1/pdf/case" \ -H "Content-Type: application/json" \ -d '{ "batch_name": "b", "filename": "n", "detailed": false, "language": "nl", "pages": [ "overview" ], "comment": "Automatically generated from the Pascal API", "to_email": false, "filters": [] }' ``` ``` -------------------------------- ### POST /api/v1/onboarding-form-questions/searches Source: https://app.pascal.vartion.com/docs.openapi List onboarding form questions using filters. ```markdown ### Parameters - **OrganizationId** (string, header, optional) ### Request Body **Content-Type:** application/json - **external_ids** (array (string)): Filter on specific question external IDs. Must not be larger than 200. (example: ["ID123"]) - **page** (integer): Page to be returned. Must not be smaller than 1. (example: 1) - **per_page** (integer): Number of results per page. Must not be smaller than 1. Must not be larger than 1000. (example: 10) - **onboarding_form_ids** (array (integer)) (required): Filter on specific onboarding forms. Must not be smaller than 1. (example: null) ### Responses #### 200 - response - **data** (array (object)): The list of onboarding form questions. (example: [{"id":164,"created_at":"2024-04-18T09:55:40.000000Z","updated_at":"2024-04-18T09:55:48.000000Z","answer":"Yes","parent_question_id":null,"question_id":2,"title":"Yes / No","type":"true_false"},{"id":178,"created_at":"2024-04-19T07:47:24.000000Z","updated_at":"2024-04-19T07:58:17.000000Z","answer":"2024-04-02","parent_question_id":null,"question_id":3,"title":"Date of birth","type":"datepicker"},{"id":168,"created_at":"2024-04-18T10:01:46.000000Z","updated_at":"2024-04-18T10:01:54.000000Z","answer":"Yes","parent_question_id":null,"question_id":4,"title":"True or false","type":"true_false"},{"id":173,"created_at":"2024-04-18T11:40:29.000000Z","updated_at":"2024-04-18T11:51:59.000000Z","answer":"Yes","parent_question_id":null,"question_id":5,"title":"Yes / No","type":"true_false"},{"id":175,"created_at":"2024-04-18T11:51:56.000000Z","updated_at":"2024-04-18T11:52:01.000000Z","answer":"John Doe","parent_question_id":null,"question_id":6,"title":"Name","type":"text"},{"id":176,"created_at":"2024-04-18T11:51:56.000000Z","updated_at":"2024-04-18T11:52:04.000000Z","answer":"john.doe@vartion.com","parent_question_id":null,"question_id":7,"title":"E-mail","type":"text"},{"id":548,"created_at":"2024-05-28T11:15:07.000000Z","updated_at":"2024-05-28T11:15:07.000000Z","answer":null,"parent_question_id":null,"question_id":8,"title":"Name","type":"text"},{"id":170,"created_at":"2024-04-18T10:01:46.000000Z","updated_at":"2024-05-07T07:39:07.000000Z","answer":null,"parent_question_id":null,"question_id":9,"title":"Website","type":"url"},{"id":166,"created_at":"2024-04-18T10:01:46.000000Z","updated_at":"2024-04-23T12:42:32.000000Z","answer":"2","parent_question_id":null,"question_id":10,"title":"Please give a number","type":"number"},{"id":167,"created_at":"2024-04-18T10:01:46.000000Z","updated_at":"2024-04-23T12:42:38.000000Z","answer":"http://example.com","parent_question_id":null,"question_id":11,"title":"Website","type":"url"},{"id":171,"created_at":"2024-04-18T10:01:46.000000Z","updated_at":"2024-05-07T07:39:10.000000Z","answer":null,"parent_question_id":null,"question_id":12,"title":"Choose a fruit","type":"dropdown"},{"id":172,"created_at":"2024-04-18T10:01:46.000000Z","updated_at":"2024-04-23T12:42:40.000000Z","answer":"a","parent_question_id":null,"question_id":13,"title":"Choose another fruit","type":"dropdown"},{"id":177,"created_at":"2024-04-18T11:51:56.000000Z","updated_at":"2024-04-18T11:51:56.000000Z","answer":null,"parent_question_id":null,"question_id":14,"title":"Please upload your document","type":"upload"},{"id":189,"created_at":"2024-04-22T08:11:43.000000Z","updated_at":"2024-04-23T14:28:48.000000Z","answer":null,"parent_question_id":null,"question_id":15,"title":"Persons to email","type":"repeater"},{"id":185,"created_at":"2024-04-22T08:11:43.000000Z","updated_at":"2024-04-23T14:28:48.000000Z","answer":null,"parent_question_id":15,"question_id":16,"title":"E-mail","type":"text"},{"id":169,"created_at":"2024-04-18T10:01:46.000000Z","updated_at":"2024-04-23T12:43:29.000000Z","answer":"2","parent_question_id":null,"question_id":17,"title":"Please choose another number","type":"number"}]) Array items: - **id** (integer): A globally unique identifier of the onboarding form question. (example: 164) - **created_at** (string): The date and time the onboarding form question was created. An ISO 8601 date string. (example: "2024-04-18T09:55:40.000000Z") - **updated_at** (string): The date and time the onboarding form question was last updated. An ISO 8601 date string. (example: "2024-04-18T09:55:48.000000Z") - **answer** (string): The answer provided to the onboarding form question. This is `null` for questions that have not been answered yet. (example: "Yes") - **parent_question_id** (string): This is the `question_id` of the parent question if it exists. It is used to retrieve a question's parent, enabling hierarchical organization of questions. This is particularly useful for groups of questions from repeatable entities, such as persons, businesses, or other repeaters. For example, in a form with questions about multiple individuals (e.g., Person 1, Person 2), the `parent_question_id` links each nested question (like "First Name" or "Last Name") to its corresponding parent entity. By querying with the `parent_question_id`, you can determine which person or entity a specific question belongs to within the form structure. Repeatable entity questions will always have an empty `answer` field. (example: null) - **question_id** (integer): A unique identifier of the onboarding form question within the onboarding form. (example: 2) - **title** (string): The title of the onboarding form question. (example: "Yes / No") - **type** (string): The type of the onboarding form question. Possible values: "true_false", "number", "datepicker", "dropdown", "text", "textarea", "url", "repeater", "country", "currency", "person-entity", "business-entity", "upload", and "phone". (example: "true_false") - **meta** (object) - **current_page** (integer) (example: 1) - **from** (integer) (example: 1) - **last_page** (integer) (example: 13) - **per_page** (integer) (example: 15) - **to** (integer) (example: 15) - **total** (integer) (example: 187) ### Example Usage ```bash curl -X POST "{{ config("app.url") }}/api/v1/onboarding-form-questions/searches" \ -H "Content-Type: application/json" \ -d '{ "external_ids": [ "ID123" ], "page": 1, "per_page": 10, "onboarding_form_ids": null }' ``` ``` -------------------------------- ### POST /api/v1/onboarding-forms Source: https://app.pascal.vartion.com/docs.openapi Create an onboarding form for an existing client.
Adding an onboarding form to a client will make it visible in the Onboarding application. ```markdown ### Parameters - **OrganizationId** (string, header, optional) ### Request Body **Content-Type:** application/json - **assignee_user_email** (string): This field must be a valid email address of a user in the organisation. Leaving this empty will assign the onboarding form to the authenticated user that performs the API call. (example: "gbailey@example.net") - **external_users** (array (object)): A list of all the individuals you want to send the onboarding form to. These individuals will receive an email requesting they fill out the form. Leave empty to use the form internally. (example: null) Array items: - **first_name** (string) (required): Must not be larger than 255. (example: "y") - **last_name** (string) (required): Must not be larger than 255. (example: "v") - **email** (string) (required): Please register using your business email. (example: "jdach@example.org") - **onboarding_form_template_id** (integer) (required): You can retrieve the available onboarding form templates by using the List Onboarding Form Templates endpoint. This endpoint will return a list of templates, including their IDs, which you can use when creating an onboarding form. Must not be smaller than 1. (example: 27) - **client_id** (integer) (required): To find the appropriate client ID, you can use the List Clients endpoint. This endpoint allows you to filter and retrieve clients. The response will include the client IDs, which you can use when creating an onboarding form. Alternatively new clients can be created using the Create Client which directly return the id of the created client. Must not be smaller than 1. (example: 35) - **onboarding_form_question_answers** (array (object)): A list of pre-filled answers for the form. Each answer must include `external_id` (matching a question's `external_id` from the onboarding form template) and an `answer` value. "upload" questions are not supported. The questions "repeater", "person-entity", "business-entity") cannot be answered directly, provide an answer to the sub-questions directly using the `external_id` of the subquestion. (example: [{"external_id":"company_name","answer":"Acme Corp"},{"external_id":"country","answer":"NLD"}]) Array items: - **external_id** (string) (required): This must match a question in the onboarding form template. This has to be unique. (example: "architecto") - **answer** (string): The answer to the question, formatted according to the question type. Answer format by question type:
text: string.
textarea: string.
number: numeric value (integer or float).
true_false: option label as string (e.g., "Yes" or "No").
dropdown: single option label (string) or array of labels if multiple selection enabled.
country: ISO 3166-1 alpha-3 country code or array if multiple selection enabled.
datepicker: date in `Y-m-d` format.
currency: ISO 4217 currency code.
phone: valid phone number in in E.164 format as string.
url: valid URL string or array if multiple selection enabled. (example: null) - **status** (string (in progress|submitted by client)): The initial status of the onboarding form. Can be one of in progress, submitted by client. Defaults to "in progress". If set to "in progress", the form will be sent to external users via email and can be edited by external users. (example: "in progress") ("in progress"|"submitted by client") ### Responses #### 201 - response - **id** (integer): A globally unique identifier of the onboarding form. (example: 273) - **created_at** (string): The date and time the onboarding form was created. An ISO 8601 date string. (example: "2025-03-31T11:22:10.000000Z") - **updated_at** (string): The date and time the onboarding form was last updated. An ISO 8601 date string. (example: "2025-03-31T11:22:10.000000Z") - **external_name** (string): The external name of the onboarding form, visible to external users. (example: "Standard Form") - **external_questions_open** (integer): The number of external questions that are still open in the onboarding form. (example: 1) - **external_questions_total** (integer): The total number of external questions in the onboarding form. (example: 1) - **name** (string): The internal name of the onboarding form. (example: "Standard Form") - **questions_open** (integer): The number of questions in the onboarding form that are still open. (example: 1) - **questions_total** (integer): The total number of questions in the onboarding form. (example: 1) - **status** (string): The status of the onboarding form. Possible values: "in progress", "submitted by client", "completed", "declined". (example: "in progress") - **assignee_user_id** (integer): The ID of the user assigned to the onboarding form. (example: 24) - **client_id** (integer): The ID of the client linked to the onboarding form. (example: 2834) - **organization_id** (integer): The globally unique identifier of the organisation that owns the onboarding form. (example: 10240) ### Example Usage ```bash curl -X POST "{{ config("app.url") }}/api/v1/onboarding-forms" \ -H "Content-Type: application/json" \ -d '{ "assignee_user_email": "gbailey@example.net", "external_users": null, "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" }' ``` ``` -------------------------------- ### POST /api/v1/clients Source: https://app.pascal.vartion.com/docs.openapi Create a new client. ```markdown ### Parameters - **OrganizationId** (string, header, optional) ### Request Body **Content-Type:** application/json - **name** (string) (required): The name of the client. Must not be larger than 255. (example: "My client") - **identifier** (string): A unique, case sensitive identifier for the client. Must not be larger than 255. (example: "ID123") - **description** (string): A description of the client. Must not be larger than 2000. (example: "A description of the client.") - **labels** (array (string)) (required): A list of label names to link to the created client. If a label with this name does not exist, it will be created automatically. Must not be larger than 255. (example: ["High value"]) ### Responses #### 200 - response - **id** (integer): A globally unique identifier of the client. (example: 13152) - **created_at** (string): The date and time the client was created. An ISO 8601 date string. (example: "2025-08-28T13:40:59.000000Z") - **updated_at** (string): The date and time the client was last updated. An ISO 8601 date string. (example: "2025-08-28T13:40:59.000000Z") - **description** (string): The description of the client. (example: "Accusantium quod voluptas ut. Rerum dolorum soluta rerum dolores. Ut officia quia velit maxime non ducimus.") - **name** (string): The name of the client. (example: "Pauline Lindgren III") - **onboarding_risk** (string): The onboarding risk level of the client. Possible values: "very low", "low", "medium", "high", "very high". (example: null) - **onboarding_status** (string): The onboarding status of the client. Possible values: "waiting for client", "in review", "waiting for approval", "completed", "declined". (example: null) - **status** (string): The status of the client. Possible values: "Active", "Archived". (example: "Active") - **cases_count** (integer): The number of cases linked to the client. (example: 8) - **hits_total_count** (integer): The total number of hits linked to the client. (example: 0) - **hits_unresolved_count** (integer): The number of unresolved hits linked to the client. (example: 0) - **resolve_progress** (integer): The percentage of resolved hits linked to the client, between 0 and 100. (example: 100) - **risk** (number): The screening risk of the client, based on the highest risk of all linked cases. Possible values: 0.03 (very low), 0.06 (low), 0.12 (moderate), 0.24 (high), 0.25 (very high). (example: 0.12) - **assignee_user_id** (string): The ID of the user assigned to the client. (example: null) - **organization_id** (integer): The globally unique identifier of the organisation that owns the client. (example: 91) - **approval_steps** (array) (example: []) ### Example Usage ```bash curl -X POST "{{ config("app.url") }}/api/v1/clients" \ -H "Content-Type: application/json" \ -d '{ "name": "My client", "identifier": "ID123", "description": "A description of the client.", "labels": [ "High value" ] }' ``` ``` -------------------------------- ### GET /api/v1/batches/{id} Source: https://app.pascal.vartion.com/docs.openapi This endpoint allows you to retrieve the status of a batch. Batches are created when importing cases, clients, transactions, bank accounts, or bank account balances. When a batch is finished (`finished_at` is not `null`), all jobs have been processed. This allows you to track the progress of long-running imports. A finished batch is deleted 48 hours after it is finished and can no longer be found. If a batch is not finished after 72 hours, it is also deleted and can no longer be found. You can find the batch ID in the response when starting an import. ```markdown ### Parameters - **OrganizationId** (string, header, optional) ### Responses #### 200 - response - **id** (string): The unique identifier of the batch. (example: "1abd0c71-dadd-4dad-8e20-1bd83aea25b3") - **created_at** (string): The date and time the batch was created. An ISO 8601 date string. (example: "2024-06-10T12:00:00.000000Z") - **finished_at** (string): The date and time the batch finished. Can be `null` if it is still processing. An ISO 8601 date string. (example: null) ### Example Usage ```bash curl -X GET "{{ config("app.url") }}/api/v1/batches/{id}" ``` ``` -------------------------------- ### POST /api/v1/onboarding-form-templates/searches Source: https://app.pascal.vartion.com/docs.openapi List onboarding form templates. Paginating through results is possible using the per_page and page parameters. ```markdown ### Parameters - **OrganizationId** (string, header, optional) ### Request Body **Content-Type:** application/json - **id** (array (integer)): Must not be smaller than 1. (example: null) - **page** (integer): Page to be returned. Must not be smaller than 1. (example: 1) - **per_page** (integer): Number of results per page. Must not be smaller than 1. Must not be larger than 1000. (example: 10) - **updated_at** (object): A date range, always expanded to full days (start = 00:00:00, end = 23:59:59). (example: ["2025-01-01","2025-01-31"]) - **sort_by** (string (created_at|updated_at|name)): Field to sort the results by. Can be one of created_at, updated_at, name. Defaults to updated_at. (example: "updated_at") ("created_at"|"updated_at"|"name") - **sort_order** (string): The sorting order for the results. Can be one of asc or desc. Defaults to desc. (example: "desc") - **organization_id** (array (integer)): Must not be smaller than 1. (example: null) - **name** (string): Must not be larger than 255. (example: null) ### Responses #### 200 - response - **data** (array (object)): The list of onboarding form templates. (example: [{"id":88,"created_at":"2024-11-28T08:34:03.000000Z","updated_at":"2024-11-28T08:34:03.000000Z","external_name":"Standard Form","name":"Standard Form","organization_id":15}]) Array items: - **id** (integer): A globally unique identifier of the onboarding form template. (example: 88) - **created_at** (string): The date and time the onboarding form template was created. An ISO 8601 date string. (example: "2024-11-28T08:34:03.000000Z") - **updated_at** (string): The date and time the onboarding form template was last updated. An ISO 8601 date string. (example: "2024-11-28T08:34:03.000000Z") - **external_name** (string): The external name of the onboarding form template seen by external users. (example: "Standard Form") - **name** (string): The name of the onboarding form template. (example: "Standard Form") - **organization_id** (integer): The globally unique identifier of the organisation that owns the onboarding form template. (example: 15) - **meta** (object): Pagination information. - **current_page** (integer) (example: 1) - **from** (integer) (example: 1) - **last_page** (integer) (example: 1) - **per_page** (integer) (example: 10) - **to** (integer) (example: 1) - **total** (integer) (example: 1) ### Example Usage ```bash curl -X POST "{{ config("app.url") }}/api/v1/onboarding-form-templates/searches" \ -H "Content-Type: application/json" \ -d '{ "id": null, "page": 1, "per_page": 10, "updated_at": [ "2025-01-01", "2025-01-31" ], "sort_by": "updated_at", "sort_order": "desc", "organization_id": null, "name": null }' ``` ``` -------------------------------- ### GET /api/v1/cases/{id}/hits-key-information Source: https://app.pascal.vartion.com/docs.openapi Retrieve the key information of a case's hits. ```markdown ### Parameters - **OrganizationId** (string, header, optional) ### Responses #### 200 - response - **unresolved** (object) - **enforcements** (array (object)) (example: [{"data":{"birth_dates":null,"connections":null,"name":"John Doe","nationalities":[{"country":"United States of America"}]},"resolution":"unresolved","source":"enforcements"}]) Array items: - **data** (object) - **birth_dates** (string) (example: null) - **connections** (string) (example: null) - **name** (string) (example: "John Doe") - **nationalities** (array (object)) (example: [{"country":"United States of America"}]) Array items: - **country** (string) (example: "United States of America") - **resolution** (string) (example: "unresolved") - **source** (string) (example: "enforcements") - **sanctions** (array (object)) (example: [{"data":{"birth_dates":null,"connections":null,"name":"John Doe","nationalities":[{"country":"United States of America"}]},"resolution":"unresolved","source":"sanctions"}]) Array items: - **positive** (object) ### Example Usage ```bash curl -X GET "{{ config("app.url") }}/api/v1/cases/{id}/hits-key-information" ``` ```