Identify the authenticated client principal
Identifies the authenticated principal — the integration smoke test. Your API key is the only credential: no browser session and no other headers are involved. Called with x-on-behalf-of it answers principalType SUB_CLIENT with that sub-client id, alongside your unchanged root clientAccountId. subtreeRestricted reports whether the key may act for every one of your sub-clients or only a subset.
Identifies the authenticated principal — the integration smoke test. Your API key is the only credential: no browser session and no other headers are involved. Called with x-on-behalf-of it answers principalType SUB_CLIENT with that sub-client id, alongside your unchanged root clientAccountId. subtreeRestricted reports whether the key may act for every one of your sub-clients or only a subset.
Authorization
bearer In: header
Header Parameters
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.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/api/partner/v1/me"{ "data": { "clientAccountId": "3a7e5c91-0d24-4b6f-8e13-5c9a2f7b1d04", "environment": "test", "keyPrefix": "test_A7fQ2xM", "name": "Acme Payments", "partnerId": "9f1c2a54-7b3d-4e08-9a61-2c5f0b7d4e13", "principalType": "PARTNER", "scopes": [ "position:read", "transaction:read", "vault:deposit", "vault:withdraw" ], "subClientId": "c4f81e2a-9b60-4d37-a512-8e0f3c6b7d95", "subtreeRestricted": false }, "success": true, "timestamp": "2026-09-02T10:15:30.000Z"}