Skip to content

FA-9767: support optional uid field to fetch an account Id value #258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
PolinaLif merged 1 commit into from
Aug 30, 2026
Merged

FA-9767: support optional uid field to fetch an account Id value #258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions DESCRIPTION.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,6 +190,10 @@ _Note_ that not all error codes need to be in use!
# Changelog
All notable changes to this project will be documented in this file. Dates are displayed in UTC.

### v0.9.13
> 17 August 2026
* Added optional `uid` on the `/v1/accounts` response. This is the provider's native account identifier; Fireblocks persists it from the fundable account.

### v0.9.12
> 19 April 2026
* Supporting Fraxtal on Mainnet.
Expand Down
22 changes: 21 additions & 1 deletion openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
openapi: 3.0.0
info:
title: Fireblocks Network Link for Account Linking Partners
version: "0.9.12"
version: "0.9.13"
contact:
email: support@fireblocks.com
license:
Expand All @@ -22,6 +22,9 @@ paths:
In case the 3rd party supports an account type but the account doesn't
contain any balance, it is expected the "balances"
field to be an empty array.

Each account may optionally include `uid`, the provider's native account
identifier. Fireblocks persists this value from the fundable account.
operationId: GET /accounts
parameters:
- name: X-FBAPI-KEY
Expand Down Expand Up @@ -53,6 +56,16 @@ paths:
type: array
items:
$ref: '#/components/schemas/Balance'
example:
- displayName: "Margin (Cross)"
type: MARGIN
uid: "3c4e2590-d333-4bdd-acd1-3edcdee85777"
balances:
- coinSymbol: USDT
totalAmount: "195.172612"
pendingAmount: "188.2315812"
availableAmount: "10.333"
creditAmount: "3.1"
'400':
description: Return custom error and error code here.
'401':
Expand Down Expand Up @@ -1375,6 +1388,13 @@ components:
nullable: true
type:
$ref : '#/components/schemas/Account_Type'
uid:
type: string
example: "3c4e2590-d333-4bdd-acd1-3edcdee85777"
description: >
Optional provider-side account identifier.
When present on the fundable account, Fireblocks persists it as the provider account id.
Omit this field, or set it to the account id value.
balances:
type: array
items:
Expand Down
Loading