Sign in
Counterparties

Create counterparty

Changed on

Creates a new counterparty linking an AccountHolder to a LegalEntity.

The account_holder_id must reference an existing AccountHolder in the same tenant. The legal_entity_id must reference an existing LegalEntity in the same tenant. Each (account_holder_id, legal_entity_id) pair must be unique.

post/api/counterparties

Request

  • Base URL: http://localhost:4100
  • URL: http://localhost:4100/api/counterparties
  • Auth: none required

Request body

account_holder_idstring uuid required
chain_screeningboolean

When true (default), enqueues a compliance screening job after creation. Set to false to skip.

enabled_regimesstring[] nullable
external_idstring nullable
status'active' | 'suspended' | 'blocked' required
tenant_idstring uuid

Example request

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "chain_screening": false,
  "enabled_regimes": [
    ""
  ],
  "external_id": "",
  "legal_entity": null,
  "status": "active",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6"
}

Changes

  • e99ccd17df53Revision changes
    • warning

      removed the request property

    • info

      added the new optional request property

    • info

      added the new optional request property

  • 5105f6199e7dRevision changes
    • warning

      removed the request property

    • info

      added the new optional request property