Bulk Relations Upload API

Deprecated

POST

https://balkanid.app/api/rest/v0/relations/upload-url

Deprecated: use POST /employee-relations/upload-url instead. This endpoint keeps working and behaves identically, and the legacy relations.csv column names (Identity ID, Identity Username, Identity email, App ID, Relation type, User email) are still accepted as aliases; see the BalkanID Employee Relations CSV format.

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 Canonical 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 Employee Relations CSV format.

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

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://balkanid.app/api/rest/v0/relations/upload-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'

Responses

🟢200OK

application/json

upload url response

Bodyapplication/json

Example

{
    "url": "string"
}

⚪defaultServer Error

Modified at 2026-11-06 14:33:17

Bulk Purposes Download API

Bulk Requests Download API

Bulk Relations Upload API

Upload the CSV file via the pre-signed URL#

Request

Request Code Samples

Responses

Upload the CSV file via the pre-signed URL