Bulk Labels Download API (Early Access)

BalkanID Labels Download CSV Format

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

Sample CSV

ID	Name*	Color	Icon	Background Color	Text Color	Type*	Light Background Color	Light Text Color	Dark Background Color	Dark Text Color
entitlement/privileged	Privileged	secondary	https://example.com/icons/privileged.svg	#FFFFFF	#000000	entitlement	#FFFFFF	#000000	#FFFFFF	#000000
employee/sod	SoD			#FFFFFF	#000000	employee	#FFFFFF	#000000	#FFFFFF	#000000

NOTE: Columns with * are required always.

Column Definitions

Column Name	Column Description
ID	Required - ID of the label.
Name	Required - The name of the label. It appears in the applications.
Type	Required - The type of the label, used to identify the type of
Icon	Optional - The icon of the label. It appears in the applications.
Color	Optional - The color of the label. It appears in the applications.
Background Color	Optional - The background color of the label. It appears in the applications.
Text Color	Optional - The text color of the label. It appears in the applications.
Light Background Color	Optional - The light background color of the label. It appears in the applications.
Light Text Color	Optional - The light text color of the label. It appears in the applications.
Dark Background Color	Optional - The dark background color of the label. It appears in the applications.
Dark Text Color	Optional - The dark text color of the label. It appears in the applications.

Required Columns

Name and Type is always required.

All other columns are optional.

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 Labels 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 Labels Download API (Early Access)

BalkanID Labels Download CSV Format#

Sample CSV#

Column Definitions#

Required Columns#

Download the CSV file via the pre-signed URL#