RegulatedEntity

Set or replace one of my regulated entity's variables

Upserts one variable by name. Replace rather than create-or-update because a caller setting a name that already exists is always the operation wanted; there is no separate create.

put/api-regulated/v1/regulated-entities/self/variables

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/regulated-entities/self/variables
  • Auth: HTTP bearer

Request body

namestring required

The variable name. Uppercase letters, digits and underscores only. Names ending in _PASSWORD, _SECRET, _TOKEN or _KEY are treated as secret and obscured on screen until revealed.

valuestring

The value to store.

Example request

{
  "name": "TRANSFERMATE_PASSWORD",
  "value": "s3cret-from-transfermate"
}

Response

Variable stored; returns the full variable list

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.