Update proxy key

post

https://sandbox.numeral.io/v1/proxy_services/dict/proxy_keys/{id}

Partially update an active DICT proxy key. Only fields present in the request body are updated; omitted fields are left unchanged.

owner_name and account_identification changes are forwarded to the DICT provider before the record is persisted — a provider failure leaves the key unchanged.

Returns 400 if the key is not currently active. An empty request body is valid — the current key is returned with 200.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

uuid

required

ID of the proxy key to update.

Body Params

Fields to update on an active DICT proxy key. All fields are optional; omitted fields are left unchanged. An empty body is a valid no-op — the current key is returned.

owner_name

string

length ≤ 140

Full name of the proxy key owner. Maximum 140 characters.

account_identification

string

Account number associated with this proxy key.

account_type

string | null

enum

ISO 20022 account type code. Pass null to clear the existing value.

Allowed:

account_issuer

string | null

Identifier of the institution that issued the account. Pass null to clear the existing value.

servicer

string

Identifier of the financial institution servicing the account.

metadata

object

Shallow key/value patch applied to the existing metadata: keys present in the patch overwrite existing values; setting a key to null removes it from the stored metadata; keys absent from the patch are preserved.

Responses

404

The specified resource was not found.

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Proxy key successfully updated.

400Validation error.