> ## Documentation Index
> Fetch the complete documentation index at: https://docs.nekt.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Stark Bank as a data source

> Bring data from Stark Bank to Nekt.

Stark Bank is a digital banking platform that provides financial services including payments, transfers, and banking operations through a modern API-first approach.

<img height="30" src="https://mintcdn.com/nekt/G3tJceWGUU6v2j1U/assets/logo/logo-starkbank.png?fit=max&auto=format&n=G3tJceWGUU6v2j1U&q=85&s=8be744b909a38bfde524a572916a7e8b" data-path="assets/logo/logo-starkbank.png" />

## Configuring Stark Bank as a Source

In the [Sources](https://app.nekt.ai/sources) tab, click on the "Add source" button located on the top right of your screen. Then, select the Stark Bank option from the list of connectors.

Click **Next** and you'll be prompted to add your access.

### 1. Add account access

Our connector uses Project-based authentication, please [follow this tutorial](https://starkbank.com/docs/api#authentication) to understand how to create a project and the associated public and private keys.

You'll need to provide the following credentials to connect to Stark Bank:

* **Private Key**: Private Key to authenticate against the Stark Bank API
* **Project ID**: Project ID to identify your Stark Bank project

Once you're done, click **Next**.

### 2. Select streams

Choose which data streams you want to sync - you can select all streams or pick specific ones that matter most to you.

> Tip: The stream can be found more easily by typing its name.

Select the streams and click **Next**.

### 3. Configure data streams

Customize how you want your data to appear in your catalog. Select a name for each table (which will contain the fetched data) and the type of sync.

* **Table name**: we suggest a name, but feel free to customize it. You have the option to add a **prefix** and make this process faster!

* **Sync Type**: you can choose between INCREMENTAL and FULL\_TABLE.
  * Incremental: every time the extraction happens, we'll get only the new data - which is good if, for example, you want to keep every record ever fetched.
  * Full table: every time the extraction happens, we'll get the current state of the data - which is good if, for example, you don't want to have deleted data in your catalog.

Once you are done configuring, click **Next**.

### 4. Configure data source

Describe your data source for easy identification within your organization, not exceeding 140 characters.

To define your [Trigger](https://docs.nekt.com/runs/scheduling-and-triggers), consider how often you want data to be extracted from this source. This decision usually depends on how frequently you need the new table data updated (every day, once a week, or only at specific times).

Optionally, you can determine when to execute a [full sync](https://docs.nekt.com/get-started/core-concepts/types-of-sync#additional-full-sync). This will complement the incremental data extractions, ensuring that your data is completely synchronized with your source every once in a while.

Once you are ready, click **Next** to finalize the setup.

### 5. Check your new source

You can view your new source on the [Sources](https://app.nekt.ai/sources) page. If needed, manually trigger the source extraction by clicking on the arrow button. Once executed, your data will appear in your Catalog.

<Warning>For you to be able to see it on your [Catalog](https://app.nekt.ai/catalog), you need at least one successful source run.</Warning>

# Streams and Fields

Below you'll find all available data streams from Stark Bank and their corresponding fields:

<AccordionGroup>
  <Accordion title="Balances">
    Stream for tracking account balances.

    Primary key: `id`

    * `amount` - The balance amount in cents
    * `currency` - The currency code of the balance
    * `id` - The balance ID
    * `updated` - Last update timestamp of the balance
  </Accordion>

  <Accordion title="Deposits">
    Stream for managing bank deposits.

    Primary key: `id`

    * `accountNumber` - Bank account number
    * `accountType` - Bank account type
    * `amount` - Deposit amount in cents
    * `bankCode` - Bank code
    * `branchCode` - Bank branch code
    * `created` - Creation timestamp
    * `fee` - Fee charged
    * `id` - The deposit ID
    * `name` - Bank account holder name
    * `status` - Status of the deposit
    * `tags` - List of tags
    * `taxId` - Bank account holder tax ID
    * `transactionIds` - List of related transaction IDs
    * `type` - Deposit type
    * `updated` - Last update timestamp
  </Accordion>

  <Accordion title="Invoices">
    Stream for managing payment invoices.

    Primary key: `id`

    * `amount` - Invoice amount in cents
    * `brcode` - BR code for payment
    * `created` - Creation timestamp
    * `descriptions` - List of key-value descriptions containing:
      * `key` - Description key
      * `value` - Description value
    * `discountAmount` - Discount amount in cents
    * `discounts` - List of available discounts containing:
      * `percentage` - Discount percentage
      * `due` - Discount due date
    * `due` - Due date of the invoice
    * `expiration` - Invoice expiration timestamp
    * `fee` - Fee charged
    * `fine` - Fine percentage
    * `fineAmount` - Fine amount in cents
    * `id` - The transaction ID
    * `interest` - Interest percentage
    * `interestAmount` - Interest amount in cents
    * `link` - URL of the invoice payment link
    * `name` - Customer name
    * `nominalAmount` - Nominal amount in cents
    * `pdf` - URL of the invoice PDF
    * `status` - Status of the invoice
    * `tags` - List of tags
    * `taxId` - Customer tax ID
    * `transactionIds` - List of related transaction IDs
    * `updated` - Last update timestamp
  </Accordion>

  <Accordion title="QR Codes">
    Stream for managing dynamic BR codes.

    Primary key: `uuid`

    * `amount` - Amount in cents
    * `created` - Creation timestamp
    * `displayDescription` - Description shown to payer
    * `expiration` - QR code expiration timestamp
    * `pictureUrl` - URL of the QR code image
    * `rules` - List of rules for the QR code containing:
      * `key` - Rule key
      * `value` - Rule values
    * `tags` - List of tags
    * `updated` - Last update timestamp
    * `uuid` - Unique identifier
  </Accordion>

  <Accordion title="Transactions">
    Stream for tracking financial transactions.

    Primary key: `id`

    * `amount` - Transaction amount in cents
    * `balance` - Remaining balance after transaction
    * `created` - Creation timestamp of the transaction
    * `description` - The transaction description
    * `externalId` - External unique identifier
    * `fee` - Transaction fee amount
    * `id` - The transaction ID
    * `receiverId` - ID of the receiver
    * `senderId` - ID of the sender
    * `source` - Source of the transaction
    * `tags` - List of tags associated with the transaction
  </Accordion>

  <Accordion title="Workspaces">
    Stream for managing workspace settings and information.

    Primary key: `id`

    * `allowedTaxIds` - List of allowed tax IDs
    * `created` - Creation timestamp of the workspace
    * `host` - The workspace hostname
    * `id` - The user's system ID
    * `name` - The workspace display name
    * `organizationId` - ID of the organization
    * `pictureUrl` - URL of the workspace profile picture
    * `status` - Status of the workspace
    * `theme` - Theme configuration containing:
      * `actionColor` - The secondary color of the workspace
      * `borderColor` - The primary color of the workspace
      * `inputColor` - The text color of the workspace
      * `lineColor` - The accent color of the workspace
      * `menuBgColor` - The background color of the workspace
      * `textColor` - The border color of the workspace
      * `titleColor` - The link color of the workspace
      * `viewBgColor` - The link color of the workspace
    * `username` - The workspace username
  </Accordion>
</AccordionGroup>

## Skills for agents

<Snippet file="agent-skills-intro.mdx" />

<Card title="Download Stark Bank skills file" icon="wand-magic-sparkles" href="/sources/stark-bank.md">
  Stark Bank connector documentation as plain markdown, for use in AI agent contexts.
</Card>
