Bulk Findings Upload API (Early Access)

BalkanID Findings Upload CSV Format

In this section, we will explain the BalkanID Findings CSV format.

Sample CSV

Here is a sample of the BalkanID Findings CSV format:

| ID | Employee | Identity | Labels | Integration | Name | Description | Value | Metadata | Reason | Assigned To | Updated At | Updated By | Workflow Status |
|----------------------------------|---------------------------|----------------------|---------------------------------------------------------------------------------------------|---------------------------|-----------|-------------|-------|----------|--------|------------------------|------------|----------------------|
| 01HQGX4GKNBK1ESKJ8YA0M3GWX | john.doe@balkan.id | anujparihar@yahoo.com| "[[ { "key": "employee/terminated", "value": { "text": "Terminated" }, "explanation": { "termination_date": "2023-12-25" } } ]]" | github/01HKMMKX0HQ10X045PBAKBDAE3 | TestName3 | | test | john.doe@balkan.id | | john.doe@balkan.id| 2024-02-28T12:32:16.235468Z | 2024-02-28T12:32:16.235468Z | stopped |

The CSV follows the structure outlined above. It contains various fields such as ID, Employee, Identity, Labels, Integration, Name, Description, Value, Metadata, Reason, Assigned To, Updated At, and Updated By.

Column Definitions

Column Name	Column Description
ID	Optiona - A unique identifier for the finding. This is the internal balkan id of the finding. If it exists, finding will be updated
Employee	Required - The employee associated with the finding.
Identity	Required - The identity email associated with the finding.
Labels	Required - The labels associated with the finding. It is an array of array of label object
Integration	Required - The integration associated with the finding.
Name	Optiona - The name of the finding.
Description	Optional - The description of the finding.
Value	Optional - The value of the finding.
Metadata	Optional - The metadata of the finding.
Reason	Optional - The reason of the finding.
Assigned To	Required - The user to whom the finding is assigned.
Updated At	Optional - The updated at of the finding.
Updated By	Required - The updated by of the finding.
Workflow Status	Optional - The workflow status of the finding. It only takes the following values: "created", "stopped", "started", "completed", "stopped"

The labels column has the following format:

[
  [
    {
      "key": "employee/terminated",
      "explanation": {
        "termination_date": "2023-12-25"
      }
    }
  ]
]

Here in the above JSON - key is the label key (Required) - Explanation is the additional information about the label, it can be any key value pair.

Upload the CSV file via the pre-signed URL

After retrieving the pre-signed URL in the previous step, all that remains is to upload the CSV in BalkanID Findings CSV format to the pre-signed URL.
Below is a summary of the request using curl:

The request URL is the pre-signed URL from previous step.

The request method is PUT.

Required request body is the CSV in BalkanID Findings CSV format.

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

application/json

upload url response

Body

Upload URL endpoint response

url

string

required

The value is the pre-signed URL to which to upload your CSV file.

Example

{
    "url": "string"
}

Bulk Findings Upload API (Early Access)

BalkanID Findings Upload CSV Format#

Sample CSV#

Column Definitions#

Upload the CSV file via the pre-signed URL#

Request

Request samples

Responses

BalkanID Findings Upload CSV Format

Sample CSV

Column Definitions

Upload the CSV file via the pre-signed URL