FIfireblocks
Compliance

Create a counterparty group

Creates a new counterparty group.

Endpoint Permissions: Admin, Non-Signing Admin.

post/counterparty_groups

Request

Headers

Idempotency-Keystring

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.

Request body

namestring required

Human-readable name of the group

jurisdictionCodesstring[] required

List of jurisdiction codes to associate with the group

descriptionstring

Optional description of the group

Example request

{
  "name": "APAC Financial Partners",
  "jurisdictionCodes": [
    "US",
    "SG"
  ],
  "description": "Group for all APAC-based financial institution counterparties"
}

Response

Counterparty group created successfully

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.