Developer Hub
Request Demo
Request Demo
Support
  1. Configuration
  • Getting Started
    • Introduction
  • API Reference
    • Admins
      • Bulk Admins Download API (Early Access)
    • Apps
      • Bulk Apps Download API (Early Access)
    • Business Owners
      • Bulk Business Owners Download API (Early Access)
      • Bulk Business Owners Upload API (Early Access)
    • Campaigns
      • Bulk Campaigns Download API (Early Access)
      • Bulk Campaigns Upload API (Early Access)
    • Configuration
      • Bulk Applied Labels Upload API (Early Access)
        POST
      • Bulk Entity Finding Rules Download API (Early Access)
        POST
      • Bulk Custom Insights (Entity Rules) Download API (Early Access)
        POST
      • Bulk Filters Download API (Early Access)
        POST
      • Bulk Filters Upload API (Early Access)
        POST
      • Bulk Findings Download API (Early Access)
        POST
      • Bulk Findings Upload API (Early Access)
        POST
      • Bulk Labels Download API (Early Access)
        POST
      • Bulk Labels Upload API (Early Access)
        POST
      • Bulk Privileged Download API (Early Access)
        POST
      • Bulk Privileged Upload API (Early Access)
        POST
      • Bulk RBAC Download API (Early Access)
        POST
      • Bulk RBAC Upload API (Early Access)
        POST
      • Bulk RBAC2 Download API (Early Access)
        POST
      • Bulk RBAC2 Upload API (Early Access)
        POST
      • Bulk Rules Download API (Early Access)
        POST
      • Bulk Rules Upload API (Early Access)
        POST
    • Employees
      • Bulk Employees Download API (Early Access)
      • Bulk Employees Upload API (Early Access)
    • Entitlements
      • Bulk Entitlements Download API (Early Access)
      • Bulk Entitlements Upload API (Early Access)
    • Entities
      • Bulk Entities Download API (Early Access)
      • Bulk Entities Upload API (Early Access)
    • EntityInsights
      • Bulk Entity Insights Download API (Early Access)
      • Bulk Entity Insights Upload API (Early Access)
    • EntityRelations
      • Bulk Entity Relations Download API (Early Access)
      • Bulk Entity Relations Upload API (Early Access)
    • EntityRBAC
      • Bulk Entity RBAC Download API
      • Bulk Entity RBAC Upload API
    • Integrations
      • Bulk Integrations Download API (Early Access)
      • Bulk Integrations Upload API (Early Access)
    • Purposes
      • Bulk Purposes Download API (Early Access)
      • Bulk Purposes Upload API (Early Access)
    • Relations
      • Bulk Relations Download API (Early Access)
      • Bulk Relations Upload API (Early Access)
    • Requests
      • Bulk Requests Download API (Early Access)
      • Bulk Requests Upload API (Early Access)
    • Reviews
      • Bulk Reviews Download API (Early Access)
      • Bulk Reviews Upload API (Early Access)
    • Playbooks
      • Bulk Playbook Templates Download API (Early Access)
      • Bulk Playbook Templates API (Early Access)
    • Webhooks
      • Bulk Webhook Templates Download API (Early Access)
      • Bulk Webhook Templates API (Early Access)
  • Playbooks
    • Overview
  1. Configuration

Bulk Findings Download API (Early Access)

POST
https://app.balkan.id/api/rest/v0/findings/download-url
Configuration

BalkanID Findings Download CSV Format#

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

Sample CSV#

IDEmployeeIdentityLabelsIntegrationNameDescriptionValueMetadataReasonRuleAssigned ToWorkflow StatusCreated AtUpdated AtActivity Log
01HQQV71BBDVVN5NVQ8Q7X1A3Xjohn.doe@balkan.idjohn.doe@balkan.id[[{"key": "entitlement/overentitled", "value": {"text": "Overentitled"}, "explanation": null}]]google/01HQQTMRVQGT0M4ARWR9YN3BP6John is OverentitledJohn is overentitled on Google, since they haves access to groups that are not usually found with people of their job title.{}[]Testrule_01ABCD123john.doe@balkan.idstarted2024-02-28T12:32:16.235468Z2024-04-30T12:48:04.346933Z[{"Actor Email":"patrick@example.com","Actor Name":"Patrick","Activity Metadata":[[{"action": "accept_risk", "comments": "Dummy comment", "action_type": "default"}]],"Previous Status":","Status":"created","Timestamp":"2024-02-28T12:48:06+00:00"}, {"Actor Email":"patrick@example.com","Actor Name":"Patrick","Activity Metadata":[[{"action": "review", "comments": ", "action_type": "default"}]],"Previous Status":"created","Status":"started","Timestamp":"2024-02-28T12:44:37+00:00"}, {"Actor Email":"patrick@example.com","Actor Name":"Patrick","Activity Metadata":[[{"action": "playbook", "comments": "Global Request Playbook", "action_type": "default"}]],"Previous Status":"created","Status":"started","Timestamp":"2024-04-08T17:43:57+00:00"}, {"Actor Email":"patrick@example.com","Actor Name":"Patrick","Activity Metadata":[[{"action": "webhook", "comments": "Global Review Webhook", "action_type": "default"}]],"Previous Status":"created","Status":"started","Timestamp":"2024-04-08T17:48:49+00:00"}, {"Actor Email":null,"Actor Name":"System","Activity Metadata":null,"Previous Status":"started","Status":"started","Timestamp":"2024-04-30T12:48:04+00:00"}, {"Actor Email":null,"Actor Name":"System","Activity Metadata":null,"Previous Status":null,"Status":"created","Timestamp":"2024-02-28T12:32:16+00:00"}]
Column Definitions#
Column NameColumn Description
IDRequired - A unique identifier for the finding. This is the internal balkan id of the finding
EmployeeRequired - The employee associated with the finding.
IdentityOptional - The identity associated with the finding.
LabelsOptional - The labels associated with the finding. It is an array of array of label object
IntegrationRequired - The integration associated with the finding.
EntityRequired - The entity associated with the finding.
NameOptiona - The name of the finding.
DescriptionOptional - The description of the finding.
ValueOptional - The value of the finding.
SeverityOptional - The severity of the finding.
RuleRequired - The ID of the entity finding rule associated with the finding.
MetadataOptional - The metadata of the finding.
ReasonOptional - The reason of the finding.
Assigned ToRequired - The user to whom the finding is assigned.
Workflow StatusRequired - The status of the finding.
Created AtRequired - The timestamp when the finding was created.
Updated AtRequired - The timestamp when the finding was updated.

Download the CSV file via the pre-signed URL#

After retrieving the pre-signed URL in the previous step, all that remains is to download the CSV in BalkanID Findings CSV format from the pre-signed URL.
To use the polling URL, first send an HTTP request with the method HEAD to the pollingUrl.
If the response status code is 404, the file is not ready, and you should retry this polling request after a delay.
If the response status code is 200, the file is ready, and you may proceed to download the CSV from the received url.

Request

Header Params
X-Api-Key-ID
string 
optional
X-Api-Key-Secret
string 
optional
Content-Type
string 
optional
Default:
application/json
Body Params application/json
findingRuleID
string 
required
The Finding Rule ID to which the findings are belong to.
Example
{
    "findingRuleID": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://app.balkan.id/api/rest/v0/findings/download-url' \
--header 'X-Api-Key-ID;' \
--header 'X-Api-Key-Secret;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "findingRuleID": "string"
}'

Responses

🟢200OK
application/json
download url response
Body
Download URL endpoint response
pollingUrl
string 
required
The value is the polling URL which you will use to poll to find if the data is ready for download.
url
string 
required
The value is the download URL from which you will download your CSV file.
Example
{
    "pollingUrl": "string",
    "url": "string"
}
🔴500Server Error
Modified at 2025-04-10 03:44:22
Previous
Bulk Filters Upload API (Early Access)
Next
Bulk Findings Upload API (Early Access)
Built with