Bulk Admins Download API

POST

https://balkanid.app/api/rest/v0/admins/download-url

BalkanID Admins Download CSV Format

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

Sample CSV

Email	Is User
mark@example.com	true
james@example.com	false

Column Definitions

Column Name	Column Definition
Email	Email of the user
Is User	Whether the admin is an user or not in the tenant

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 Admins 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

Authorization

API Key

Add parameter in header

X-API-KEY-ID

Example:

X-API-KEY-ID: ********************

API Key

Add parameter in header

X-API-KEY-SECRET

Example:

X-API-KEY-SECRET: ********************

Header Params

Body Params application/jsonRequired

Example

{
    "onlyNonEmployeeAdmins": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://balkanid.app/api/rest/v0/admins/download-url' \
--header 'X-Api-Key-ID;' \
--header 'X-Api-Key-Secret;' \
--header 'X-API-KEY-ID: <api-key>' \
--header 'X-API-KEY-SECRET: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "onlyNonEmployeeAdmins": true
}'

Responses

🟢200OK

application/json

download url response

Bodyapplication/json

Example

{
    "url": "string",
    "pollingUrl": "string"
}

⚪defaultServer Error

Modified at 2026-11-06 14:24:45

Introduction

Bulk Business Owners Download API

Bulk Admins Download API

BalkanID Admins Download CSV Format#

Sample CSV#

Column Definitions#