Bulk Entity Finding Rules Download API (Early Access)

BalkanID Entity Finding Rules

In this section, we will explain the BalkanID Entity Finding Rules format.

Sample Entity Finding Rule

brn	entity_filter	name	description	created_at	updated_at
brn:bid:balkanid:::010000000000000000:app:example	{"key1": "value1", "key2": ["value2", "value3"], "key3": {"nestedKey": "nestedValue"}}	Sample Entity	This is a sample description of the entity	2024-10-23T10:00:00Z	2024-10-23T11:00:00Z

Column Definitions

Column Name	Column Description
ID	Required - A unique identifier for the entity finding rule
entity_filter	Required - JSON filter applied to the entity
name	Required - Name of the entity
description	Optional - Description of the entity
created_at	Required - Timestamp when the entity was created
updated_at	Required - Timestamp when the entity was last 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 Entity Finding Rules 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 samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Bulk Entity Finding Rules Download API (Early Access)

BalkanID Entity Finding Rules#

Sample Entity Finding Rule#

Column Definitions#