Company

Delete a company variable

Removes one variable by name. A name that is not set is a 404 rather than a silent success, so a misspelled name cannot be mistaken for a credential successfully revoked.

Required entitlement: regulated.parties.canModifyCompany
Entitles the regulated user to modify company information for their customer accounts

delete/api-regulated/v1/introducing-brokers/{introducingBrokerId}/companies/{companyId}/variables/{name}

Request

  • Base URL: https://api.currencyguard.com
  • URL: https://api.currencyguard.com/api-regulated/v1/introducing-brokers/{introducingBrokerId}/companies/{companyId}/variables/{name}
  • Auth: OAuth 2 (implicit, authorization URL https://auth.currencyguard.com/oauth2/authorize, scopes: regulated.parties.canModifyCompany)

Path parameters

introducingBrokerIdstring uuid required

Introducing Broker ID

companyIdstring uuid required

Company ID

namestring required

Variable name

Response

Variable removed; returns the remaining 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.