Bulk Business Owners Download API (Early Access)

BalkanID Business Owners Download CSV Format

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

Sample CSV

Entity ID*	Entity Name	Entity Type*	Source Type	Integration ID*	Integration Name	Integration Description	Primary Owner Email*	Secondary Owners Emails*
0E4q6UXcQRZBrIF66lQRC9cCN7NRvRROXAWqwDUx6Zg	Accounts	connection	group	google/01JH0F7KETDT9ER6JKBK3JB1K9	Google	Test	owner@example.com	secondary1@example.com;secondary2@example.com

Columns marked with * are required always.

Column Definitions

Column Name	Column Description
Entity ID	Required. Unique identifier of the entity whos owner is to be mapped.
Entity Name	Descriptive name associated with the entity.
Entity Type	Required. Type of the entity ('connection' or 'resource').
Source Type	Origin type of the entity (e.g., Internal, External).
Integration ID	Required. Identifier for the integration process.
Integration Name	Name of the integration.
Integration Description	Description of the integration.
Primary Owner Email	Required. Primary email address of the owner.
Secondary Owners Emails	Required. Secondary owner emails separated by a semi-colon (;).

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 Business Owners 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

integrationID

string

optional

The integration ID to which the entities belong to.

Example

{
    "integrationID": "string"
}

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

BalkanID Business Owners Download CSV Format#

Sample CSV#

Column Definitions#

Download the CSV file via the pre-signed URL#

Request

Request samples

Responses

BalkanID Business Owners Download CSV Format

Sample CSV

Column Definitions

Download the CSV file via the pre-signed URL