Add a connected account

post

https://api.fireblocks.io/v1/connected_accounts

Creates a new connected account for the authenticated tenant.

The creds field must be a Base64-encoded RSA-encrypted credential blob.
Use GET /exchange_accounts/credentials_public_key to retrieve the public key for encryption.

The providerType is derived server-side from the providerId — callers do not supply it.

Endpoint Permission: Editor, Admin, Non-Signing Admin.

Note: This endpoint is currently in beta and might be subject to changes.

Body Params

providerId

string

required

Integration key identifying the provider (e.g. BINANCE, KINGDOM_BANK, GEMINI_NLV2).

displayName

string

Human-readable account name. Required for non-NLV2 providers.

creds

string

required

Base64-encoded RSA-encrypted credential blob. Encrypt using the public key from GET /exchange_accounts/credentials_public_key.

apiKey

string

required

Account-level API key.

mainAccountId

string

Parent main account ID for sub-account creation. Not allowed for NLV2 providers.

accountId

string

Optional provider-side account ID to associate with the created account.

onPremiseServerId

string

On-premise server ID for self-hosted integrations.

Headers

Idempotency-Key

string

A unique identifier for the request. If the request is sent multiple times with the same idempotency key, the server will return the same response as the first request. The idempotency key is valid for 24 hours.

Responses

Language

URL

Loading…

Response

Choose an example:

application/json

201Account created (or pending approval).

400Bad request — invalid field or provider constraints violated.

401Unauthorized. Missing / invalid JWT token, or insufficient role (Editor or higher required).

403Feature not enabled for this tenant.

404mainAccountId not found.

422Invalid credentials.

defaultError Response