Skip to content

Manage counterparty types

Keep your tenant's catalogue of the kinds of organisation you exchange data with, such as card networks, processors or regulators. A counterparty type classifies the external end of a cryptographic exchange.

Who can do it

A tenant administrator, a tenant key manager, or a platform super administrator from inside the tenant, where the console acts as a tenant administrator. Creating, changing and deleting a type are three separate permissions; the console offers New counterparty type only with the permission to create, and enables the edit and delete controls on a row only with the matching permission. All three roles hold them.

The screen is for STANDARD tenants: a SIMPLE tenant does not see it and has no catalogue of its own, and on a RAPIDAPI tenant the console does not offer to create a type.

Before you start

  • The catalogue shows two kinds of type, in its Scope column. Custom types are your own. Platform types are published by the platform administrator to every tenant; they are marked Managed by platform and cannot be changed or deleted here.
  • Choose a code: uppercase letters, digits and underscores, 1 to 64 characters, for example REGULATOR_CO. It cannot be changed after the type is created, and it cannot repeat a code your tenant already holds or a platform type's code.
  • A type that names the external end of any of your exchanges cannot be deleted, because an exchange keeps its endpoints for good, even after it is revoked or discarded.

Steps

  1. Open Counterparty Types from the tenant's navigation.
  2. To create a type:
    1. Select New counterparty type.
    2. Enter the Code and the Display Name, and optionally a Description (optional).
    3. Select Create.
  3. To change a type, select Edit on its row, change the Display Name or the Description (optional), and select Save. The code is shown as Code (read-only).
  4. To delete a type, select Delete on its row, then Delete in the confirmation.

What you see when it worked

The console confirms with Counterparty type created, Counterparty type updated or Counterparty type deleted, and the Counterparty Type Catalog shows the change. A new type appears with the scope Custom, and it can be chosen as the type of an external counterparty in the Endpoints step of the exchange editor.

If it fails

What you see Cause What to do
Use UPPERCASE letters, digits, and underscores (1–64 chars). The code does not match the required form Correct the code
Create stays unavailable The code is invalid, the display name is empty, or a field is over its size limit Correct the field
The create is refused because the code is taken Your tenant already holds the code, or a platform type uses it Choose another code
The delete is refused: Counterparty type '<code>' is an endpoint type of <n> Cryptographic Exchanges. … Exchanges of your tenant name the type on an external endpoint Keep the type; it cannot be deleted while any exchange names it
Edit and delete are unavailable on a row, with Managed by platform It is a platform type Ask the platform administrator

Without the console

Surface How
Key management CLI No command creates, changes or deletes a counterparty type. ankasecure-km directory list-counterparty-types and directory get-counterparty-type --id <uuid> read them
Admin SDK No method creates, changes or deletes a counterparty type. DirectoryOperations.listCounterpartyTypes() and DirectoryOperations.getCounterpartyType(UUID) read them
API POST /api/v3/admin/tenants/{tenantId}/counterparty-types (operation createCounterpartyType); PUT /api/v3/admin/tenants/{tenantId}/counterparty-types/{id} (operation replaceCounterpartyType); DELETE /api/v3/admin/tenants/{tenantId}/counterparty-types/{id} (operation deleteCounterpartyType)