Compliance

Get a counterparty group

Returns the details of a specific counterparty group.

Endpoint Permissions: Admin, Non-Signing Admin, Viewer.

get/counterparty_groups/{groupId}

Request

Base URL
https://api.fireblocks.io/v1
Auth
none declared
TypeScript
https://skmtc.dev/fireblocks/apis/fireblocks-api/docs/counterparty_groups/:groupId/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

groupIdstring uuid required

The unique identifier of the counterparty group

Response

A counterparty group object

groupIdstring uuid required

Unique identifier of the counterparty group

namestring required

Human-readable name of the group

descriptionstring

Optional description of the group

jurisdictionCodesstring[]

List of jurisdiction codes associated with the group

isActiveboolean required

Whether the counterparty group is currently active

createdAtstring date-time required

ISO 8601 timestamp when the group was created

updatedAtstring date-time required

ISO 8601 timestamp when the group was last updated

Example response

{
  "groupId": "44fcead0-7053-4831-a53a-df7fb90d440f",
  "name": "APAC Financial Partners",
  "description": "Group for all APAC-based financial institution counterparties",
  "jurisdictionCodes": [
    "US",
    "SG"
  ],
  "isActive": true,
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z"
}

Changes

No recorded changes to this operation across all 1 revision of this API.