Create or amend the network profile

The handle is set once. Sending a different handle later is refused with 409 HANDLE_IMMUTABLE — changing one is a support action, because a handle that could be re-issued is one a payer's saved payee could silently start pointing at somebody else. With x-on-behalf-of the profile is that sub-client's, and its handle is namespaced under yours: acme/zayn-retail.

Authorization

bearer

AuthorizationBearer <token>

In: header

Header Parameters

x-on-behalf-of?string

Act on behalf of one of your sub-clients. The value is that sub-client id, and the request then reads and writes that sub-client's own accounts and registry rows rather than yours. Omit it to act as yourself. A route that does not accept the header refuses it with 400 ON_BEHALF_OF_NOT_ALLOWED_HERE rather than ignoring it — that includes every vault route (deposits, withdrawals, conversions, sub-accounts, positions), the webhook registry, and POST /sub-clients, since a sub-client never has sub-clients of its own. An id that is not one of your sub-clients answers 404 ON_BEHALF_OF_NOT_FOUND; a closed one answers 409 ON_BEHALF_OF_SUB_CLIENT_CLOSED; and a key restricted to a subset of your sub-clients answers 403 ON_BEHALF_OF_NOT_ALLOWED_FOR_KEY for any node outside it.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

How this member is addressed on the network: the handle it is paid by, whether it is listed in search, whether it accepts settlements from anyone, the trading names it is also known by, and whether what it receives is converted into one currency on arrival.

aliases?array<string>

Trading names this member is also known by, at most 5 of at most 64 characters. A payer naming one of these resolves CLOSE_MATCH rather than NO_MATCH — a legal-versus-trading name mismatch is the commonest false alarm in confirmation of payee.

discoverable?boolean

Whether this member appears in GET /network/search. Off by default — being payable by exact handle or IBAN is not the same as being listed.

handle?string

The handle this member is paid by, chosen ONCE. Lowercase letters, digits and single internal hyphens, 3-32 characters per part. Under x-on-behalf-of it is namespaced under your own handle: acme/zayn-retail. Uniqueness is decided on a form that folds characters a human reads alike, so a handle that merely looks like one already taken is refused too.

inboundConversionCurrency?|

Convert what you receive. When set, a settlement paid to this member in any other currency is converted into this one as soon as it lands, on its own accounts, priced as its conversions normally are. The settlement is unchanged and final in the currency the sender chose; the receiver then reads what landed in receipt. Refused with 422 INBOUND_CONVERSION_CURRENCY_UNAVAILABLE unless the member holds an active fiat account in this currency. null clears the rule.

receivePolicy?string

ANYONE accepts settlements from any member. CONNECTED_ONLY is recorded but refuses every incoming settlement with 422 RECEIVE_POLICY_REFUSED unless the sending node is on your connections list (GET /network/connections). An empty list refuses everyone.

Value in

"ANYONE"
"CONNECTED_ONLY"

Response Body

`application/json`

curl -X PUT "https://example.com/api/partner/v1/network/profile" \  -H "Content-Type: application/json" \  -d '{    "aliases": [      "Acme Trading"    ],    "discoverable": false,    "handle": "acme-treasury",    "inboundConversionCurrency": "EUR",    "receivePolicy": "ANYONE"  }'

{  "data": {    "aliases": [      "Acme Trading"    ],    "clientAccountId": "9f1c2a54-7b3d-4e08-9a61-2c5f0b7d4e13",    "createdAt": "2026-09-08T10:15:30.000Z",    "disclosure": {      "items": [        "ENVIRONMENT_IS_TESTNET: The environment is a testnet (Arbitrum Sepolia). No mainnet deployment exists.",        "YIELD_IS_SIMULATED: The vault rate is set administratively and the interest it produces is minted as fresh underlying, not earned. It does not represent a return generated by deployed capital.",        "FIAT_RAILS_ARE_MOCKED: No real fiat movement occurs. Balances are ledger entries against a sandbox provider.",        "CONVERSION_RATES_ARE_MARKET_QUOTED_OR_REFUSED: A conversion is priced only by an external venue that quotes independently of TCB. When no such venue can price the pair, the conversion is refused rather than priced from an internal table. Read rate.pricingModel on every conversion: MARKET is a venue quote; any other value is not a market rate and must not be presented as one.",        "CONTRACTS_ARE_UNAUDITED: No audit has been performed. Mainnet is gated on a two-firm audit that has not been commissioned.",        "CUSTODY_IS_TCB_SUBACCOUNT: Everything held for the client — its vault shares, and the tcbUSD it holds between the steps of the tokenised deposit chain — is held in TCB custody, in the one TCB wallet assigned to the client. The client holds no keys and moves those tokens only through this API; each sub-account's shares and tcbUSD are book entries against what that wallet holds.",        "INTEGRATION_AGREEMENT_ONLY: Fees as published on the rate card; no yield share, no return commitment."      ],      "summary": "This is a pilot integration on a testnet. Nothing in this system earns anything: the yield is simulated and the fiat rails are mocked.",      "version": "2026-10-27"    },    "discoverable": false,    "handle": "acme-treasury",    "inboundConversionCurrency": null,    "receivePolicy": "ANYONE",    "retiredAt": null,    "updatedAt": "2026-09-08T10:15:30.000Z"  },  "success": true,  "timestamp": "2026-09-02T10:15:30.000Z"}

Create or amend the network profile

Authorization

Header Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

409application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`