IntroducingBroker

Get introducing broker variables

Returns this broker's named variables. Any variable whose name ends in _PASSWORD, _SECRET, _TOKEN or _KEY is flagged secret=true. Its value IS returned here — this endpoint is the one place a credential is served, and clients obscure it until the user reveals it. No other endpoint returns it: the general DTOs have the variables object removed.

get/api-regulated/v1/introducing-brokers/{id}/variables

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/introducing-brokers/{id}/variables
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Introducing Broker ID

Response

Variables retrieved successfully

namestring

The variable name.

valuestring

The value. Returned for secret variables too — this endpoint is the one place a credential is served, and clients are expected to obscure it until the user reveals it.

secretboolean

Whether this variable is a credential and must be obscured on screen until revealed. True for any name ending in _PASSWORD, _SECRET, _TOKEN or _KEY.

Example response

[
  {
    "name": "TRANSFERMATE_USERNAME",
    "value": "FASTER_PAYMENTS"
  }
]

Changes

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