Skip to main content
PATCH
/
counterparty_groups
/
{groupId}
TypeScript
const response: Promise<FireblocksResponse<CounterpartyGroup>> = fireblocks.compliance.updateCounterpartyGroup(complianceApiUpdateCounterpartyGroupRequest);
{
  "groupId": "44fcead0-7053-4831-a53a-df7fb90d440f",
  "name": "APAC Financial Partners",
  "isActive": true,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "description": "Group for all APAC-based financial institution counterparties",
  "jurisdictionCodes": [
    "US",
    "SG"
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developers.fireblocks.com/llms.txt

Use this file to discover all available pages before exploring further.

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.

Path Parameters

​
groupId
string<uuid>
required

The unique identifier of the counterparty group

Body

application/json

Request body for updating an existing counterparty group

​
name
string

Updated human-readable name of the group

Minimum string length: 1
Example:

"APAC Financial Partners"

​
description
string

Updated description of the group

Example:

"Group for all APAC-based financial institution counterparties"

​
jurisdictionCodes
string[]

Updated list of jurisdiction codes for the group

Example:
["US", "SG"]
​
isActive
boolean

Whether the counterparty group should be active

Example:

true

Response

Counterparty group updated successfully

A counterparty group used to classify counterparties for compliance and routing purposes

​
groupId
string<uuid>
required

Unique identifier of the counterparty group

Example:

"44fcead0-7053-4831-a53a-df7fb90d440f"

​
name
string
required

Human-readable name of the group

Minimum string length: 1
Example:

"APAC Financial Partners"

​
isActive
boolean
required

Whether the counterparty group is currently active

Example:

true

​
createdAt
string<date-time>
required

ISO 8601 timestamp when the group was created

Example:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>
required

ISO 8601 timestamp when the group was last updated

Example:

"2024-01-15T10:30:00Z"

​
description
string

Optional description of the group

Example:

"Group for all APAC-based financial institution counterparties"

​
jurisdictionCodes
string[]

List of jurisdiction codes associated with the group

Example:
["US", "SG"]