Counterparties

Get counterparty by ID

Changed on

Returns a single counterparty.

get/api/counterparties/{id}

Request

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

Path parameters

idstring uuid required

Counterparty ID

Response

Counterparty

account_holder_idstring uuid required
counterparty_numberstring
enabled_regimesstring[] nullable
external_idstring nullable
idstring uuid
inserted_atstring date-time
status'active' | 'suspended' | 'blocked' required
tenant_idstring uuid
updated_atstring date-time

Example response

{
  "account_holder_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "beneficial_owners": [
    null
  ],
  "counterparty_number": "",
  "enabled_regimes": [
    ""
  ],
  "external_id": "",
  "id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "inserted_at": "2020-04-20T16:20:00Z",
  "legal_entity": null,
  "status": "active",
  "tenant_id": "02ef9c5f-29e6-48fc-9ec3-7ed57ed351f6",
  "updated_at": "2020-04-20T16:20:00Z"
}

Changes

  • e99ccd17df53Revision changes
    • breaking

      removed the required property from the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 5105f6199e7dRevision changes
    • warning

      removed the optional property from the response with the status

    • info

      added the optional property to the response with the status